Template:Infobox Session/doc: Difference between revisions

From Stiles Wiki
Jump to navigation Jump to search
 
(3 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 individual TTRPG sessions.
This template can be used to add at-a-glance information on individual TTRPG sessions.
== Usage ==
== Usage ==
{{Parameter names example
{{Parameter names example
Line 11: Line 9:
| adventure
| adventure
| campaign
| campaign
| setting
| image
| image
| caption
| caption
Line 18: Line 15:
| characters
| characters
| npcs
| npcs
| cities
| locations
| locations
| previoussession
| previoussession
| nextsession
| nextsession
| setting
}}
}}
<pre style="overflow:auto;">
<pre style="overflow:auto;">
{{Infobox Session
{{Infobox Session
| name =  
| name           =  
| tag =  
| tag             =  
| adventure =  
<!--  Campaign  -->
| campaign =  
| adventure       =  
| setting =
| campaign       =  
| image =  
<!--  Images  -->
| caption =  
| image           =  
| irldate =  
| caption         =  
| gamedate =
<!--  Dates    -->
| characters =  
| irldate         =  
| npcs =  
| gamedate       =  
| locations =  
<!--    Cast    -->
| characters     =  
| npcs           =
| cities          =  
| locations       =  
<!--  Timeline  -->
| previoussession =  
| previoussession =  
| nextsession =  
| nextsession     =
<!--  Setting  -->
| setting        =  
}}
}}
</pre>
</pre>


== Parameters ==
== Parameters ==
; <code>name</code>: name of the session. If left blank, defaults to page name.
; <code>name</code>: name of the session
; <code>tag</code>: tag for the session, if there is one
; <code>tag</code>: tagline of the session
; <code>adventure</code>: what adventure the session is a part of
; <code>adventure</code>: adventure the session belongs to
; <code>campaign</code>: what campaign the session is a part of
; <code>campaign</code>: campaign the session belongs to
; <code>setting</code>: the setting the session takes place in, this is also used for the dates to convert number dates to full dates
; <code>image</code>: image representing the session
; <code>image</code>: image for the session
; <code>caption</code>: caption of the image
; <code>caption</code>: caption about the image
; <code>irldate</code>: the IRL date the session was played
; <code>irldate</code>: the IRL date the session was played
; <code>gamedate</code>: the starting in-game date of the session
; <code>gamedate</code>: the in-game date the session started on
; <code>characters</code>: list of characters, separated by the {{}} template
; <code>characters</code>: list of characters that played the session
; <code>npcs</code>: list of notable npcs in the session
; <code>npcs</code>: list of notable NPCs from the session
; <code>locations</code>: list of notable locations visited in the session
; <code>cities</code>: list of notable cities from the session
; <code>previoussession</code>: name of the preceding session
; <code>locations</code>: list of notable locations from the session
; <code>nextsession</code>: name of the following session
; <code>previoussession</code>: link to the previous session from an in-game perspective
; <code>nextsession</code>: link to the next session from an in-game perspective
; <code>setting</code>: link to the setting page
==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 65: Line 71:
"name": {
"name": {
"label": "Name",
"label": "Name",
"description": "Name of the session. If left blank will default to pagename",
"description": "name of the session",
"type": "string",
"type": "string",
"autovalue": "{{PAGENAME}}"
"default": "{{PAGENAME}}"
},
},
"tag": {
"tag": {
"label": "Tag",
"label": "Tag",
"description": "Tag line for the session",
"description": "tagline of the session",
"type": "string"
"type": "string"
},
},
"adventure": {
"adventure": {
"label": "Adventure",
"label": "Adventure",
"description": "the adventure the session is part of",
"description": "adventure the session belongs to",
"type": "string",
"type": "wiki-page-name"
"suggested": true
},
"setting": {
"label": "Setting",
"description": "the setting the session takes place in",
"type": "string",
"suggested": true
},
},
"campaign": {
"campaign": {
"label": "Campaign",
"label": "Campaign",
"description": "the campaign the session is part of",
"description": "campaign the session belongs to",
"type": "string",
"type": "string"
"suggested": true
},
},
"image": {
"image": {
"label": "Image",
"label": "Image",
"description": "relevant image of the session",
"description": "image representing the session",
"type": "wiki-file-name"
"type": "wiki-file-name"
},
},
"caption": {
"caption": {
"label": "Caption",
"label": "Caption",
"description": "caption for the image",
"description": "caption of the image",
"type": "string"
"type": "string"
},
},
"irldate": {
"irldate": {
"label": "Real Life Date",
"label": "IRL Date",
"description": "the real life date the session was played",
"description": "the IRL date the session was played",
"example": "12-23-3456",
"example": "{{Convert Date|01-24-1994|IRL}}",
"type": "date"
"type": "wiki-template-name"
},
},
"gamedate": {
"gamedate": {
"label": "In-Game Date",
"label": "Game Date",
"description": "the in-game date the session started on",
"description": "the in-game date the session started on",
"example": "01-02-034",
"example": "{{Convert Date|01-24-1994|Eberron}}",
"type": "date"
"type": "wiki-template-name"
},
},
"characters": {
"characters": {
"label": "Player Characters",
"label": "Character",
"description": "list of all PCs that were in the session",
"description": "list of characters that played the session",
"type": "string"
"example": "{{hlist|[[Player1]]|[[Player2]]}}",
"type": "wiki-template-name"
},
},
"npcs": {
"npcs": {
"label": "Notable NPCs",
"label": "NPCs",
"description": "list of notable NPCs from the session",
"description": "list of notable NPCs from the session",
"type": "string"
"example": "{{hlist|[[NPC1]]|[[NPC2]]}}",
"type": "wiki-template-name"
},
},
"locations": {
"locations": {
"label": "Notable Locations",
"label": "Locations",
"description": "list of notable locations from the session",
"description": "list of notable locations from the session",
"type": "string"
"example": "{{hlist|[[Location1]]|[[Location2]]}}",
"type": "wiki-template-name"
},
},
"previoussession": {
"previoussession": {
"label": "Previous Session",
"label": "Previous Session",
"description": "name of the previous session",
"description": "link to the previous session from an in-game perspective",
"type": "string"
"type": "wiki-page-name"
},
},
"nextsession": {
"nextsession": {
"label": "Next Session",
"label": "Next Session",
"description": "name of the next session",
"description": "link to the next session from an in-game perspective",
"type": "string"
"type": "wiki-page-name"
},
"setting": {
"label": "Setting",
"description": "link to the setting page",
"type": "wiki-page-name"
}
}
},
}
"paramOrder": [
"name",
"tag",
"adventure",
"campaign",
"setting",
"image",
"caption",
"irldate",
"gamedate",
"characters",
"npcs",
"locations",
"previoussession",
"nextsession"
]
}
}
</templatedata>
</templatedata>

