Template:VoiceLineCite/doc: Difference between revisions

From The Deadlock Wiki
Jump to navigation Jump to search
Sur (talk | contribs)
m no_pageref_file
updated with quotes link
 
(3 intermediate revisions by the same user 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>
Line 7: Line 9:


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




This can be handled by passing the parameter ''no_pageref_file=true''.
Example of alt name:
  <nowiki>{{VoiceLineCite|name=Amber Hand|no_pageref_file=true|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}</nowiki>
  <nowiki>{{VoiceLineCite|name=Lash|alt_name=Jacob|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}</nowiki>


Result:
Result:


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




Example of suffix change:
Example of alt link:
  <nowiki>{{VoiceLineCite|name=Abrams|suffix='|file=Abrams select 01.mp3|transcription=Don't worry, I'm on the case.}}</nowiki>
  <nowiki>{{VoiceLineCite|name=Lash|alt_link=Abrams|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}</nowiki>


Result:
Result:


{{VoiceLineCite|name=Abrams|suffix='|file=Abrams select 01.mp3|transcription=Don't worry, I'm on the case.}}
{{VoiceLineCite|name=Lash|alt_link=Abrams|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}
 


<templatedata>
<templatedata>
Line 48: Line 66:
"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",
Line 53: Line 81:
             "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 78: Line 111:
     "paramOrder": [
     "paramOrder": [
"name",
"name",
        "alt_name",
        "alt_link",
         "suffix",
         "suffix",
        "quotes",
"file",
"file",
         "context",
         "context",

Latest revision as of 22:34, 12 September 2025

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.

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

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

Example usages

[edit source]

Example using quotes link:

{{VoiceLineCite|name=Lash|quotes=Lash/Quotes#Hero-Specific Voice Lines|context=(killed Wraith)|transcription=Backed the wrong horse, Wraith. Like always.}}

Result:

Lash's in-game voice line (killed Wraith) - "Backed the wrong horse, Wraith. Like always."


Example using file link:

{{VoiceLineCite|name=Lash|file=Lash kill wraith 02.mp3|context=(killed Wraith)|transcription=Backed the wrong horse, Wraith. Like always.}}

Result:

Lash's in-game voice line (killed Wraith) - "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):

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

Result:

Lash's in-game voice line - "Backed the wrong horse, Wraith. Like always."


Example of suffix change:

{{VoiceLineCite|name=Abrams|suffix='|file=Abrams select 01.mp3|transcription=Don't worry, I'm on the case.}}

Result:

Abrams' in-game voice line - "Don't worry, I'm on the case."


Example of alt name:

{{VoiceLineCite|name=Lash|alt_name=Jacob|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}

Result:

Jacob's in-game voice line - "Backed the wrong horse, Wraith. Like always."


Example of alt link:

{{VoiceLineCite|name=Lash|alt_link=Abrams|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}

Result:

Lash's in-game voice line - "Backed the wrong horse, Wraith. Like always."


No description.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
namename 1

The name of the character to whom the voice line belongs

Stringrequired
alt_namealt_name

Display a different name

Stringoptional
alt_linkalt_link

Link to a different page

Stringoptional
suffixsuffix

Possessive suffix change for characters whose name ends with 's'

Stringoptional
quotesquotes

Link to a character ''quotes'' page, preferably including the section header of the relevant quote (use this or ''file'', not both)

Stringoptional
filefile

The name of the uploaded voice line sound file (must include the file extension eg. .mp3) (use this or ''quotes'', not both)

Stringoptional
contextcontext

Additional context to the line

Stringoptional
transcriptiontranscription

The transcription of the voice line (without quotation marks)

Stringrequired
no_pageref_fileno_pageref_file

Tells [[Template:PageRef]] to not use the icon file. Note that passing ''false'' does not work, the parameter must then be ommitted.

Example
true
Stringoptional