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>{{fail|{{PAGENAME}}|transclude one of the subpages instead of this}}</includeonly></onlyinclude>
+<onlyinclude><includeonly>{{fail|format run data|transclude one of the subpages instead of this}}</includeonly></onlyinclude>
-This is not a template; rather, it serves as documentation and a common parent for a set of related templates, which are listed below.
+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}}.
-These templates hold [[metawikimedia:Help:Array|data]] about the various runs showcased by TASBot and friends.
+<br>These child templates hold [[metawikimedia:Help:Array|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.
+A separate "callback" template handles the formatting, and that template needs to be specified by name (or left blank).
+<br>Each child template has a copy of usage docs&mdash;<!--
+-->visit any of them for instructions on how to make use of the data in an article.
-Known runs:
+Known runs (click <q>Expand</q>):
+<div class="mw-collapsible mw-collapsed">
 {{Special:PrefixIndex/Template:Format_run_data/}}
 <!-- we may want [[mw:Extension:SubPageList]] to customise how the list is formatted -->
+</div>
+<br><hr>
 Besides the default {{t|showcase}}, there are a couple of other formatter templates for niche use cases:
@@ Line 15: / Line 20: @@
 A formatter template can make use of the following parameters:
 <!-- TODO double-check data, then rewrite this to match -->
-* <code>anchor</code>: (always present) The same as the page name (spaces, not underscores). The intention is to also use this as a section <code>id</code>/anchor, as {{t|showcase}} does.
+* <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.
 * <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.
@@ Line 29: / 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.