Latest revision as of 09:37, 30 May 2022

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

Usage

{{{name}}}
{{{tag}}}
{{{adventure}}} - {{{campaign}}}
{{{image}}}
{{{caption}}}
Dates
Date Played{{{irldate}}}
Game Date{{{gamedate}}}
Cast
Characters{{{characters}}}
Notable NPCs{{{npcs}}}
Notable Cities{{{cities}}}
Notable Locations{{{locations}}}
Timeline
Previous Session{{{previoussession}}}
Next Session{{{nextsession}}}
Setting{{{setting}}}
{{Infobox Session
| name            = 
| tag             = 
<!--  Campaign  -->
| adventure       = 
| campaign        = 
<!--   Images   -->
| image           = 
| caption         = 
<!--   Dates    -->
| irldate         = 
| gamedate        = 
<!--    Cast    -->
| characters      = 
| npcs            = 
| cities          = 
| locations       = 
<!--  Timeline  -->
| previoussession = 
| nextsession     = 
<!--  Setting   -->
| setting         = 
}}

Parameters

name
name of the session
tag
tagline of the session
adventure
adventure the session belongs to
campaign
campaign the session belongs to
image
image representing the session
caption
caption of the image
irldate
the IRL date the session was played
gamedate
the in-game date the session started on
characters
list of characters that played the session
npcs
list of notable NPCs from the session
cities
list of notable cities from the session
locations
list of notable locations from the session
previoussession
link to the previous session from an in-game perspective
nextsession
link to the next session from an in-game perspective
setting
link to the setting page

TemplateData

TemplateData documentation used by VisualEditor and other tools

TemplateData for Infobox Session

No description.

Template parameters

ParameterDescriptionTypeStatus
Namename

name of the session

Default
{{PAGENAME}}
Stringoptional
Tagtag

tagline of the session

Stringoptional
Adventureadventure

adventure the session belongs to

Page nameoptional
Campaigncampaign

campaign the session belongs to

Stringoptional
Imageimage

image representing the session

Fileoptional
Captioncaption

caption of the image

Stringoptional
IRL Dateirldate

the IRL date the session was played

Example
{{Convert Date|01-24-1994|IRL}}
Templateoptional
Game Dategamedate

the in-game date the session started on

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

list of characters that played the session

Example
{{hlist|[[Player1]]|[[Player2]]}}
Templateoptional
NPCsnpcs

list of notable NPCs from the session

Example
{{hlist|[[NPC1]]|[[NPC2]]}}
Templateoptional
Locationslocations

list of notable locations from the session

Example
{{hlist|[[Location1]]|[[Location2]]}}
Templateoptional
Previous Sessionprevioussession

link to the previous session from an in-game perspective

Page nameoptional
Next Sessionnextsession

link to the next session from an in-game perspective

Page nameoptional
Settingsetting

link to the setting page

Page nameoptional