Template:Infobox Campaign/doc: Difference between revisions

Jump to navigation Jump to search
no edit summary
No edit summary
No edit summary
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata -->
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{Lua|Module:Infobox|Module:Date Stuff}}
{{Lua|Module:Infobox}}
 
This template can be used to add at-a-glance information on TTRPG campaigns.
This template can be used to add at-a-glance information on TTRPG campaigns.
== Usage ==
== Usage ==
{{Parameter names example
{{Parameter names example
Line 22: Line 20:
|lastsession
|lastsession
}}
}}
<pre style="overflow:auto;">
<pre style="overflow:auto;">
{{Infobox Campaign
{{Infobox Campaign
Line 41: Line 38:
}}
}}
</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
; <code>lastsession</code>: link to the latest/last session page of this campaign
==TemplateData==
==TemplateData==
{{Collapse top|title=[[Stiles.casa Wiki:TemplateData|TemplateData]] documentation used by [[Stiles.casa Wiki:VisualEditor|VisualEditor]] and other tools}}
{{Collapse top|title=[[Stiles.casa Wiki:TemplateData|TemplateData]] documentation used by [[Stiles.casa Wiki:VisualEditor|VisualEditor]] and other tools}}
Line 61: Line 58:
<templatedata>
<templatedata>
{
{
"format": "{{_\n| __________________ = _\n}}\n",
"params": {
"params": {
"name": {
"name": {
"required": false,
"label": "Name",
"label": "Name",
"description": "name of the campaign",
"type": "string",
"type": "string",
"description": "Name of the campaign. If left blank will default to pagename."
"default": "{{PAGENAME}}"
},
},
"tag": {
"tag": {
"required": false,
"label": "Tag",
"label": "Tag",
"type": "string",
"description": "tagline of the campaign",
"description": "Tag line for the campaign."
"type": "string"
},
},
"image": {
"image": {
"required": false,
"label": "Image",
"label": "Image",
"type": "wiki-page-name",
"description": "image representing the campaign",
"description": "Image representing the campaign."
"type": "wiki-file-name"
},
},
"caption": {
"caption": {
"required": false,
"label": "Caption",
"label": "Caption",
"type": "string",
"description": "caption about the image",
"description": "Caption for the image."
"type": "string"
},
},
"setting": {
"setting": {
"required": true,
"label": "Setting",
"label": "Setting",
"type": "string",
"description": "setting the campaign takes place in",
"description": "The setting where the campaign takes place."
"type": "wiki-page-name"
},
},
"start": {
"start": {
"required": false,
"label": "Start",
"label": "Start Date",
"description": "the in-game date the campaign started",
"type": "date",
"example": "{{Convert Date|01-24-1994|Eberron}}",
"description": "In-game start date of the campaign, in the MM-DD-YYYY form."
"type": "wiki-template-name"
},
"current_end": {
"label": "Current or End",
"description": "if the campaign has concluded, use end, otherwise use current",
"type": "string"
},
},
"end": {
"end": {
"required": false,
"label": "End",
"label": "End Date",
"description": "in-game date the campaign ended",
"type": "date",
"example": "{{Convert Date|01-24-1994|Eberron}}",
"description": "In-game end date of the campaign, in the MM-DD-YYYY form. If left blank, will use the Current date template to get the current date in the setting."
"type": "wiki-template-name"
},
},
"status": {
"status": {
"required": true,
"label": "Status",
"label": "Status",
"type": "string",
"description": "if the campaign is concluded, on-going, or on-hold",
"description": "The status of the campaign; on-going, on-hold, concluded."
"type": "string"
},
},
"characters": {
"characters": {
"required": false,
"label": "Characters",
"label": "Characters",
"type": "string",
"description": "list of all player characters that appeared in the campaign",
"description": "List of all player characters in the campaign."
"example": "{{hlist|[[Player1]]|[[Player2]]|[[Player3]]|[[Player4]]}}",
"type": "wiki-template-name"
},
},
"bbeg": {
"bbeg": {
"required": false,
"label": "BBEG",
"label": "BBEG",
"type": "string",
"description": "the big bad evil guy of the campaign",
"description": "The BBEG of the campaign, if there was one."
"example": "[[BBEG1]]",
"type": "wiki-page-name"
},
},
"firstsession": {
"firstsession": {
"required": false,
"label": "First Session",
"label": "First Session",
"type": "string",
"description": "link to the first session page of this campaign",
"description": "Title of the first session."
"type": "wiki-page-name"
},
"latest_last": {
"label": "Latest or Last",
"description": "if the campaign has concluded, use last, otherwise use latest",
"type": "string"
},
},
"lastsession": {
"lastsession": {
"required": false,
"label": "Last Session",
"label": "Last Session",
"type": "string",
"description": "link to the latest/last session page of this campaign",
"description": "Title of the latest/last session."
"type": "wiki-page-name"
}
}
}
}
Line 139: Line 138:
</templatedata>
</templatedata>
{{Collapse bottom}}
{{Collapse bottom}}
<includeonly>{{basepage subpage|
<includeonly>{{basepage subpage|
<!-- Categories below this line, please; interwikis at Wikidata -->
<!-- Categories below this line, please; interwikis at Wikidata -->
{{DEFAULTSORT:Infobox Campaign}}
{{DEFAULTSORT:Infobox Campaign}}
}}</includeonly>
}}</includeonly>

Navigation menu