Template:Format run data: Difference between revisions

Latest revision as of 21:02, 25 November 2024

This is not a template; rather, it serves as a common parent for a set of related templates, for example {{format run data/Brain Age}}, {{format run data/Pokemon Plays Twitch}}, and {{format run data/Triforce percent ESA Summer 2022}}.
These child templates hold data about the various runs showcased by TASBot and friends. A separate "callback" template handles the formatting, and that template needs to be specified by name (or left blank).
Each child template has a copy of usage docs—visit any of them for instructions on how to make use of the data in an article.

Known runs (click Expand):

Besides the default {{showcase}}, there are a couple of other formatter templates for niche use cases:

A formatter template can make use of the following parameters:

anchor: (always present) The same as the page name (spaces, not underscores). The intention is to also use this as a section id/anchor, as {{showcase}} does.
appearance: (always present) The name of the relevant event appearance page, or the name of a redirect to it.
author: (always present) A rich text list of the run/playaround's authors.
game-name: (always present) The full name of the game, as plain text.
game-pub-year: (always present) The year the game was published, as plain text.
lead: (always present) A rich text list of the people who oversaw the presentation at the event.
platform: (always present) The mnemonic of the system/platform the game is for (follows BizHawk; see {{TASVideosPF}} for details).
presenter: (always present) A rich text list of the people who presented at the event.
recording: (always present) A rich text list of links to videos.
run-branch: (always present) The 'branch' or 'goal' of the run, e.g. 100%, credits warp, playaround.
tasvideos-game: (always present) The game's ID on TASVideos (without the 'G' suffix).
tasvideos-movie-template: (always present) The name of one of the {{TASVideos}} family of templates, e.g. TASVideosM.
tasvideos-movie-value: (always present) Depending on the value of tasvideos-movie-template:
- when it's {{TASVideosM}}, this is the run's publication ID on TASVideos (without the 'M' suffix);
- when it's {{TASVideos}}, this is the relative URI of some page on TASVideos that pertains to this run (i.e. without the https://tasvideos.org prefix);
- in any case it should be passed on to the template specified by tasvideos-movie-template without processing.

The child templates all call {{format run data meta/base template}} as a single-source-of-truth, should we want to change something later. Their documentation is generated with {{format run data meta/template docs page}}.

