Stiles Wiki

Template:Infobox Adventure/doc: Difference between revisions

Template Discussion

Template:Infobox Adventure/doc (view source)

Revision as of 11:36, 30 May 2022

91 bytes removed ,  30 May 2022
no edit summary
No edit summary
No edit summary
 
(7 intermediate revisions by the same user not shown)
Line 3: Line 3:
{{Lua|Module:Infobox|Module:Date Stuff}}
{{Lua|Module:Infobox|Module:Date Stuff}}
This template can be used to add at-a-glance information on TTRPG adventures and one-shots.
This template can be used to add at-a-glance information on TTRPG adventures and one-shots.
== Usage ==
== Usage ==
{{Parameter names example
{{Parameter names example
Line 10: Line 9:
| image
| image
| caption
| caption
| setting
| status
| start
| start
| current_end
| end
| end
| characters
| characters
| npcs
| bbeg
| bbeg
| npcs
| firstsession
| firstsession
| latest_last
| lastsession
| lastsession
| setting
}}
}}
<pre style="overflow:auto;">
<pre style="overflow:auto;">
{{Infobox Adventure
{{Infobox Adventure
| name =  
| name         =  
| tag =  
| tag         =  
<!-- Images -->
<!-- Images -->
| image =  
| image       =  
| caption =  
| caption     =  
<!-- In Game Dates -->
<!-- Dates -->
| setting =  
| start        =  
| status =
| current_end  =  
| start =  
| end         =  
| end =  
<!-- Cast  -->
<!-- Characters -->
| characters   =  
| characters =  
| bbeg         =  
| bbeg =  
| npcs         =  
| npcs =  
<!--Timeline -->
<!-- First and last/latest session -->
| firstsession =  
| firstsession =  
| lastsession =  
| latest_last  =
| lastsession =
<!-- Setting -->
| setting      =  
}}
}}
</pre>
</pre>
== Parameters ==
== Parameters ==
; <code>name</code>: name of the campaign. If left blank, defaults to page name.
; <code>name</code>: name of the adventure
; <code>tag</code>: tag for the campaign, if there is one
; <code>tag</code>: tagline of the adventure
; <code>image</code>: image for the campaign
; <code>image</code>: image that represents the adventure
; <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>start</code>: in-game date the adventure started
; <code>status</code>: if the campaign is on-going, on-hold, or concluded
; <code>current_end</code>: depending on if the adventure is concluded, on-going, or on-hold
; <code>start</code>: the in-game day the campaign started
; <code>end</code>: in-game date the adventure ended/currently is on
; <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>characters</code>: list of all characters that were part of the adventure
; <code>characters</code>: list of characters, separated by the {{}} template
; <code>npcs</code>: list of notable NPCs from the adventure
; <code>bbeg</code>: the bbeg, if the campaign had one
; <code>bbeg</code>: big bad evil guy of the adventure
; <code>npcs</code>: list of notable NPCs
; <code>firstsession</code>: link to the first session of the adventure
; <code>firstsession</code>: name of the first session
; <code>latest_last</code>: depending on if the adventure is concluded, on-going, or on-hold
; <code>lastsession</code>: name of the last session. The header changes based on the status.
; <code>lastsession</code>: link to the latest/last session of the adventure
 
==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 63: Line 64:
"params": {
"params": {
"name": {
"name": {
"required": false,
"label": "Name",
"label": "Name",
"description": "name of the adventure",
"type": "string",
"type": "string",
"description": "Name of the adventure. If left blank will default to pagename."
"required": true
},
},
"tag": {
"tag": {
"required": false,
"label": "Tag",
"label": "Tag",
"type": "string",
"description": "tagline of the adventure",
"description": "Tag line for the adventure."
"type": "string"
},
},
"image": {
"image": {
"required": false,
"label": "Image",
"label": "Image",
"type": "wiki-page-name",
"description": "image that represents the adventure",
"description": "Image representing the adventure."
"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": {
"start": {
"required": true,
"label": "Start",
"label": "Setting",
"description": "in-game date the adventure started",
"type": "string",
"example": "{{Convert Date|01-24-1994|Eberron}}",
"description": "The setting where the adventure takes place."
"type": "wiki-template-name"
},
},
"status": {
"current_end": {
"required": true,
"label": "Current or End",
"label": "Status",
"description": "depending on if the adventure is concluded, on-going, or on-hold",
"type": "string",
"type": "string"
"description": "The status of the adventure; on-going, on-hold, concluded."
},
"start": {
"required": false,
"label": "Start Date",
"type": "date",
"description": "In-game start date of the adventure, in the MM-DD-YYYY form."
},
},
"end": {
"end": {
"required": false,
"label": "End",
"label": "End Date",
"description": "in-game date the adventure ended/currently is on",
"type": "date",
"example": "{{Convert Date|01-24-1994|Eberron}}",
"description": "In-game end date of the adventure, 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"
},
},
"characters": {
"characters": {
"required": false,
"label": "Characters",
"label": "Characters",
"type": "string",
"description": "list of all characters that were part of the adventure",
"description": "List of all player characters in the adventure."
"example": "{{hlist|[[Player1]]|[[Player2]]}}",
"type": "wiki-template-name"
},
"npcs": {
"label": "NPCs",
"description": "list of notable NPCs from the adventure",
"example": "{{hlist|[[NPC1]]|[[NPC2]]|[[NPC3]]}}",
"type": "wiki-template-name"
},
},
"bbeg": {
"bbeg": {
"required": false,
"label": "BBEG",
"label": "BBEG",
"type": "string",
"description": "big bad evil guy of the adventure",
"description": "The BBEG of the adventure, if there was one."
"type": "wiki-page-name"
},
"npcs": {
"required": false,
"label": "Notable NPCs",
"type": "string",
"description": "A list of notable NPCs."
},
},
"firstsession": {
"firstsession": {
"required": false,
"label": "First Session",
"label": "First Session",
"type": "string",
"description": "link to the first session of the adventure",
"description": "Title of the first session."
"type": "wiki-page-name"
},
"latest_last": {
"label": "Latest or Last",
"description": "depending on if the adventure is concluded, on-going, or on-hold",
"type": "string"
},
},
"lastsession": {
"lastsession": {
"required": false,
"label": "Last Session",
"label": "Last Session",
"type": "string",
"description": "link to the latest/last session of the adventure",
"description": "Title of the latest/last session."
"type": "wiki-page-name"
}
}
}
}
Line 144: Line 137:
</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 adventure}}
{{DEFAULTSORT:Infobox Adventure}}
}}</includeonly>
}}</includeonly>
Retrieved from "https://wiki.stiles.casa/view/Special:MobileDiff/3101...3796"