Module:Hastranscript/doc

This is a documentation subpage for Module:Hastranscript. It contains usage information, categories, and other content that is not part of the original module page.

Module:Hastranscript's function main is invoked by Template:Hastranscript.

The {{Hastranscript}} template is used to indicate and link to/transclude a transcript page for any given article.

Usage

{{hastranscript|type|link}}

{{hastranscript|transclude=yes}}
{{hastranscript|page|transclude=yes}}
{{hastranscript|page1|page2|...|transclude=yes}}

Parameters

There are two forms of usage for hastranscript. The first generates a messagebox linking to the full transcript page (and that's it); this box is generated by Template:Hastranscript/t. The second will transclude the contents of the transcript page onto the current page; this should be used for shorter transcripts, generally.

Link box

• type - Optional (required if specifying link). Possible types are:
  • npc - This option also adds a link to a list of other transcripts (currently available on the wiki) the NPC speaks in; the list is populated via Template:Transcript list.
  • pet
  • quest
  • miniquest
  • event
  • item
• link - Optional. If the dialogue page is not found at Transcript:{{PAGENAME}} (which should only be the case in exceptional circumstances), used in place of the default link.

Transclusion

• transclude=yes - required to enable transclusion
• page - optional, the name of the page to transclude (without 'Transcript:'); will default to {{PAGENAME}} if not specified
  • page1, page2, ..., pageN - multiple pages to transclude, if desired

Examples

Link box

{{hastranscript}}

produces:

This article has an associated transcript page. Click here for the transcript.

{{hastranscript|npc}}

produces:

This article on an NPC has an associated dialogue page. Click here for a transcript of possible conversations with this NPC.

Transclusion

{{hastranscript|Lift manual|transclude=yes}}

produces:

Transcript:Lift manual does not exist. Please create this page or correct this query.

Template data

Show/hide template's data

The following information is used by extensions and applications, such as VisualEditor, to help users implement this template onto pages. Please ensure that it is up-to-date. This template is used to indicate and link to a dialogue page for any given article. Template parameters This template prefers inline formatting of parameters. Parameter Description Type Status 1 1 The type of article the dialogue belongs to (one of: npc, pet, quest, miniquest, event, item). When the template is transcluding, this should be the Transcript page name instead. Example npc Line optional 2 2 Link to the dialogue page if it is not Transcript:{{PAGENAME}} (this should only be needed in exceptional circumstances) Line optional transclude transclude Switch this template into transclusion mode. See documentation for details. Example yes Boolean optional