View source for Template:Paid/doc

{{documentation subpage}}
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE--->
{{High-use}}
{{Distinguish|text = {{-r|Template:Pay}}, a shortcut to [[Template:Subscription required]]}}

This template is for contributors who, as required by Wikipedia's [[WP:PAID]] policy and the [[Wikimedia Foundation]]'s [[wmf:Terms of Use#4. Refraining from Certain Activities|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 {{t|Connected contributor (paid)}}'''.

;Text usage on user pages
{| class="wikitable"
!width="39%"|Template !! Result
|-
|{{tlc|paid|2=employer=ACME}} || {{paid|employer=ACME|demo=2}}
|-
|{{tlc|paid|2=employer=ACME|3=article=Example}} || {{paid|employer=ACME|article=Example|demo=2}}
|-
|{{tlc|paid|2=employer=ACME|3=client=W. Coyote|4=some=yes}} || {{paid|employer=ACME|client=W. Coyote|some=yes|demo=2}}
|-
|{{tlc|paid|2=user=Example|3=employer=Acme|4=additional=Optional text}} || {{paid|user=Example|employer=Acme|additional=Optional text|demo=2}}
|-
|}
;Userbox usage
{| class="wikitable"
!width="39%"|Template !! Result
|-
|{{tlc|paid|2=employer=ACME|3=userbox=yes}} || {{paid|employer=ACME|userbox=yes|demo=2}}
|-
|{{tlc|paid|2=employer=ACME|3=userbox=yes|4=article=<nowiki>[[Example]]</nowiki>}} || {{paid|employer=ACME|userbox=yes|article=[[Example]]|demo=2}}
|-
|<pre>{{paid|employer=ACME|userbox=yes|list=yes|articles=
* [[A]]
* [[B]]
* [[C]]
* [[D]]
}}</pre>
| {{paid|employer=ACME|userbox=yes|list=yes|demo=2|articles=
* [[A]]
* [[B]]
* [[C]]
* [[D]]}}
|}
<!-- It was determined that this template shouldn't really be used on user talk pages. This may change (and there are extant uses) so I'm leaving this here for now (Primefac, 24 Aug '17)
;User talk version
{| class="wikitable"
!width="39%"|Template !! Result
|-
|{{tlc|paid|2=talk=yes|3=user=Example|4=employer=ACME|5=client=Example}} || {{paid|talk=yes|user=Example|employer=ACME|client=Example}}
|-
|<pre>{{paid|talk=yes|user=Example|employer=ACME|some=yes|list=yes|articles=
* [[A]]
* [[B]]
* [[C]]
* [[D]]
}}</pre>
| {{paid|talk=yes|user=Example|some=yes|list=yes|employer=ACME|articles=
* [[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 {{para|employer}} is required.
;<code>employer</code>: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. 
;<code>client</code>: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===
;<code>user</code>:This parameter inserts the user's name into the text. This is primarily for Talk page usage.
;<code>userbox</code>:Determines whether the notification is displayed as a userbox. Anything other than <code>yes</code> for this parameter will result in text display.
;<code>list</code>:Determines whether to show a collapsible list of articles edited for paid compensation below the talk page notice. 
;<code>article</code>:If set to anything, outputs the text entered. Defaults to "contributions to this topic" if left blank.
;<code>articles</code>:List of articles edited for paid compensation by the user (in bullet form). Only works if both <code>userbox</code> and <code>list</code> are set to <code>yes</code>.
;<code>some</code>:Instructs the template to say "some of their contributions to Wikipedia". Does not work when <code>userbox</code> is active.
;<code>start</code>:Date on which the editor began making paid contributions to Wikipedia.
;<code>end</code>:Date on which the editor stopped making paid contributions to Wikipedia. Defaults to "present" if left blank. Does not work when <code>start</code> is blank.
;<code>additional</code>:Any additional information that is 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==
{{TemplateData header|noheader=1}}
<templatedata>
{
	"params": {
		"userbox": {
			"description": "    Determines whether the notification is displayed as a userbox. Anything other than yes for this parameter will result in text display.",
			"example": "yes",
			"type": "string"
		},
		"employer": {
			"description": "    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.",
			"type": "string",
			"required": true
		},
		"client": {
			"description": "    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.",
			"type": "string",
			"suggested": true
		},
		"user": {
			"description": "    This parameter inserts the user's name into the text. This is primarily for Talk page usage.",
			"type": "string"
		},
		"article": {
			"description": "    If set to anything, outputs the text entered. Defaults to \"contributions to this topic\" if left blank.",
			"type": "string"
		},
		"list": {
			"description": "    Determines whether to show a collapsible list of articles edited for paid compensation below the talk page notice.",
			"example": "yes",
			"type": "string"
		},
		"articles": {
			"description": "    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.",
			"type": "content",
			"suggested": true
		},
		"some": {
			"description": "Instructs the template to say \"some of their contributions to Wikipedia\". This parameter does not work when userbox is active.",
			"example": "yes",
			"type": "string"
		},
		"additional": {
			"description": "Any additional information that is added to the template.",
			"type": "content"
		}
	},
	"format": "inline"
}
</templatedata>

==Tracking categories==
*{{clc|Category:Paid disclosures in the wrong location}}
*{{clc|Category:Paid contributors with no listed employer}}
*{{clc|Category:Paid contributors}}

<includeonly>{{sandbox other||
[[Category:Wikipedia conflict of interest self-declaration templates]]
[[Category:Wikipedia paid editing]]
[[Category:Templates that add a tracking category]]
}}</includeonly>