Template:Infobox Campaign/doc: Difference between revisions

No edit summary
 
(14 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{Lua|Module:Infobox}}
{{Lua|Module:Infobox}}
 
This template can be used to add at-a-glance information on TTRPG campaigns.
== Usage ==
== Usage ==
{{Parameter names example
{{Parameter names example
| name
|name
| tag
|tag
| image
|image
| caption
|caption
| setting
|setting
| start
|start
| end
|current_end
| status
|end
| characters
|status
| bbeg
|characters
| firstsession
|bbeg
| lastsession
|firstsession
|latest_last
|lastsession
}}
}}
<pre style="overflow:auto;">
<pre style="overflow:auto;">
{{Infobox Campaign
{{Infobox Campaign
| name =  
| name         =  
| tag =  
| tag         =  
<!-- Images -->
<!-- Images -->
| image =  
| image       =  
| caption =  
| caption     =  
<!-- In Game Dates -->
<!-- Status  -->
| setting =  
| setting     =  
| start =  
| start       =
| end =  
| current_end  =  
| status =  
| end         =  
<!-- Characters -->
| status       =  
| characters =  
<!-- Cast  -->
| bbeg =  
| characters   =  
<!-- First and last/latest session -->
| bbeg         =  
<!--Timeline -->
| firstsession =  
| firstsession =  
| lastsession =  
| latest_last  =
| lastsession =  
}}
}}
</pre>
</pre>


== Parameters ==
== Parameters ==
; <code>name</code>: name of the campaign. If left blank, defaults to page name.
; <code>name</code>: name of the campaign
; <code>tag</code>: tag for the campaign, if there is one
; <code>tag</code>: tagline of the campaign
; <code>image</code>: image for the campaign
; <code>image</code>: image representing the campaign
; <code>caption</code>: caption about the image
; <code>caption</code>: caption about the image
; <code>setting</code>: the setting the campaign takes place in, this is also used for the dates to convert number dates to full dates
; <code>setting</code>: setting the campaign takes place in
; <code>start</code>: the in-game day the campaign started
; <code>start</code>: the in-game date the campaign started
; <code>end</code>: if status is "Concluded", the in-game day the campaign ended. Otherwise uses the current date from the current dates template.
; <code>current_end</code>: if the campaign has concluded, use end, otherwise use current
; <code>status</code>: if the campaign is on-going, on-hold, or concluded
; <code>end</code>: in-game date the campaign ended
; <code>characters</code>: list of characters, separated by the {{}} template
; <code>status</code>: if the campaign is concluded, on-going, or on-hold
; <code>bbeg</code>: the bbeg, if the campaign had one
; <code>characters</code>: list of all player characters that appeared in the campaign
; <code>firstsession</code>: name of the first session
; <code>bbeg</code>: the big bad evil guy of the campaign
; <code>lastsession</code>: name of the last session. The header changes based on the status.
; <code>firstsession</code>: link to the first session page of this campaign
 
; <code>latest_last</code>: if the campaign has concluded, use last, otherwise use latest
[[Category:All Templates]]
; <code>lastsession</code>: link to the latest/last session page of this campaign
[[Category:Infobox Templates]]
==TemplateData==
{{Collapse top|title=[[Stiles.casa Wiki:TemplateData|TemplateData]] documentation used by [[Stiles.casa Wiki:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
{
"params": {
"name": {
"label": "Name",
"description": "name of the campaign",
"type": "string",
"default": "{{PAGENAME}}"
},
"tag": {
"label": "Tag",
"description": "tagline of the campaign",
"type": "string"
},
"image": {
"label": "Image",
"description": "image representing the campaign",
"type": "wiki-file-name"
},
"caption": {
"label": "Caption",
"description": "caption about the image",
"type": "string"
},
"setting": {
"label": "Setting",
"description": "setting the campaign takes place in",
"type": "wiki-page-name"
},
"start": {
"label": "Start",
"description": "the in-game date the campaign started",
"example": "{{Convert Date|01-24-1994|Eberron}}",
"type": "wiki-template-name"
},
"current_end": {
"label": "Current or End",
"description": "if the campaign has concluded, use end, otherwise use current",
"type": "string"
},
"end": {
"label": "End",
"description": "in-game date the campaign ended",
"example": "{{Convert Date|01-24-1994|Eberron}}",
"type": "wiki-template-name"
},
"status": {
"label": "Status",
"description": "if the campaign is concluded, on-going, or on-hold",
"type": "string"
},
"characters": {
"label": "Characters",
"description": "list of all player characters that appeared in the campaign",
"example": "{{hlist|[[Player1]]|[[Player2]]|[[Player3]]|[[Player4]]}}",
"type": "wiki-template-name"
},
"bbeg": {
"label": "BBEG",
"description": "the big bad evil guy of the campaign",
"example": "[[BBEG1]]",
"type": "wiki-page-name"
},
"firstsession": {
"label": "First Session",
"description": "link to the first session page of this campaign",
"type": "wiki-page-name"
},
"latest_last": {
"label": "Latest or Last",
"description": "if the campaign has concluded, use last, otherwise use latest",
"type": "string"
},
"lastsession": {
"label": "Last Session",
"description": "link to the latest/last session page of this campaign",
"type": "wiki-page-name"
}
}
}
</templatedata>
{{Collapse bottom}}
<includeonly>{{basepage subpage|
<!-- Categories below this line, please; interwikis at Wikidata -->
{{DEFAULTSORT:Infobox Campaign}}
}}</includeonly>