Template:Format run data: Difference between revisions

Revision as of 19:16, 25 November 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.

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}}. Known runs:

@@ Line 4: / Line 4: @@
 These 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.
-Known runs:
-{{Special:PrefixIndex/Template:Format_run_data/}}
-<!-- we may want [[mw:Extension:SubPageList]] to customise how the list is formatted -->
 Besides the default {{t|showcase}}, there are a couple of other formatter templates for niche use cases:
@@ Line 34: / Line 30: @@
 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}}.
+Known runs:
+{{Special:PrefixIndex/Template:Format_run_data/}}
+<!-- we may want [[mw:Extension:SubPageList]] to customise how the list is formatted -->
 [[Category:General-use_block_templates]] <!-- intentionally leaving this here for discoverability -->