Template:Infobox appearance: Difference between revisions

Latest revision as of 04:09, 6 March 2024

Infobox usage: The example infobox shown on this page is the result of the following template call (modulo page name and categories):

{{infobox appearance
|event-series=Games Done Quick Express
|date=2023-10-22
|location=Las Vegas, USA [[Category:North_American_convention_appearances]]
|charities=[[The AbleGamers Foundation]]
|replay-devices=[[TAStm32]]
}}

Parameters:

name (optional): Top header text. Also used as key for prev/next lookups. Defaults to page title if omitted, though unfortunately it doesn't respect DISPLAYTITLE.
image (optional): Filename for image.
event-series (optional): Name of category page for event, omitting Category: and using spaces, not underscores.
date: The (start) date of the event, or the first day TASBot / TAS content was shown if it wasn't for the whole thing. Accepts many formats but please use YYYY-MM-DD.
end-date (optional): The end date of the event if it spanned multiple days (as with date, this should be the last day TASBot / TAS content was shown). Same big-endian format please.
location (optional): Event venue.
charities (optional): Beneficiaries of the event (can pass wikitext).
replay-devices (optional): HW/SW that was used for live TAS playback (can pass wikitext).

Using this template on a page will add that page to the relevant appearances by year category. If event-series is set, will also add it to that category.

The below documentation is automatically generated from JSON.
It can be changed by editing this page, but note that it's only the documentation (for the visual editor)—the actual template part must also be edited, manually.

An infobox for pages dedicated to event appearances/presentations, such as a speedrunning marathon in some year X.

Template parameters
This template has custom formatting.
Parameter		Description	Type	Status
Event Name	`name`	top header text, also used as key for prev/next lookups Default {{PAGENAME}} (title of containing page)	String	optional
Image	`image`	omit "File:"	File	optional
Event Series	`event-series`	name of category page for event, omitting "Category:" and using spaces, not underscores	String	suggested
(Start) Date	`date`	...of TAS content; please use YYYY-MM-DD	Date	required
End Date	`end-date`	...of TAS content; omit if same as start day; please use YYYY-MM-DD	Date	optional
Venue/Location	`location`	no description	Line	suggested
Benefiting Charities	`charities`	no description	Line	optional
Devices	`replay-devices`	no description	Line	optional
Skip categorising	`skip-cat`	no description	Unknown	deprecated

@@ Line 2: / Line 2: @@
 	<title source="name"><default>{{PAGENAME}}</default></title>
 	<image source="image" />
-	<data source="date"><label>Appeared:</label><format>{{pretty date|{{{date}}}}}</format></data><!-- TODO add `ends` parameter for date ranges -->
+	<data source="date"><label>Appeared</label><format>{{pretty date|{{{date}}}}}{{#if:{{{end-date|}}}|<br>&ndash;{{pretty date|{{{end-date}}}}}|}}</format></data>
 	<data source="location"><label>Location</label></data>
 	<data source="charities"><label>Benefiting</label></data>
-	<data source="replay-devices"><label>Replay <abbr title="hardware">HW</abbr>/<abbr title="software">SW</abbr></label></data>
+	<data source="replay-devices"><label>Devices</label></data>
-	<!-- TODO gen `<navigation/>` if `event-series` set -->
+	<navigation>{{prevnext of type|{{{name|{{PAGENAME}}}}}}}{{prevnext appearance|{{{name|{{PAGENAME}}}}}}}</navigation>
 </infobox>{{#if:{{{skip-cat|no}}}|
 {{#if:{{{event-series|}}}|[[Category:{{{event-series}}}]]|}}
 [[Category:{{#time:Y|{{{date}}}}} convention appearances]]|}}</includeonly></onlyinclude>
 {{infobox appearance
+|name=Games Done Quick Express 2023
 |event-series=Games Done Quick Express
 |date=2023-10-22
@@ Line 19: / Line 21: @@
 }}
 Infobox usage:
-The example infobox shown on this page is the result of the following template call:
+The example infobox shown on this page is the result of the following template call (modulo page name and categories):
 <pre><nowiki>
 {{infobox appearance
 |event-series=Games Done Quick Express
 |date=2023-10-22
-|location=Las Vegas, USA
+|location=Las Vegas, USA [[Category:North_American_convention_appearances]]
 |charities=[[The AbleGamers Foundation]]
 |replay-devices=[[TAStm32]]
@@ Line 31: / Line 33: @@
 Parameters:
-* <code>name</code> (optional): Top header text. Defaults to page title if omitted, though unfortunately it doesn't respect <code>DISPLAYTITLE</code>.
+* <code>name</code> (optional): Top header text. Also used as key for prev/next lookups. Defaults to page title if omitted, though unfortunately it doesn't respect <code>DISPLAYTITLE</code>.
 * <code>image</code> (optional): Filename for image.
-* <code>event-series</code> (optional): Name of category page for event, omitting <code>Category:</code>.
+* <code>event-series</code> (optional): Name of category page for event, omitting <code>Category:</code> and using spaces, not underscores.
 * <code>date</code>: The (start) date of the event, or the first day TASBot / TAS content was shown if it wasn't for the whole thing. Accepts many formats but please use <code>YYYY-MM-DD</code>.
+* <code>end-date</code> (optional): The end date of the event if it spanned multiple days (as with <code>date</code>, this should be the last day TASBot / TAS content was shown). Same big-endian format please.
 * <code>location</code> (optional): Event venue.
 * <code>charities</code> (optional): Beneficiaries of the event (can pass wikitext).
 * <code>replay-devices</code> (optional): HW/SW that was used for live TAS playback (can pass wikitext).
+Using this template on a page will add that page to the relevant [[:Category:Appearances_by_year|appearances by year]] category.
+If <code>event-series</code> is set, will also add it to that category.
+{{TemplateData preamble}}<templatedata>
+{
+	"params": {
+		"date": {
+			"label": "(Start) Date",
+			"description": "...of TAS content; please use YYYY-MM-DD",
+			"type": "date",
+			"required": true
+		},
+		"name": {
+			"label": "Event Name",
+			"description": "top header text, also used as key for prev/next lookups",
+			"type": "string",
+			"default": "{{PAGENAME}} (title of containing page)"
+		},
+		"skip-cat": {
+			"label": "Skip categorising",
+			"deprecated": "meant for use on own documentation page"
+		},
+		"event-series": {
+			"label": "Event Series",
+			"description": "name of category page for event, omitting \"Category:\" and using spaces, not underscores",
+			"type": "string",
+			"suggested": true
+		},
+		"image": {
+			"label": "Image",
+			"description": "omit \"File:\"",
+			"type": "wiki-file-name"
+		},
+		"end-date": {
+			"label": "End Date",
+			"description": "...of TAS content; omit if same as start day; please use YYYY-MM-DD",
+			"type": "date"
+		},
+		"location": {
+			"label": "Venue/Location",
+			"type": "line",
+			"suggested": true
+		},
+		"charities": {
+			"label": "Benefiting Charities",
+			"type": "line"
+		},
+		"replay-devices": {
+			"label": "Devices",
+			"type": "line"
+		}
+	},
+	"description": "An infobox for pages dedicated to event appearances/presentations, such as a speedrunning marathon in some year X.",
+	"paramOrder": [
+		"name",
+		"image",
+		"event-series",
+		"date",
+		"end-date",
+		"location",
+		"charities",
+		"replay-devices",
+		"skip-cat"
+	],
+	"format": "{{_\n|_=_\n}}\n"
+}
+</templatedata>
+[[Category:General-use_block_templates]]