Template:PlayerData/doc: Difference between revisions

From Paw Borough Wiki
No edit summary
No edit summary
 
Line 1: Line 1:
==Usage==
==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.
This template is used to notify reads that the following data is unofficial and was collected by the players of Pawborough.


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.
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 <code>|outdated=</code> is set as true pages are additionally added to [[:Category:Articles Containing Outdated Player Data]].
Pages in the Main namespace are added to [[:Category:Articles That Include Player Data]], though if the parameter <code>|outdated=</code> is set as true pages are added to [[:Category:Articles Containing Outdated Player Data]] instead.


==Syntax==
==Syntax==
<pre>{{PlayerData
<pre>{{PlayerData
|content=
|outdated=
|outdated=
|link1=
|link1=
Line 48: Line 49:


{{PlayerData
{{PlayerData
|content=article
|link1=[https://pawborough.wiki/wiki/Main_Page Main Page]
|link1=[https://pawborough.wiki/wiki/Main_Page Main Page]
|id1=1
|id1=1
Line 59: Line 61:
}}
}}
<pre>{{PlayerData
<pre>{{PlayerData
|content=article
|link1=[https://pawborough.wiki/wiki/Main_Page Main Page]
|link1=[https://pawborough.wiki/wiki/Main_Page Main Page]
|id1=1
|id1=1
Line 78: Line 81:
"yes",
"yes",
"true"
"true"
]
],
"type": "string"
},
},
"id1": {
"id1": {
"description": "Pawborough ID of the first person to contact.",
"description": "Pawborough ID of the first person to contact.",
"required": true
"required": true,
"type": "number"
},
},
"user1": {
"user1": {
"description": "Pawborough Username of the first person to contact.",
"description": "Pawborough Username of the first person to contact.",
"required": true
"required": true,
"type": "string"
},
},
"discord1": {
"discord1": {
"description": "Discord username of the first person to contact, optional."
"description": "Discord username of the first person to contact, optional.",
"type": "string"
},
},
"user2": {
"user2": {
Line 95: Line 102:
},
},
"id2": {
"id2": {
"description": "Pawborough ID of the second person to contact."
"description": "Pawborough ID of the second person to contact.",
"type": "number"
},
},
"discord2": {
"discord2": {
"description": "Discord username of the second person to contact, optional."
"description": "Discord username of the second person to contact, optional.",
"type": "string"
},
},
"user3": {
"user3": {
"description": "Pawborough Username of the third person to contact."
"description": "Pawborough Username of the third person to contact.",
"type": "string"
},
},
"id3": {
"id3": {
"description": "Pawborough ID of the third person to contact."
"description": "Pawborough ID of the third person to contact.",
"type": "number"
},
},
"discord3": {
"discord3": {
"description": "Discord username of the third person to contact, optional."
"description": "Discord username of the third person to contact, optional.",
"type": "string"
},
},
"link1": {
"link1": {
"description": "Important link 1, all links should be formatted like external links.",
"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
"required": true,
"type": "string"
},
},
"link2": {
"link2": {
"description": "Important link 2, all links should be formatted like external links."
"description": "Important link 2, all links should be formatted like external links.",
"type": "string"
},
},
"link3": {
"link3": {
Line 121: Line 135:
},
},
"link4": {
"link4": {
"description": "Important link 4, all links should be formatted like external links."
"description": "Important link 4, all links should be formatted like external links.",
"type": "string"
},
"content": {
"type": "string",
"suggestedvalues": [
"article",
"page"
],
"default": "section",
"description": "Specify the coverage for \"This ____ contains...\", defaults to \"section\"."
}
}
},
},
"paramOrder": [
"paramOrder": [
"content",
"outdated",
"outdated",
"link1",
"link1",

Latest revision as of 20:14, 7 September 2026

Usage

This template is used to notify reads that the following data is unofficial and was collected by the players of Pawborough.

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, though if the parameter |outdated= is set as true pages are added to Category:Articles Containing Outdated Player Data instead.

Syntax

{{PlayerData
|content=
|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 article 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 article updated.
{{PlayerData
|content=article
|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
contentcontent

Specify the coverage for "This ____ contains...", defaults to "section".

Suggested values
article page
Default
section
Stringoptional
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
Stringoptional
link1link1

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

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

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

Stringoptional
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.

Stringoptional
id1id1

Pawborough ID of the first person to contact.

Numberrequired
user1user1

Pawborough Username of the first person to contact.

Stringrequired
discord1discord1

Discord username of the first person to contact, optional.

Stringoptional
id2id2

Pawborough ID of the second person to contact.

Numberoptional
user2user2

Pawborough Username of the second person to contact.

Unknownoptional
discord2discord2

Discord username of the second person to contact, optional.

Stringoptional
id3id3

Pawborough ID of the third person to contact.

Numberoptional
user3user3

Pawborough Username of the third person to contact.

Stringoptional
discord3discord3

Discord username of the third person to contact, optional.

Stringoptional