The first video in the TASBot Re: (TASBot Revisited) series is out! TASBot Re: Gradius covers our first run from AGDQ 2014.

Historians wanted: Inquire here.

Template:Format run data: Difference between revisions

Template page
(Fix missing })
Tag: 2017 source edit
m (Leave note re: spaces in id attr)
 
(48 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<onlyinclude><includeonly>{{#switch:{{{2|}}}
<onlyinclude><includeonly>{{fail|{{PAGENAME}}|transclude one of the subpages instead of this}}</includeonly></onlyinclude>


|ALttP={{{{{1|showcase}}}
This is not a template; rather, it serves as documentation and a common parent for a set of related templates, which are listed below.
|anchor={{{2}}}
These templates hold [[metawikimedia:Help:Array|data]] about the various runs showcased by TASBot and friends.
|appearance=magFAST 2023
They need to be paired with a "callback" template for formatting. See any child page for usage docs.
|author={{TASVideosU|fmp}}, {{TASVideosU|Yuzuhara_3}}
|game-name=Legend of Zelda: A Link to the Past
|game-pub-year=1991
|lead=[[dwangoAC]], Dom
|platform={{TASVideos|/Platforms#SuperNintendoEntertainmentSystemSuperFamicom|SNES}}
|presenter=dwangoAC, DK Adventure
|recording=
|run-branch=Full Inventory
|tasvideos-game=191
|tasvideos-movie-template=TASVideosM
|tasvideos-movie-value=3874
}}


|Gradius Any={{{{{1|showcase}}}
Known runs:
|anchor={{{2}}}
{{Special:PrefixIndex/Template:Format_run_data/}}
|appearance=AGDQ 2014
<!-- we may want [[mw:Extension:SubPageList]] to customise how the list is formatted -->
|author= {{TASVideosU|Adelikat}}
|game-name=Gradius
|game-pub-year=1985
|lead=[[dwangoAC]]
|platform={{TASVideos|/Platforms#NintendoEntertainmentSystemFamicom|NES}}
|presenter=dwangoAC, {{TASVideosU|micro500}}, {{TASVideosU|Weatherton}}, {{TASVideosU|TheGreekBrit}}
|recording={{YouTube video|Tx5U_bh2uIk|TASBot HD (YouTube)}}, {{YouTube video|Uep1H_NvZS0|TASVideos (YouTube)}}, {{YouTube video|1=RhgSSmBwNf8&time_continue=793|2=GDQ (YouTube)}}, [https://archive.org/search?query=ADGQ2014_Gradius_1080p.mp4 GDQ original (Archive.org)]
|run-branch=Any%
|tasvideos-game=21
|tasvideos-movie-template=TASVideosM
|tasvideos-movie-value=711
}}


|MK64 Special Cup={{{{{1|showcase}}}
Besides the default {{t|showcase}}, there are a couple of other formatter templates for niche use cases:
|anchor={{{2}}}
* [[Runs/row]]
|appearance=AGDQ 2014
* {{t|format run data meta/run name}}
|author={{TASVideosU|Weatherton}}
|game-name=Mario Kart 64
|game-pub-year=1997
|lead={{TASVideosU|Weatherton}}, [[dwangoAC]]
|platform={{TASVideos|/Platforms#Nintendo64|N64}}
|presenter=dwangoAC, {{TASVideosU|micro500}}, {{TASVideosU|Weatherton}},{{TASVideosU|TheGreekBrit}
|recording={{YouTube video|Uep1H_NvZS0|TASVideos (YouTube)}}, {{YouTube video|1=RhgSSmBwNf8&time_continue=1020|2=GDQ (YouTube)}}
|run-branch=Special Cup
|tasvideos-game=921
|tasvideos-movie-template=TASVideos
|tasvideos-movie-value=/1533S
}}


|Pokemon Plays Twitch={{{{{1|showcase}}}
A formatter template can make use of the following parameters:
|anchor={{{2}}}
<!-- TODO double-check data, then rewrite this to match -->
|appearance=AGDQ 2015
* <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.
|author= {{TASVideosU|p4plus2}}, {{TASVideosU|Masterjun}}, {{TASVideosU|ais523}}, dwangoAC, {{TASVideosU|Ilari}}, true,  {{TASVideosU|IheAxeMan}}, twm
|game-name=Pokemon Red
|game-pub-year=1996
|lead={TASVideosU|micro500}}, [[dwangoAC]]
|platform={{TASVideos|/Platforms#SuperNintendoEntertainmentSystemSuperFamicom|SNES}}
|presenter=dwangoAC, micro500
|recording={{YouTube video|1=P28kp66XMw4&time_continue=460|2=GDQ (YouTube)}}
|run-branch=Pokemon Plays Twitch
|tasvideos-game=16
|tasvideos-movie-template=TASVideos
|tasvideos-movie-value=UserFiles/Info/26941437923505036
}}
 
|NESBot Wizards and Warriors={{{{{1|showcase}}}
|anchor={{{2}}}
|appearance=SGDQ 2011
|author={{TASVideosU|Ferret_Warlord}}, {{TASVideosU|Dacicus}}
|game-name=Wizards &amp; Warriors III: Kuros: Visions of Power
|game-pub-year=1992
|lead=<!-- unknown -->
|platform={{TASVideos|/Platforms#NintendoEntertainmentSystemFamicom|NES}}
|presenter=[[DarkKobold]]
|recording={{YouTube video|diGBbrA0oHk|Speedgame Main Marathon History (YouTube)}}
|run-branch=any%
|tasvideos-game=189
|tasvideos-movie-template=TASVideosM
|tasvideos-movie-value=401
}}
 
|SMB1 and 2U and 2J and 3={{{{{1|showcase}}}
|anchor={{{2}}}
|appearance=SGDQ 2016
|author={{TASVideosU|agwawaf}}
|game-name=Super Mario Bros. 1, 2, LL, 3
|game-pub-year=(multiple)
|lead={{TASVideosU|micro500}}, [[dwangoAC]]
|platform={{TASVideos|/Platforms#NintendoEntertainmentSystemFamicom|NES}}
|presenter=dwangoAC, MeGotsThis, ogNdrahciR
|recording={{YouTube video|1GF_LFPz34U|TASVideos (YouTube)}}, {{YouTube video|1=EHfw-BEuRO8?time_continue=3355|2=GDQ (YouTube)}}
|run-branch=One Controller Four Games
|tasvideos-game=760
|tasvideos-movie-template=TASVideosM
|tasvideos-movie-value=2636
}}
 
|SMB3 Any={{{{{1|showcase}}}
|anchor={{{2}}}
|appearance=SGDQ 2016
|author={{TASVideosU|Masterjun}}, {{TASVideosU|ais523}}, {{TASVideosU|Lord_Tom}}, {{TASVideosU|Tompa}}, {{TASVideosU|Total}}
|game-name=Super Mario Bros. 3
|game-pub-year=1988
|lead=[[dwangoAC]]
|platform={{TASVideos|/Platforms#NintendoEntertainmentSystemFamicom|NES}}
|presenter=dwangoAC, MeGotsThis, ogNdrahciR, mitchflowerpower
|recording={{YouTube video|1GF_LFPz34U|TASVideos (YouTube)}}, {{YouTube video|1=BZPQ29NayVQ?time_continue=76|2=GDQ (YouTube)}}
|run-branch=Any%
|tasvideos-game=17
|tasvideos-movie-template=TASVideosM
|tasvideos-movie-value=4032
}}
 
|SMB3 Hot Pocket={{{{{1|showcase}}}
|anchor={{{2}}}
|appearance=SGDQ 2016
|author=mitchflowerpower
|game-name=Super Mario Bros. 3
|game-pub-year=1988
|lead={[[dwangoAC]]
|platform={{TASVideos|/Platforms#NintendoEntertainmentSystemFamicom|NES}}
|presenter=dwangoAC, MeGotsThis, ogNdrahciR, mitchflowerpower
|recording={{YouTube video|1GF_LFPz34U|TASVideos (YouTube)}}, {{YouTube video|1=BZPQ29NayVQ?time_continue=243|2=GDQ (YouTube)}}
|run-branch=Hot Pocket%
|tasvideos-game=17
|tasvideos-movie-template=TASVideosM
|tasvideos-movie-value=4032
}}
 
|SMB3 Final Kaizo={{{{{1|showcase}}}
|anchor={{{2}}}
|appearance=SGDQ 2016
|author=mitchflowerpower
|game-name=Super Mario Bros. 3
|game-pub-year=1988
|lead={[[dwangoAC]]
|platform={{TASVideos|/Platforms#NintendoEntertainmentSystemFamicom|NES}}
|presenter=dwangoAC, MeGotsThis, ogNdrahciR, mitchflowerpower
|recording={{YouTube video|1GF_LFPz34U|TASVideos (YouTube)}}, {{YouTube video|1=BZPQ29NayVQ?time_continue=381|2=GDQ (YouTube)}}
|run-branch=Final Kaizo%
|tasvideos-game=17
|tasvideos-movie-template=TASVideosM
|tasvideos-movie-value=4032
}}
 
|SML2 Memory Tour={{{{{1|showcase}}}
|anchor={{{2}}}
|appearance=SGDQ 2016
|author={{TASVideosU|link_7777}}
|game-name=Super Mario Land 2
|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=1310|2=GDQ (YouTube)}}
|run-branch=Memory Tour Showcase
|tasvideos-game=452
|tasvideos-movie-template=TASVideosUF
|tasvideos-movie-value=31714711949576163
}}
 
|SSBB={{{{{1|showcase}}}
|anchor={{{2}}}
|appearance=magFAST 2023
|author={{TASVideosU|DyllonStej}}
|game-name=Super Smash Bros. Brawl
|game-pub-year=2008
|lead=[[dwangoAC]], Dom
|platform={{TASVideos|/Platforms#Wii|Wii}}
|presenter=dwangoAC, DK Adventure
|recording=
|run-branch=any%, 1 player
|tasvideos-game=2282
|tasvideos-movie-template=TASVideosM
|tasvideos-movie-value=4514
}}
 
|Super Metroid Encode={{{{{1|showcase}}}
|anchor={{{2}}}
|appearance=AGDQ 2024
|author={{TASVideosU|Sniq}}
|game-name=Super Metroid
|game-pub-year=1994
|lead=
|platform={{TASVideos|/Platforms#SuperNintendoEntertainmentSystemSuperFamicom|SNES}}
|presenter=[[dwangoAC]], DarkXoa, Stump
|recording={{YouTube video|jkwGTu1TNzE|GDQ (YouTube)}}
|run-branch=any%
|tasvideos-game=121
|tasvideos-movie-template=TASVideosM
|tasvideos-movie-value=3653
}}
 
|VVVVVV 20 Trinkets={{{{{1|showcase}}}
|anchor={{{2}}}
|appearance=SGDQ 2016
|author={{TASVideosU|Masterjun}}, Mundungu
|game-name=VVVVVV
|game-pub-year=2010
|lead=[[dwangoAC]]
|platform={{TASVideos|/Platforms#Windows|Windows}}
|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
}}
 
|VVVVVV Game End Glitch={{{{{1|showcase}}}
|anchor={{{2}}}
|appearance=SGDQ 2016
|author={{TASVideosU|Masterjun}}, Mundungu
|game-name=VVVVVV
|game-pub-year=2010
|lead=[[dwangoAC]]
|platform={{TASVideos|/Platforms#Windows|Windows}}
|presenter=dwangoAC, Mundungu
|recording={{YouTube video|1GF_LFPz34U|TASVideos (YouTube)}}, {{YouTube video|1=EHfw-BEuRO8?time_continue=1310|2=GDQ (YouTube)}}
|run-branch=Game End Glitch
|tasvideos-game=1442
|tasvideos-movie-template=TASVideosM
|tasvideos-movie-value=2611
}}
 
|#default={{t|format run data}}: <span style="color: red;">No such run "{{{2|}}}"</span>}}</includeonly></onlyinclude>
 
Calls another template of your choosing with the data about the specified run as template arguments.
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.
For example, <code><nowiki>{{format run data|showcase|SML2 Memory Tour}}</nowiki></code> produces:
{{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=TASVideosUF
|tasvideos-movie-value=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>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>author</code>: (always present) A rich text list of the run/playaround's authors.
Line 261: Line 21:
* <code>game-pub-year</code>: (always present) The year the game was published, as plain text.
* <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>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>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.
* <code>recording</code>: (always present) A rich text list of links to videos.
Line 272: Line 32:
** in any case it should be passed on to the template specified by <code>tasvideos-movie-template</code> without processing.
** in any case it should be passed on to the template specified by <code>tasvideos-movie-template</code> without processing.


{{TemplateData preamble}}<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": {
"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>


[[Category:General-use_inline_templates]]
[[Category:General-use_block_templates]] <!-- intentionally leaving this here for discoverability -->

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}}.

Retrieved from "https://tas.bot/index.php?title=Template:Format_run_data&oldid=1553"