Template:Speaker/doc: Difference between revisions

From Guild of Archivists
mNo edit summary
(Added second parameter documentation)
Line 2: Line 2:


== Usage ==
== Usage ==
There is a single unnamed parameter. The template should be placed on its own line, just above their first line of dialogue.
The template should be placed on its own line, just above their first line of dialogue. There are two unnamed parameters; the first identifies the speaker. It can be used by itself to produce the following markup:


{{markup
{{markup
Line 10: Line 10:
|{{Speaker|Atrus}}I realized the moment I fell into the Fissure that the Book would not be destroyed as I had planned.}}
|{{Speaker|Atrus}}I realized the moment I fell into the Fissure that the Book would not be destroyed as I had planned.}}
<!-- The markup template does some weird extra formatting on the template, wrapping it in a <p> tag, if it's on its own line. I know the code here doesn't replicate the proper usage, but proper usage creates an unwanted gap that doesn't actually appear in normal usage. tl;dr: don't add a line break to this code block, but *do* add one when using the template normally. -->
<!-- The markup template does some weird extra formatting on the template, wrapping it in a <p> tag, if it's on its own line. I know the code here doesn't replicate the proper usage, but proper usage creates an unwanted gap that doesn't actually appear in normal usage. tl;dr: don't add a line break to this code block, but *do* add one when using the template normally. -->
The second parameter identifies the person the speaker is addressing. This parameter can be left off if there is no direct subject (such as in an opening voiceover), or if the player is the only subject for the entire "conversation".
{{markup
|<nowiki>{{Speaker|Gehn|Atrus}}
Father? I am no longer your father, because you are no longer my son!</nowiki>
|{{Speaker|Gehn|Atrus}}Father? I am no longer your father, because you are no longer my son!}}

Revision as of 17:08, 15 May 2018

The {{Speaker}} template should be used to identify the speaker of a line of dialogue. This template is intended to be used primarily in Dialogue reference material.

Usage

The template should be placed on its own line, just above their first line of dialogue. There are two unnamed parameters; the first identifies the speaker. It can be used by itself to produce the following markup:

Markup Renders as
{{Speaker|Atrus}}
I realized the moment I fell into the Fissure that the Book would not be destroyed as I had planned. 
[Atrus]
I realized the moment I fell into the Fissure that the Book would not be destroyed as I had planned.

The second parameter identifies the person the speaker is addressing. This parameter can be left off if there is no direct subject (such as in an opening voiceover), or if the player is the only subject for the entire "conversation".

Markup Renders as
{{Speaker|Gehn|Atrus}}
Father? I am no longer your father, because you are no longer my son! 
[Gehn] (to Atrus)
Father? I am no longer your father, because you are no longer my son!