Template:Format run data: Difference between revisions

Latest revision as of 09:52, 3 August 2024

This is not a template; rather, it serves as documentation and a common parent for a set of related templates, which are listed below. These templates hold data about the various runs showcased by TASBot and friends. They need to be paired with a "callback" template for formatting. See any child page for usage docs.

Known runs:

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|{{PAGENAME}}|transclude one of the subpages instead of this}}</includeonly></onlyinclude>
-|SML2 Memory Tour={{{{{1|showcase}}}
-	|appearance-page=[[SGDQ 2016]]
+This is not a template; rather, it serves as documentation and a common parent for a set of related templates, which are listed below.
-	|run={{TASVideos|/Userfiles/Info/31714711949576163|Super Mario Land 2 Memory Tour Showcase}}
+These templates hold [[metawikimedia:Help:Array|data]] about the various runs showcased by TASBot and friends.
-	|run-branch-short=Memory Tour
+They need to be paired with a "callback" template for formatting. See any child page for usage docs.
-	|game={{TASVideosG|452|Super Mario Land 2}}
-	|game-pub-year=1992
+Known runs:
-	|platform={{TASVideos|/Platforms#GameBoy|Game Boy}}
+{{Special:PrefixIndex/Template:Format_run_data/}}
-	|author={{TASVideosU|link_7777}}
+<!-- we may want [[mw:Extension:SubPageList]] to customise how the list is formatted -->
-	|presenter=dwangoAC, link_7777
-	|recording={{YouTube video|1GF_LFPz34U|TASVideos (YouTube)}}, {{YouTube video|1=EHfw-BEuRO8?time_continue=429|2=GDQ (YouTube)}}
+Besides the default {{t|showcase}}, there are a couple of other formatter templates for niche use cases:
-	|lead=[[dwangoAC]]
+* [[Runs/row]]
-}}
+* {{t|format run data meta/run name}}
-VVVVVV={{{{{1|showcase}}}
-	|appearance-page=[[SGDQ 2016]]
+A formatter template can make use of the following parameters:
-	|game={{TASVideosG|1442|VVVVVV}}
+<!-- TODO double-check data, then rewrite this to match -->
-	|game-pub-year=2010
+* <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.
-	|platform=PC
+* <code>appearance</code>: (always present) The name of the relevant event appearance page, or the name of a redirect to it.
-	|run={{TASVideosM|2715|VVVVVV 20 Trinkets, No Death}}
+* <code>author</code>: (always present) A rich text list of the run/playaround's authors.
-	|run-branch-short=20 Trinkets, No Death
+* <code>game-name</code>: (always present) The full name of the game, as plain text.
-	|author={{TASVideosU|Masterjun}}, Mundungu
+* <code>game-pub-year</code>: (always present) The year the game was published, as plain text.
-	|presenter=dwangoAC, Mundungu
+* <code>lead</code>: (always present) A rich text list of the people who oversaw the presentation at the event.
-	|recording={{YouTube video|1GF_LFPz34U|TASVideos (YouTube)}}, {{YouTube video|1=EHfw-BEuRO8?time_continue=1310|2=GDQ (YouTube)}}
+* <code>platform</code>: (always present) The mnemonic of the system/platform the game is for (follows BizHawk; see {{t|TASVideosPF}} for details).
-	|lead=[[dwangoAC]]
+* <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.
-|{{t|format run data}}: <span style="color: red;">no such run "{{{2|}}}"</span>}}</includeonly></onlyinclude>
+* <code>run-branch</code>: (always present) The 'branch' or 'goal' of the run, e.g. <q>100%</q>, <q>credits warp</q>, <q>playaround</q>.
+* <code>tasvideos-game</code>: (always present) The game's ID on TASVideos (without the 'G' suffix).
+* <code>tasvideos-movie-template</code>: (always present) The name of one of the {{t|TASVideos}} family of templates, e.g. <code>TASVideosM</code>.
+* <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);
+** in any case it should be passed on to the template specified by <code>tasvideos-movie-template</code> without processing.
+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}}.
+[[Category:General-use_block_templates]] <!-- intentionally leaving this here for discoverability -->