Difference between revisions of "PCInfobox"
(Added custom field) |
m (Parameter type changes) |
||
(13 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | < | + | <includeonly>{{CharacterInfoBox |
− | </ | + | |title={{{title|}}} |
− | < | + | |image={{{image|}}} |
− | <templatedata> | + | |name={{{name|}}} |
+ | |party={{{party|}}} | ||
+ | |class={{{class|}}} | ||
+ | |status={{{status|}}} | ||
+ | |race={{{race|}}} | ||
+ | |DoB={{{DoB|}}} | ||
+ | |physical={{{physical|}}} | ||
+ | |faction={{{faction|}}} | ||
+ | |gender={{{gender|}}} | ||
+ | |customFieldName={{{customFieldName|}}} | ||
+ | |customFieldContent={{{customFieldContent|}}}}}</includeonly><noinclude> | ||
+ | {{Documentation | ||
+ | | title = PC Infobox | ||
+ | | introduction = This PC info box should be used by all Player Characters on their page. It has space for most relevant information other players might need at a glance. It also has a space for you to add your own custom content. To do so, simply put the name of the custom row in custommFieldName and the row content in customFieldContent. If you feel you want more fields than provided here, get in touch with David. | ||
+ | | usageContent = To use this info box, you simply need to fill in all of the required fields. The optional ones can be used if required. To use the custom field you need to pass in a name and some content for it to work correctly. | ||
+ | | usageExample = | ||
+ | <pre>{{PCInfobox | ||
+ | |title=The PC's name | ||
+ | |image=byAllah.jpg | ||
+ | |name=The PC's full name | ||
+ | |party=Some random party | ||
+ | |class=I dunno druid or some shit | ||
+ | |status=Dead lmao | ||
+ | |race=That's a personal question | ||
+ | |DoB=6/9/69 | ||
+ | |physical=Short af | ||
+ | |gender=Female | ||
+ | |customFieldName=A custom field | ||
+ | |customFieldContent=Use customFieldName and customFieldContent to create your own custom rows}}</pre> | ||
+ | | usageResult = {{PCInfobox | ||
+ | |title=The PC's name | ||
+ | |image=byAllah.jpg | ||
+ | |name=The PC's full name | ||
+ | |party=Some random party | ||
+ | |class=I dunno druid or some shit | ||
+ | |status=Dead lmao | ||
+ | |race=That's a personal question | ||
+ | |DoB=6/9/69 | ||
+ | |physical=Short af | ||
+ | |gender=Female | ||
+ | |customFieldName=A custom field | ||
+ | |customFieldContent=Use customFieldName and customFieldContent to create your own custom rows}} | ||
+ | | parameters = <templatedata> | ||
{ | { | ||
− | "description": " | + | "description": "Fill in all the required fields, suggested fields will help flesh out your character a bit. There is a space for a custom field too.", |
"params": { | "params": { | ||
"title": { | "title": { | ||
Line 38: | Line 80: | ||
"example": "Bard (College of Lore) 11", | "example": "Bard (College of Lore) 11", | ||
"type": "string", | "type": "string", | ||
− | " | + | "required": true |
}, | }, | ||
"status": { | "status": { | ||
Line 46: | Line 88: | ||
"type": "string", | "type": "string", | ||
"default": "Alive", | "default": "Alive", | ||
− | "autovalue": "", | + | "autovalue": "Alive", |
"suggested": true | "suggested": true | ||
}, | }, | ||
Line 73: | Line 115: | ||
"example": "Templar Order", | "example": "Templar Order", | ||
"type": "wiki-page-name" | "type": "wiki-page-name" | ||
+ | }, | ||
+ | "gender": { | ||
+ | "label": "Gender", | ||
+ | "description": "The Character's gender", | ||
+ | "example": "Male, Female, etc.", | ||
+ | "type": "string" | ||
+ | }, | ||
+ | "customFieldName": { | ||
+ | "label": "Custom Field Name", | ||
+ | "description": "A custom field for you to write your own things", | ||
+ | "type": "string" | ||
+ | }, | ||
+ | "customFieldContent": { | ||
+ | "label": "Custom Field Content", | ||
+ | "description": "The content to be placed in the custom field", | ||
+ | "type": "unbalanced-wikitext" | ||
} | } | ||
}, | }, | ||
Line 85: | Line 143: | ||
"DoB", | "DoB", | ||
"physical", | "physical", | ||
− | "faction" | + | "faction", |
− | ] | + | "gender", |
− | } | + | "customFieldName", |
− | </templatedata> | + | "customFieldContent" |
− | </noinclude> | + | ], |
+ | "format": "block" | ||
+ | }</templatedata>}}</noinclude> |
Latest revision as of 19:53, 29 November 2020
PC Infobox
This PC info box should be used by all Player Characters on their page. It has space for most relevant information other players might need at a glance. It also has a space for you to add your own custom content. To do so, simply put the name of the custom row in custommFieldName and the row content in customFieldContent. If you feel you want more fields than provided here, get in touch with David.
Usage:
To use this info box, you simply need to fill in all of the required fields. The optional ones can be used if required. To use the custom field you need to pass in a name and some content for it to work correctly.
{{PCInfobox |title=The PC's name |image=byAllah.jpg |name=The PC's full name |party=Some random party |class=I dunno druid or some shit |status=Dead lmao |race=That's a personal question |DoB=6/9/69 |physical=Short af |gender=Female |customFieldName=A custom field |customFieldContent=Use customFieldName and customFieldContent to create your own custom rows}}
The above would render the following:
The PC's name | |
---|---|
Full Name: | The PC's full name |
Party: | Some random party |
Class and Subclass Info: | I dunno druid or some shit |
Gender: | Female |
Status: | Dead lmao |
Race: | That's a personal question |
Date of Birth (Age): | 6/9/69 |
Physical Description: | Short af |
A custom field: | Use customFieldName and customFieldContent to create your own custom rows |
Parameters:
Fill in all the required fields, suggested fields will help flesh out your character a bit. There is a space for a custom field too.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Title | title | Page title, usually character's first name
| String | required |
Image | image | Picture of character | File | suggested |
Full Name | name | Full Name of character, with any titles
| String | required |
Party | party | The Party (campaign) the character belongs/belonged to
| String | required |
Class Info | class | Class/Subclass info, including levels in each
| String | required |
Status | status | Current Status - example are Alive, Dead, Left Party, Temporarily Away etc.
| String | suggested |
Race | race | In-game race/subrace
| String | optional |
Date of Birth | DoB | Date of Birth (and age in brackets if you want).
| String | suggested |
Physical Description | physical | Height, Weight, Skin Tone, Horns/Tattoos, etc. | String | suggested |
Faction | faction | Any factions the character is aligned with (optional)
| Page | optional |
Gender | gender | The Character's gender
| String | optional |
Custom Field Name | customFieldName | A custom field for you to write your own things | String | optional |
Custom Field Content | customFieldContent | The content to be placed in the custom field | Unbalanced wikitext | optional |