Template:Infobox Campaign/doc: Difference between revisions

← Older edit

Template:Infobox Campaign/doc (view source)

Revision as of 10:31, 30 May 2022

4,132 bytes added , 30 May 2022

→‎Usage

Maxwells

Bureaucrats, Interface administrators, Administrators

4,599

edits

@@ Line 1: / Line 1: @@
+{{Documentation subpage}}
+<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata -->
+{{Lua|Module:Infobox}}
+This template can be used to add at-a-glance information on TTRPG campaigns.
+== Usage ==
+{{Parameter names example
+|name
+|tag
+|image
+|caption
+|setting
+|start
+|current_end
+|end
+|status
+|characters
+|bbeg
+|firstsession
+|latest_last
+|lastsession
+}}
+<pre style="overflow:auto;">
 {{Infobox Campaign
-|name = {{{name}}}
+| name         =
+| tag          =
+<!-- Images  -->
+| image        =
+| caption      =
+<!-- Status  -->
+| setting      =
+| start        =
+| current_end  =
+| end          =
+| status       =
+<!--  Cast   -->
+| characters   =
+| bbeg         =
+<!--Timeline -->
+| firstsession =
+| latest_last  =
+| lastsession  =
 }}
-This template is used for campaign information
+</pre>
+== Parameters ==
+; <code>name</code>: name of the campaign
+; <code>tag</code>: tagline of the campaign
+; <code>image</code>: image representing the campaign
+; <code>caption</code>: caption about the image
+; <code>setting</code>: setting the campaign takes place in
+; <code>start</code>: the in-game date the campaign started
+; <code>current_end</code>: if the campaign has concluded, use end, otherwise use current
+; <code>end</code>: in-game date the campaign ended
+; <code>status</code>: if the campaign is concluded, on-going, or on-hold
+; <code>characters</code>: list of all player characters that appeared in the campaign
+; <code>bbeg</code>: the big bad evil guy of the campaign
+; <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==
+{{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>