Template:VoiceLineCite/doc: Difference between revisions

Browse history interactively

← Older edit

VisualWikitext

@@ Line 2: / Line 2: @@
 This template can be used to reference in-game voice lines.
-  <nowiki>{{VoiceLineCite|hero=hero_name|file=file_name.extension|transcription=transcription}}</nowiki>
+  <nowiki>{{VoiceLineCite|name=hero_name|file=file_name.extension|transcription=transcription}}</nowiki>
-==Example usage==
+There's an optional parameter to change the possessive suffix and one to add extra context to the line.
+==Example usages==
 Example:
-  <nowiki>{{VoiceLineCite|hero=Lash|file=Lash kill wraith 02.mp3|transcription=Back 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:
-{{VoiceLineCite|hero=Lash|file=Lash kill wraith 02.mp3|transcription=Back the wrong horse, Wraith. Like always.}}
+{{VoiceLineCite|name=Lash|file=Lash kill wraith 02.mp3|context=(killed Wraith)|transcription=Backed the wrong horse, Wraith. Like always.}}
+Example where the png icon for Amber Hand doesn't exist:
+ <nowiki>{{VoiceLineCite|name=Amber Hand|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}</nowiki>
+Result:
+{{VoiceLineCite|name=Amber Hand|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}
+This can be handled by passing the parameter ''no_pageref_file=true''.
+ <nowiki>{{VoiceLineCite|name=Amber Hand|no_pageref_file=true|file=Lash kill wraith 02.mp3|transcription=Backed the wrong horse, Wraith. Like always.}}</nowiki>
+Result:
+{{VoiceLineCite|name=Amber Hand|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.}}
 <templatedata>
 {
 	"params": {
-		"hero": {
+		"name": {
 "aliases": [
 				"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
 		},
+        "suffix": {
+            "type": "string",
+            "description": "Possessive suffix change for characters whose name ends with 's'",
+            "required": false
+        },
 		"file": {
+            "type": "string",
 			"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": {
-			"description": "The transcription of the voice line",
+            "type": "string",
+			"description": "The transcription of the voice line (without quotation marks)",
              "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",
-	"paramOrder": [
+    "paramOrder": [
-		"hero",
+		"name",
+        "suffix",
 		"file",
-		"transcription"
+        "context",
+		"transcription",
+        "no_pageref_file"
 	]
 }
 </templatedata><noinclude>[[Category:Template documentation]]</noinclude>