Template:Infobox Campaign/doc: Difference between revisions

From Stiles Wiki
Jump to navigation Jump to search
No edit summary
 
(4 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 -->
<!-- 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
| 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
; <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 63:
<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 143:
</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}}
[[Category:All Templates]]
}}</includeonly>
[[Category:Infobox Templates]]
}}test</includeonly>

Latest revision as of 11:31, 30 May 2022

This template can be used to add at-a-glance information on TTRPG campaigns.

Usage

{{{name}}}
{{{tag}}}
{{{image}}}
{{{caption}}}
Status
Setting{{{setting}}}
Start Date{{{start}}}
{{{current_end}}} Date{{{end}}}
Status{{{status}}}
Cast
Characters{{{characters}}}
BBEG{{{bbeg}}}
Timeline
First Session{{{firstsession}}}
{{{latest_last}}} Session{{{lastsession}}}
{{Infobox Campaign
| name         = 
| tag          = 
<!-- Images  -->
| image        = 
| caption      = 
<!-- Status  -->
| setting      = 
| start        = 
| current_end  = 
| end          = 
| status       = 
<!--  Cast   -->
| characters   = 
| bbeg         = 
<!--Timeline -->
| firstsession = 
| latest_last  = 
| lastsession  = 
}}

Parameters

name
name of the campaign
tag
tagline of the campaign
image
image representing the campaign
caption
caption about the image
setting
setting the campaign takes place in
start
the in-game date the campaign started
current_end
if the campaign has concluded, use end, otherwise use current
end
in-game date the campaign ended
status
if the campaign is concluded, on-going, or on-hold
characters
list of all player characters that appeared in the campaign
bbeg
the big bad evil guy of the campaign
firstsession
link to the first session page of this campaign
latest_last
if the campaign has concluded, use last, otherwise use latest
lastsession
link to the latest/last session page of this campaign

TemplateData

TemplateData documentation used by VisualEditor and other tools

TemplateData for Infobox Campaign

No description.

Template parameters

ParameterDescriptionTypeStatus
Namename

name of the campaign

Default
{{PAGENAME}}
Stringoptional
Tagtag

tagline of the campaign

Stringoptional
Imageimage

image representing the campaign

Fileoptional
Captioncaption

caption about the image

Stringoptional
Settingsetting

setting the campaign takes place in

Page nameoptional
Startstart

the in-game date the campaign started

Example
{{Convert Date|01-24-1994|Eberron}}
Templateoptional
Current or Endcurrent_end

if the campaign has concluded, use end, otherwise use current

Stringoptional
Endend

in-game date the campaign ended

Example
{{Convert Date|01-24-1994|Eberron}}
Templateoptional
Statusstatus

if the campaign is concluded, on-going, or on-hold

Stringoptional
Characterscharacters

list of all player characters that appeared in the campaign

Example
{{hlist|[[Player1]]|[[Player2]]|[[Player3]]|[[Player4]]}}
Templateoptional
BBEGbbeg

the big bad evil guy of the campaign

Example
[[BBEG1]]
Page nameoptional
First Sessionfirstsession

link to the first session page of this campaign

Page nameoptional
Latest or Lastlatest_last

if the campaign has concluded, use last, otherwise use latest

Stringoptional
Last Sessionlastsession

link to the latest/last session page of this campaign

Page nameoptional