Template:Ep ref/doc

Description

 * This template will make it easier to add references to episodes, especially when including timecodes.

Copy/Paste Code


Dependencies

 * Module:ep ref
 * Module:Ep/Matcher
 * Module:Ep/Info
 * Module:Ep/Array
 * Module:Ep/Twitch

Parameters

 * ' and ' (optional) both function as their respective attributes in the &lt;ref&gt; tag.
 * Use quotation marks around the REFGROUP or REFNAME in the template, just like you would for a normal &lt;ref&gt; tag.
 * To invoke a named reference, just use the name (and its corresponding group, if applicable):
 * If you do not supply, then a reference name will be automatically generated in the format name="ep part start end intro more"
 * All formats for will be handled the same, so ep=1x46 is the same as ep=C1E46, and ep=Cindergrove Revisited.
 * Thus, you can simply copy/paste the same reference to other places where you want the citation to appear, and the template will automatically combine them into the same reference in the references section of the article.
 * Grouped references are considered completely separate from other groups of references. Therefore, if you are invoking a named reference that belongs to a group, then you must also include that same group in the invocation.  In other words, the following two references are completely separate from each other, even though they have the same name:
 *  is any text you want to include before the episode reference. Wikimarkup is allowed.
 *  is the episode name, number, or [campaign]x[episode] code. For example,  is "ep=1x01".  All episode formats are accepted, including ep=1x01, ep=C1E01, and ep=Arrival at Kraghammer.
 * If is left blank, then the containing page will be added to  [[:Category:Ep refs with undefined episodes ]].
 *  indicates which part of an episode you are referencing when a single episode corresponds to multiple YouTube videos. Simply use a number, such as 1 or 2 or 3.
 * START and END are timecodes for the section of the episode being referenced. They are unnamed parameters, meaning you don't need to type a parameter name.
 * START and END timecodes take the format of either "1:23:45" (hours:minutes:seconds) or "1h2m3s", as YouTube uses for their urls. All timecodes will be reformatted to display in the "1:23:45" format. '650' or '650s' is interpreted as 650 seconds. "3:45" is interpreted as 3 minutes and 45 seconds.
 * START may be used without END, and the reference text will change accordingly.
 * END cannot be used without START, because the template will interpret the END timecode as START.
 *  should rarely be used. It is a direct YouTube URL, and only applies to videos that aren't episodes.
 * This template will automatically use the YouTube URL of any episode in our database (Module:Ep/Array has all valid episode values and Module:Ep/YTURLSwitcher/URLs has all episode YouTube URLs).
 * The user-supplied URL in "vod=" will override these databases and should only be used for videos that are not episodes. If the "vod" parameter is empty, the template will retrieve the matching URL for the user-supplied "ep=" value as usual.
 * Long or short YouTube URLs will work, but they should link directly to the video (not a playlist, timecode, or channel).
 *  causes the cite tag to appear immediately after the period for the main sentence. Entering any value (such as "1" or "true", or even "0" or "false") will cause the citation tag to be applied.
 *  is any additional text that should be appended to the citation.
 *  is whether an episode title for Talks Machina or 4-Sided Dive should be truncated.
 *  is a placeholder timestamp for before YouTube VODs come out but after episodes air on Twitch. Before the VOD is released, that timestamp will link to the Twitch url (if it is in Module:Ep/Twitchoffset) with a warning that subscription is required. After the VOD is released and the offset time is calculated and added to the Twitchoffset module, it will replace the Twitch URL with a YouTube one, with an updated timestamp to reflect the offset. It will also be added to a maintenance category to indicate that the Twitch timecodes should be checked and converted to YouTube ones.

Example usage and outputs
Hover or click on the references to learn more.
 * Using all fields:
 * Nonexistent episode code:
 * Nonexistent episode name:
 * Custom episode name:
 * Seconds as lump sum:
 * '0h0m0s' timecode:
 * invalid timecode:
 * Seconds as lump sum:
 * '0h0m0s' timecode:
 * invalid timecode:

Twitch time examples
Twitch time
 * If the YouTube time is included, the twitch parameter is ignored entirely:
 * Even if the YT URL is unknown:
 * If the episode code is not in the ep/twitchoffset array, it should display an unlinked timestamp and indicate that it's on Twitch: