Template:VoiceLineCite/doc: Difference between revisions

No edit summary
updated with quotes link
 
(7 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|name=hero_name|quotes=Hero/Quotes|transcription=transcription}}</nowiki>


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


There's an optional parameter to change the quote suffix and one to add extra context to the line.
There's an optional parameter to change the possessive suffix and one to add extra context to the line.


==Example usages==
==Example usages==
Example:
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:
 
{{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>
  <nowiki>{{VoiceLineCite|name=Lash|file=Lash kill wraith 02.mp3|context=(killed Wraith)|transcription=Backed the wrong horse, Wraith. Like always.}}</nowiki>
Result:
Result:
Line 14: Line 23:




Example where the png icon for Amber Hand doesn't exist:
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=Amber Hand|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}</nowiki>
  <nowiki>{{VoiceLineCite|name=Lash|no_pageref_file=true|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}</nowiki>


Result:
Result:


{{VoiceLineCite|name=Amber Hand|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}
{{VoiceLineCite|name=Lash|no_pageref_file=true|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}




Line 28: Line 37:


{{VoiceLineCite|name=Abrams|suffix='|file=Abrams select 01.mp3|transcription=Don't worry, I'm on the case.}}
{{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.}}


<templatedata>
<templatedata>
Line 37: Line 63:
],
],
             "type": "string",
             "type": "string",
"description": "The name of the character who the voice line belongs",
"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": {
         "suffix": {
             "type": "string",
             "type": "string",
             "description": "Optional suffix change for characters whose name ends with 's'",
             "description": "Possessive suffix change for characters whose name ends with 's'",
             "required": false
             "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": {
             "type": "string",
             "type": "string",
"description": "The name of the uploaded voice-line sound file (must include the file extension eg. .mp3)",
"description": "The name of the uploaded voice line sound file (must include the file extension eg. .mp3) (use this or ''quotes'', not both)",
"required": true
"required": false
},  
},  
         "context": {
         "context": {
Line 59: Line 100:
"description": "The transcription of the voice line (without quotation marks)",
"description": "The transcription of the voice line (without quotation marks)",
             "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": [
"name",
"name",
        "alt_name",
        "alt_link",
         "suffix",
         "suffix",
        "quotes",
"file",
"file",
         "context",
         "context",
"transcription"
"transcription",
        "no_pageref_file"
]
]
}
}
</templatedata><noinclude>[[Category:Template documentation]]</noinclude>
</templatedata><noinclude>[[Category:Template documentation]]</noinclude>