Template:PlayerData/doc: Difference between revisions

From Paw Borough Wiki
(Changes to link parameters)
No edit summary
Line 1: Line 1:
==Usage==
==Usage==
A notice template that is intended to be used before the presentation of data that was collected by the players of Pawborough.  
A notice template that warns users the data following the template is unofficial and collected by the players of PawBorough. This template should be placed before the presented data.


On person of contact is required. Up to 3 persons to contact may be added. Discord contact is optional, but Pawborough ID and Username are not. A Pawborough forum thread link must be included. 3 additional important links may be added. These should be relevant external links such as any spreadsheets, and input forms.
One person to contact, and one link is required by this template. Up to 3 people may be added to the contact list, and up to 4 links may be included. A Discord contact is optional, but PawBorough ID and Username are not. Links should be relevant to the project such as the projects PawBorough thread, spreadsheet, and google form.


Pages in the Main namespace that call upon this template are added to [[:Category:Includes Player Data]], and if the parameter <code>|outdated=</code> is set as true pages are additionally added to [[:Category:Outdated Player Data]].
Pages in the Main namespace are added to [[:Category:Articles That Include Player Data]], and if the parameter <code>|outdated=</code> is set as true pages are additionally added to [[:Category:Articles Containing Outdated Player Data]].


==Syntax==
==Syntax==
<pre>{{PlayerData
<pre>{{PlayerData
|outdated=
|outdated=
|thread=
|link1=
|link1=
|link2=
|link2=
|link3=
|link3=
|link4=
|id1=
|id1=
|user1=
|user1=
Line 30: Line 30:
{{PlayerData
{{PlayerData
|outdated=y
|outdated=y
|thread=https://pawborough.wiki/wiki/Main_Page
|link1=[https://pawborough.wiki/wiki/Main_Page Main Page]
|link1=[https://pawborough.wiki/wiki/Main_Page Main Page]
|link2=[https://pawborough.wiki/wiki/Main_Page Main Page]
|link2=[https://pawborough.wiki/wiki/Main_Page Main Page]
Line 40: Line 39:
<pre>{{PlayerData
<pre>{{PlayerData
|outdated=y
|outdated=y
|thread=https://pawborough.wiki/wiki/Main_Page
|link1=[https://pawborough.wiki/wiki/Main_Page Main Page]
|link1=[https://pawborough.wiki/wiki/Main_Page Main Page]
|link2=[https://pawborough.wiki/wiki/Main_Page Main Page]
|link2=[https://pawborough.wiki/wiki/Main_Page Main Page]
Line 50: Line 48:


{{PlayerData
{{PlayerData
|thread=https://pawborough.wiki/wiki/Main_Page
|link1=[https://pawborough.wiki/wiki/Main_Page Main Page]
|id1=1
|id1=1
|user1=Username
|user1=Username
Line 61: Line 59:
}}
}}
<pre>{{PlayerData
<pre>{{PlayerData
|thread=https://pawborough.wiki/wiki/Main_Page
|link1=[https://pawborough.wiki/wiki/Main_Page Main Page]
|id1=1
|id1=1
|user1=Username
|user1=Username
Line 93: Line 91:
"description": "Discord username of the first person to contact, optional."
"description": "Discord username of the first person to contact, optional."
},
},
"user2": {},
"user2": {
"id2": {},
"description": "Pawborough Username of the second person to contact."
"discord2": {},
},
"user3": {},
"id2": {
"id3": {},
"description": "Pawborough ID of the second person to contact."
"discord3": {},
},
"discord2": {
"description": "Discord username of the second person to contact, optional."
},
"user3": {
"description": "Pawborough Username of the third person to contact."
},
"id3": {
"description": "Pawborough ID of the third person to contact."
},
"discord3": {
"description": "Discord username of the third person to contact, optional."
},
"link1": {
"link1": {
"description": "Important link 1.",
"description": "Important link 1, all links should be formatted like external links.",
"example": "[https://pawborough.wiki/wiki/Main_Page Main Page]"
"example": "[https://pawborough.wiki/wiki/Main_Page Main Page]",
"required": true
},
},
"link2": {
"link2": {
"description": "Important link 2."
"description": "Important link 2, all links should be formatted like external links."
},
},
"link3": {
"link3": {
"description": "Important link 3."
"description": "Important link 3, all links should be formatted like external links."
},
},
"thread": {
"link4": {
"description": "Link to the Pawborough thread. Should only be the link alone.",
"description": "Important link 4, all links should be formatted like external links."
"example": "https://pawborough.wiki/wiki/Main_Page",
"required": true
}
}
},
},
"paramOrder": [
"paramOrder": [
"outdated",
"outdated",
"thread",
"link1",
"link1",
"link2",
"link2",
"link3",
"link3",
"link4",
"id1",
"id1",
"user1",
"user1",

Revision as of 18:28, 25 August 2026

Usage

A notice template that warns users the data following the template is unofficial and collected by the players of PawBorough. This template should be placed before the presented data.

One person to contact, and one link is required by this template. Up to 3 people may be added to the contact list, and up to 4 links may be included. A Discord contact is optional, but PawBorough ID and Username are not. Links should be relevant to the project such as the projects PawBorough thread, spreadsheet, and google form.

Pages in the Main namespace are added to Category:Articles That Include Player Data, and if the parameter |outdated= is set as true pages are additionally added to Category:Articles Containing Outdated Player Data.

Syntax

{{PlayerData
|outdated=
|link1=
|link2=
|link3=
|link4=
|id1=
|user1=
|discord1=
|id2=
|user2=
|discord2=
|id3=
|user3=
|discord3=
}}

Examples

This section contains data that was collected by the players of PawBorough, and is unofficial.
Direct any inquiries about the project to the following people:
Important Links: MISSING LINK
Contact an active editor to get this section updated.
{{PlayerData}}
This section contains outdated data that was collected by the players of PawBorough, and is unofficial. The information has been retained for archivial purposes
Direct any inquiries about the project to the following people:
Important Links: Main Page | Main Page | Main Page
Contact an active editor to get this section updated.
{{PlayerData
|outdated=y
|link1=[https://pawborough.wiki/wiki/Main_Page Main Page]
|link2=[https://pawborough.wiki/wiki/Main_Page Main Page]
|link3=[https://pawborough.wiki/wiki/Main_Page Main Page]
|id1=1
|user1=Username
|discord1=John Doe
}}
This section contains data that was collected by the players of PawBorough, and is unofficial.
Direct any inquiries about the project to the following people:
Important Links: Main Page
Contact an active editor to get this section updated.
{{PlayerData
|link1=[https://pawborough.wiki/wiki/Main_Page Main Page]
|id1=1
|user1=Username
|discord1=John Doe
|id2=2
|user2=Username
|id3=3
|user3=Username
|discord3=John Doe
}}

No description.

Template parameters

ParameterDescriptionTypeStatus
outdatedoutdated

If set to "true" or "yes" , it'll mark the page as containing outdated player data. The box will also turn purple to be visually distinct from up-to-date player data.

Suggested values
y yes true
Unknownoptional
link1link1

Important link 1, all links should be formatted like external links.

Example
[https://pawborough.wiki/wiki/Main_Page Main Page]
Unknownrequired
link2link2

Important link 2, all links should be formatted like external links.

Unknownoptional
link3link3

Important link 3, all links should be formatted like external links.

Unknownoptional
link4link4

Important link 4, all links should be formatted like external links.

Unknownoptional
id1id1

Pawborough ID of the first person to contact.

Unknownrequired
user1user1

Pawborough Username of the first person to contact.

Unknownrequired
discord1discord1

Discord username of the first person to contact, optional.

Unknownoptional
id2id2

Pawborough ID of the second person to contact.

Unknownoptional
user2user2

Pawborough Username of the second person to contact.

Unknownoptional
discord2discord2

Discord username of the second person to contact, optional.

Unknownoptional
id3id3

Pawborough ID of the third person to contact.

Unknownoptional
user3user3

Pawborough Username of the third person to contact.

Unknownoptional
discord3discord3

Discord username of the third person to contact, optional.

Unknownoptional