@@ Line 1: / Line 1: @@
-<onlyinclude><includeonly>{{#switch:{{{2|}}}
+<onlyinclude><includeonly>{{fail|format run data|transclude one of the subpages instead of this}}</includeonly></onlyinclude>
-|SML2 Memory Tour={{{{{1|showcase}}}
+This is not a template; rather, it serves as a common parent for a set of related templates, for example {{t|format run data/Brain Age}}, {{t|format run data/Pokemon Plays Twitch}}, and {{t|format run data/Triforce percent ESA Summer 2022}}.
-	|anchor={{{2}}}
+<br>These child templates hold [[metawikimedia:Help:Array|data]] about the various runs showcased by TASBot and friends.
-	|appearance=SGDQ 2016
+A separate "callback" template handles the formatting, and that template needs to be specified by name (or left blank).
-	|author={{TASVideosU|link_7777}}
+<br>Each child template has a copy of usage docs&mdash;<!--
-	|game-name=Super Mario Land 2
+-->visit any of them for instructions on how to make use of the data in an article.
-	|game-pub-year=1992
-	|lead=[[dwangoAC]]
-	|platform={{TASVideos|/Platforms#GameBoy|Game Boy}}
-	|presenter=dwangoAC, link_7777
-	|recording={{YouTube video|1GF_LFPz34U|TASVideos (YouTube)}}, {{YouTube video|1=EHfw-BEuRO8?time_continue=429|2=GDQ (YouTube)}}
-	|run-branch=Memory Tour Showcase
-	|tasvideos-game=452
-	|tasvideos-movie-template=TASVideos
-	|tasvideos-movie-value=/Userfiles/Info/31714711949576163
-}}
-|VVVVVV={{{{{1|showcase}}}
+Known runs (click <q>Expand</q>):
-	|anchor={{{2}}}
+<div class="mw-collapsible mw-collapsed">
-	|appearance=SGDQ 2016
+{{Special:PrefixIndex/Template:Format_run_data/}}
-	|author={{TASVideosU|Masterjun}}, Mundungu
+<!-- we may want [[mw:Extension:SubPageList]] to customise how the list is formatted -->
-	|game-name=VVVVVV
+</div>
-	|game-pub-year=2010
+<br><hr>
-	|lead=[[dwangoAC]]
-	|platform=PC
-	|presenter=dwangoAC, Mundungu
-	|recording={{YouTube video|1GF_LFPz34U|TASVideos (YouTube)}}, {{YouTube video|1=EHfw-BEuRO8?time_continue=1310|2=GDQ (YouTube)}}
-	|run-branch=20 Trinkets, No Death
-	|tasvideos-game=1442
-	|tasvideos-movie-template=TASVideosM
-	|tasvideos-movie-value=2715
-}}
-|#default={{t|format run data}}: <span style="color: red;">No such run "{{{2|}}}"</span>}}</includeonly></onlyinclude>
+Besides the default {{t|showcase}}, there are a couple of other formatter templates for niche use cases:
+* [[Runs/row]]
+* {{t|format run data meta/run name}}
-Calls another template of your choosing with the data about the specified run as template arguments.
+A formatter template can make use of the following parameters:
-The first parameter to this template is the name of the template to call, and the second is the ID of the run to look up.
+<!-- TODO double-check data, then rewrite this to match -->
-For example, <code><nowiki>{{format run data|showcase|SML2 Memory Tour}}</nowiki></code> produces:
+* <code>anchor</code>: (always present) The same as the page name (spaces, not underscores).<!-- this does work, though I can't see how --> The intention is to also use this as a section <code>id</code>/anchor, as {{t|showcase}} does.
-{{format run data|showcase|SML2 Memory Tour}}
-...equivalent to this call:
-<pre><nowiki>
-{{showcase
-|anchor=SML2 Memory Tour
-|author={{TASVideosU|link_7777}}
-|game-name=Super Mario Land 2
-|lead=[[dwangoAC]]
-|platform={{TASVideos|/Platforms#GameBoy|Game Boy}}
-|presenter=dwangoAC, link_7777
-|recording={{YouTube video|1GF_LFPz34U|TASVideos (YouTube)}}, {{YouTube video|1=EHfw-BEuRO8?time_continue=429|2=GDQ (YouTube)}}
-|run-branch=Memory Tour Showcase
-|tasvideos-game=452
-|tasvideos-movie-template=TASVideos
-|tasvideos-movie-value=/Userfiles/Info/31714711949576163
-}}
-</nowiki></pre>
-This page holds only the [[metawikimedia:Help:Array|data]]; the specified template (can be in any namespace) must provide the "implementation".
-Passing e.g. <code>:Page/subpage</code> as the first argument will transclude a main namespace article, as per usual.
-You can also omit it e.g. <code><nowiki>{{format run data|2=SML2 Memory Tour}}</nowiki></code> and it will default to calling {{t|showcase}}.
-(Omitting the second argument will produce an error, exactly as if you had passed a nonexistent ID.)
-The "callback" template can make use of the following parameters:
-* <code>anchor</code>: (always present) The same ID passed to this template for the lookup. The intention is to use the same ID as a section anchor, as {{t|showcase}} does.
 * <code>appearance</code>: (always present) The name of the relevant event appearance page, or the name of a redirect to it.
 * <code>author</code>: (always present) A rich text list of the run/playaround's authors.
-* <code>game-name</code>: (always present) The full name of the game.
+* <code>game-name</code>: (always present) The full name of the game, as plain text.
-* <code>game-pub-year</code>: (always present) The year the game was published.
+* <code>game-pub-year</code>: (always present) The year the game was published, as plain text.
 * <code>lead</code>: (always present) A rich text list of the people who oversaw the presentation at the event.
-* <code>platform</code>: (always present) The system/platform the game is for, currently as rich text.
+* <code>platform</code>: (always present) The mnemonic of the system/platform the game is for (follows BizHawk; see {{t|TASVideosPF}} for details).
 * <code>presenter</code>: (always present) A rich text list of the people who presented at the event.
 * <code>recording</code>: (always present) A rich text list of links to videos.
@@ Line 77: / Line 34: @@
 * <code>tasvideos-movie-value</code>: (always present) Depending on the value of <code>tasvideos-movie-template</code>:
 ** when it's {{t|TASVideosM}}, this is the run's publication ID on TASVideos (without the 'M' suffix);
-** when it's {{t|TASVideos}}, this is the relative URI of some page on TASVideos that pertains to this run (i.e. without the <code>https://tasvideos.org</code> prefix);
+** when it's {{t|TASVideos}}, this is the relative URI of some page on TASVideos that pertains to this run (i.e. without the <code><nowiki>https://tasvideos.org</nowiki></code> prefix);
 ** in any case it should be passed on to the template specified by <code>tasvideos-movie-template</code> without processing.
-<templatedata>
+The child templates all call {{t|format run data meta/base template}} as a single-source-of-truth, should we want to change something later.
-{
+Their documentation is generated with {{t|format run data meta/template docs page}}.
-	"params": {
-		"1": {
+[[Category:General-use_block_templates]] <!-- intentionally leaving this here for discoverability -->
-			"label": "Callback Template Name",
-			"description": "name of template or article to be transcluded with data as arguments",
-			"type": "wiki-page-name",
-			"default": "showcase",
-			"suggested": true
-		},
-		"2": {
-			"label": "Run 'Lookup' ID",
-			"description": "the string that uniquely identifies a particular presentation of a run/playaround",
-			"type": "string",
-			"required": true
-		}
-	},
-	"description": "Calls another template of your choosing with the data about the specified run as template arguments.",
-	"paramOrder": [
-		"1",
-		"2"
-	],
-	"format": "inline"
-}
-</templatedata>