Template:VoiceLineCite/doc: Difference between revisions

No edit summary
updated with quotes link
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Usage==
==Usage==
This template can be used to reference in-game voice lines.
This template can be used to reference in-game voice lines. The template can link to either a "quotes" page or a voice line file.


  <nowiki>{{VoiceLineCite|1=hero_name|file=file_name.extension|transcription=transcription}}</nowiki>
  <nowiki>{{VoiceLineCite|name=hero_name|quotes=Hero/Quotes|transcription=transcription}}</nowiki>


==Example usage==
<nowiki>{{VoiceLineCite|name=hero_name|file=file_name.extension|transcription=transcription}}</nowiki>
Example:
 
  <nowiki>{{VoiceLineCite|1=Lash|file=Lash kill wraith 02.mp3|transcription=Back the wrong horse, Wraith. Like always.}}</nowiki>
There's an optional parameter to change the possessive suffix and one to add extra context to the line.
 
==Example usages==
Example using quotes link:
  <nowiki>{{VoiceLineCite|name=Lash|quotes=Lash/Quotes#Hero-Specific Voice Lines|context=(killed Wraith)|transcription=Backed the wrong horse, Wraith. Like always.}}</nowiki>
Result:
Result:


{{VoiceLineCite|1=Lash|file=Lash kill wraith 02.mp3|transcription=Back the wrong horse, Wraith. Like always.}}
{{VoiceLineCite|name=Lash|quotes=Lash/Quotes#Hero-Specific Voice Lines|context=(killed Wraith)|transcription=Backed the wrong horse, Wraith. Like always.}}
 
 
Example using file link:
<nowiki>{{VoiceLineCite|name=Lash|file=Lash kill wraith 02.mp3|context=(killed Wraith)|transcription=Backed the wrong horse, Wraith. Like always.}}</nowiki>
Result:
 
{{VoiceLineCite|name=Lash|file=Lash kill wraith 02.mp3|context=(killed Wraith)|transcription=Backed the wrong horse, Wraith. Like always.}}
 
 
To remove the icon file (note: in most common cases of pages without icons, this is already handled as exceptions by the template itself):
<nowiki>{{VoiceLineCite|name=Lash|no_pageref_file=true|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}</nowiki>
 
Result:
 
{{VoiceLineCite|name=Lash|no_pageref_file=true|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}
 
 
Example of suffix change:
<nowiki>{{VoiceLineCite|name=Abrams|suffix='|file=Abrams select 01.mp3|transcription=Don't worry, I'm on the case.}}</nowiki>
 
Result:
 
{{VoiceLineCite|name=Abrams|suffix='|file=Abrams select 01.mp3|transcription=Don't worry, I'm on the case.}}
 
 
Example of alt name:
<nowiki>{{VoiceLineCite|name=Lash|alt_name=Jacob|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}</nowiki>
 
Result:
 
{{VoiceLineCite|name=Lash|alt_name=Jacob|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}
 
 
Example of alt link:
<nowiki>{{VoiceLineCite|name=Lash|alt_link=Abrams|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}</nowiki>
 
Result:
 
{{VoiceLineCite|name=Lash|alt_link=Abrams|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}




Line 15: Line 58:
{
{
"params": {
"params": {
"hero": {
"name": {
"aliases": [
"aliases": [
"1"
"1"
],
],
"description": "The name of the hero who the voice line belongs",
            "type": "string",
"description": "The name of the character to whom the voice line belongs",
"required": true
"required": true
},
},
        "alt_name": {
            "type": "string",
            "description": "Display a different name",
            "required": false
        },
        "alt_link": {
            "type": "string",
            "description": "Link to a different page",
            "required": false
        },
        "suffix": {
            "type": "string",
            "description": "Possessive suffix change for characters whose name ends with 's'",
            "required": false
        },
        "quotes": {
            "type": "string",
"description": "Link to a character ''quotes'' page, preferably including the section header of the relevant quote (use this or ''file'', not both)",
"required": false
},
"file": {
"file": {
"aliases": [
            "type": "string",
"2"
"description": "The name of the uploaded voice line sound file (must include the file extension eg. .mp3) (use this or ''quotes'', not both)",
],
"required": false
"description": "The name of the uploaded voice-line sound file (must include the file extension eg. .mp3)",
},
"required": true
        "context": {
},
            "type": "string",
            "description": "Additional context to the line",
            "required": false
        },
"transcription": {
"transcription": {
"aliases": [
            "type": "string",
"3"
"description": "The transcription of the voice line (without quotation marks)",
],
"description": "The transcription of the voice line",
             "required": true
             "required": true
}
},
        "no_pageref_file": {
            "type": "string",
            "description": "Tells [[Template:PageRef]] to not use the icon file. Note that passing ''false'' does not work, the parameter must then be ommitted.",
            "required": false,
            "example": "true"
        }
},
},
"format": "inline",
"format": "inline",
"paramOrder": [
    "paramOrder": [
"hero",
"name",
        "alt_name",
        "alt_link",
        "suffix",
        "quotes",
"file",
"file",
"transcription"
        "context",
"transcription",
        "no_pageref_file"
]
]
}
}
</templatedata><noinclude>[[Category:Template documentation]]</noinclude>
</templatedata><noinclude>[[Category:Template documentation]]</noinclude>