Template:Paid/doc

This is a documentation subpage for Template:Paid.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 11,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template is for contributors who, as required by Wikipedia's WP:PAID policy and the Wikimedia Foundation's terms of use, must disclose their employer, client, and affiliation with respect to any contribution for which they receive, or expect to receive, compensation. According to the terms of use, disclosure must be made in at least one of the following ways: a statement on your user page; a statement on the talk page accompanying any paid contributions; or a statement in the edit summary accompanying any paid contributions.

Usage

This template is meant to be used only on user pages and/or user talk pages. For article talk pages, use {{Connected contributor (paid)}}.

Text usage on user pages

Template	Result
`{{paid\|employer=ACME}}`	This user, in accordance with the Wikimedia Foundation's Terms of Use, discloses that they have been paid by ACME for their contributions to Wikipedia.
`{{paid\|employer=ACME\|article=Example}}`	This user, in accordance with the Wikimedia Foundation's Terms of Use, discloses that they have been paid by ACME for their contributions to Example.
`{{paid\|employer=ACME\|client=W. Coyote\|some=yes}}`	This user, in accordance with the Wikimedia Foundation's Terms of Use, discloses that they have been paid by ACME on behalf of W. Coyote for some of their contributions to Wikipedia.
`{{paid\|user=Example\|employer=Acme\|additional=Optional text}}`	Example, in accordance with the Wikimedia Foundation's Terms of Use, discloses that they have been paid by Acme for their contributions to Wikipedia. Optional text

Userbox usage

Template Result

{{paid|employer=ACME|userbox=yes}}

This user, in accordance with the Terms of Use, discloses that they have been paid by ACME to edit Wikipedia.

{{paid|employer=ACME|userbox=yes|article=[[Example]]}}

This user, in accordance with the Terms of Use, discloses that they have been paid by ACME to edit Example.

{{paid|employer=ACME|userbox=yes|list=yes|articles=
* [[A]]
* [[B]]
* [[C]]
* [[D]]
}}

This user, in accordance with the Terms of Use, discloses that they have been paid by ACME to edit Wikipedia.

List of articles edited by this user for paid compensation

A
B
C
D

Pages where this template is used are added to Category:Paid contributors.

If no employer is included, the page is also added to Category:Paid contributors with no listed employer.

Arguments

Required parameters

Note: if the employer and client are the same entity, then only |employer= is required.

employer: The person or entity paying you. If you are a freelancer working directly for a client, the name of your client. If you are an employed by or under contract with a PR or marketing firm, or work for the company or institution about which you are editing, the name of your employer or contractee.
client: Name of the company or individual on whose behalf the contributions are made. If you are a freelancer working for a client, leave this blank. If you are employed by or under contract with a PR firm or marketing company, the name of the client paying your employer or contractee.

Optional parameters

user: This parameter inserts the user's name into the text. This is primarily for Talk page usage.
userbox: Determines whether the notification is displayed as a userbox. Anything other than yes for this parameter will result in text display.
list: Determines whether to show a collapsible list of articles edited for paid compensation below the talk page notice.
article: If set to anything, outputs the text entered. Defaults to "contributions to this topic" if left blank.
articles: List of articles edited for paid compensation by the user (in bullet form). Only works if both userbox and list are set to yes.
some: Instructs the template to say "some of their contributions to Wikipedia". Does not work when userbox is active.
start: Date on which the editor began making paid contributions to Wikipedia.
end: Date on which the editor stopped making paid contributions to Wikipedia. Defaults to "present" if left blank. Does not work when start is blank.
custom_range: Custom text to denote the period during which the editor made paid contributions to Wikipedia. Overrides start and end.
additional: Any additional information to be added to the template.

User preferences

The template will attempt to determine the user's preferred gender pronouns ("their"/"his"/"her") and use them appropriately. This depends on the gender setting documented at Help:Preferences.

TemplateData

See a monthly parameter usage report for Template:Paid in articles based on its TemplateData.

TemplateData for Paid

No description.

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
userbox	`userbox`	Determines whether the notification is displayed as a userbox. Anything other than yes for this parameter will result in text display. Example yes	String	optional
employer	`employer`	The person or entity paying you. If you are a freelancer working directly for a client, the name of your client. If you are an employed by or under contract with a PR or marketing firm, or work for the company or institution about which you are editing, the name of your employer or contractee. Example ACME Inc.	String	required
client	`client`	Name of the company or individual on whose behalf the contributions are made. If you are a freelancer working for a client, leave this blank. If you are employed by or under contract with a PR firm or marketing company, the name of the client paying your employer or contractee.	String	suggested
user	`user`	This parameter inserts the user's name into the text. This is primarily for Talk page usage.	String	optional
article	`article`	If set to anything, outputs the text entered. Defaults to "contributions to this topic" if left blank.	String	optional
list	`list`	Determines whether to show a collapsible list of articles edited for paid compensation below the talk page notice. Example yes	String	optional
articles	`articles`	List of articles edited for paid compensation by the user (must be in bullet form). userbox and list must both be set to yes for this parameter to work.	Content	suggested
some	`some`	Instructs the template to say "some of their contributions to Wikipedia". This parameter does not work when userbox is active. Example yes	String	optional
additional	`additional`	Any additional information that is added to the template.	Content	optional

Tracking categories

Category:Paid disclosures in the wrong location (0)
Category:Paid contributors with no listed employer (154)
Category:Paid contributors (10,881)