Template:Infobox Campaign/doc: Difference between revisions

From Stiles Wiki
Jump to navigation Jump to search
No edit summary
 
(11 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=[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{Collapse top|title=[[Stiles.casa Wiki:TemplateData|TemplateData]] documentation used by [[Stiles.casa Wiki:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
{{TemplateData header|noheader=1}}
<templatedata>
<templatedata>
{
{
"format": "{{_\n| __________________ = _\n}}\n",
"params": {
"params": {
"name": {
"name": {
"required": true,
"label": "Name",
"label": "Name",
"description": "name of the campaign",
"type": "string",
"type": "string",
"description": "Name of the Body of Water."
"default": "{{PAGENAME}}"
},
},
"other_name": {
"tag": {
"required": false,
"label": "Tag",
"label": "Other Name",
"description": "tagline of the campaign",
"type": "string",
"type": "string"
"description": "Local, Alternative or Former Names"
},
},
"image": {
"image": {
"required": false,
"label": "Image",
"label": "Image",
"type": "wiki-page-name",
"description": "image representing the campaign",
"description": "Image of the Body of Water"
"type": "wiki-file-name"
},
"alt": {
"required": false,
"label": "Image alternative text",
"type": "string",
"description": "Alt text to display if the image specified by image does not display for whatever reason"
},
},
"caption": {
"caption": {
"required": false,
"label": "Caption",
"label": "Image caption",
"description": "caption about the image",
"type": "string",
"type": "string"
"description": "Caption for the image."
},
"image_bathymetry": {
"required": false,
"label": "Image Bathymetry",
"type": "wiki-page-name",
"description": "Bathymetry Image"
},
"alt_bathymetry": {
"required": false,
"label": "Alt Bathymetry",
"type": "string",
"description": "Alternate text to display if image_bathymetry does not display for whatever reason"
},
"caption_bathymetry": {
"required": false,
"label": "Caption Bathymetry",
"type": "string",
"description": "Image caption for image_bathymetry"
},
"location": {
"required": false,
"label": "Location",
"type": "string",
"description": "Location of the Body of Water"
},
"group": {
"required": false,
"label": "Group",
"type": "string",
"description": "Group of lakes that the body of water belongs to"
},
"coordinates": {
"required": false,
"label": "Coordinates",
"type": "number",
"description": "Latitude and Longitude coordinates of the body of water",
"aliases": ["coords"]
},
"type": {
"required": false,
"label": "Type",
"type": "string",
"description": "Type of the Body of Water"
},
"etymology": {
"required": false,
"label": "Etymology",
"type": "string",
"description": "person, event, or other entity body is named after"
},
},
"part_of": {
"setting": {
"required": false,
"label": "Setting",
"label": "Part of",
"description": "setting the campaign takes place in",
"type": "string",
"type": "wiki-page-name"
"description": "Name of any parent basin or hydrology system"
},
},
"inflow": {
"start": {
"required": false,
"label": "Start",
"label": "Inflow",
"description": "the in-game date the campaign started",
"type": "string",
"example": "{{Convert Date|01-24-1994|Eberron}}",
"description": "Major inflow sources — rivers, aquifers, glacial runoff, etc."
"type": "wiki-template-name"
},
},
"outflow": {
"current_end": {
"required": false,
"label": "Current or End",
"label": "Outflow",
"description": "if the campaign has concluded, use end, otherwise use current",
"type": "string",
"type": "string"
"description": "Outflow Waterway Names e.g. evaporation"
},
},
"catchment": {
"end": {
"required": false,
"label": "End",
"label": "Catchment",
"description": "in-game date the campaign ended",
"type": "string",
"example": "{{Convert Date|01-24-1994|Eberron}}",
"description": "The area of catchment (in square kilometres) which includes the entire area of the drainage basin for that body of water."
"type": "wiki-template-name"
},
},
"basin_countries": {
"status": {
"required": false,
"label": "Status",
"label": "Basin Countries",
"description": "if the campaign is concluded, on-going, or on-hold",
"type": "string",
"type": "string"
"description": "Which countries have drainage to/from or border the body of water."
},
},
"date-built": {
"characters": {
"required": false,
"label": "Characters",
"label": "Date Built",
"description": "list of all player characters that appeared in the campaign",
"type": "line",
"example": "{{hlist|[[Player1]]|[[Player2]]|[[Player3]]|[[Player4]]}}",
"description": "Date of construction of the body of water/reservoir started, if man-made."
"type": "wiki-template-name"
},
},
"date-flooded": {
"bbeg": {
"required": false,
"label": "BBEG",
"label": "Date Flooded",
"description": "the big bad evil guy of the campaign",
"type": "line",
"example": "[[BBEG1]]",
"description": "Date of the body of water/reservoir was first flooded, if man-made or otherwise recent."
"type": "wiki-page-name"
},
},
"agency": {
"firstsession": {
"required": false,
"label": "First Session",
"label": "Agency",
"description": "link to the first session page of this campaign",
"type": "string",
"type": "wiki-page-name"
"description": "Managing or owning organisation"
},
},
"length": {
"latest_last": {
"required": false,
"label": "Latest or Last",
"label": "Length",
"description": "if the campaign has concluded, use last, otherwise use latest",
"type": "number",
"type": "string"
"description": "Maximum length of the body of water in km"
},
},
"width": {
"lastsession": {
"required": false,
"label": "Last Session",
"label": "Width",
"description": "link to the latest/last session page of this campaign",
"type": "number",
"type": "wiki-page-name"
"description": "Maximum width of the body of water in km"
},
"area": {
"required": false,
"label": "Area",
"type": "number",
"description": "Total area of the body of water's surface in square kilometres"
},
"depth": {
"required": false,
"label": "Depth",
"type": "number",
"description": "Average depth of the body of water in metres, fathoms, and/or feet"
},
"max-depth": {
"required": false,
"label": "Max Depth",
"type": "number",
"description": "Maximum depth of the body of water in metres, fathoms, and/or feet."
},
"volume": {
"required": false,
"label": "Volume",
"type": "number",
"description": "Total volume of the body of water (cubic metres, cubic kilometres, cubic miles [cu mi], and/or acre-feet)"
},
"residence_time": {
"required": false,
"label": "Residence Time",
"type": "number",
"description": "Time spent by water in the body of water."
},
"shore": {
"required": false,
"label": "Shore",
"type": "number",
"description": "Length of the shoreline in kilometres and statute miles this should not include values for waterways directly connected to the body of water, and should reflect the shore at average surface area."
},
"elevation": {
"required": false,
"label": "Elevation",
"type": "number",
"description": "Elevation above sea-level in meters."
},
"frozen": {
"required": false,
"label": "Frozen",
"type": "string",
"description": "Information about freezing: e.g. usual freezing date, months the body of water is frozen, last years the body of water was frozen, never, etc."
},
"islands": {
"required": false,
"label": "Islands",
"type": "number",
"description": "Total number of islands in the body of water"
},
"cities": {
"required": false,
"label": "Cities",
"type": "number",
"description": "Notable cities or settlements on or near the shore of the body of water."
},
"reference": {
"required": false,
"label": "Reference",
"type": "string",
"description": "references for some or all of the values."
}
}
}
}
Line 272: 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]]
[[Category:Infobox Templates]]
}}</includeonly>
}}</includeonly>

Latest revision as of 10: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