View source for Template:Dialogue/doc

{{documentation subpage}}

 {<nowiki/>{'''Dialogue'''|&lt;nowiki>
 ...
 &lt;/nowiki>}}

This template formats quest or NPC dialogue in a presentable manner.
{{clear}}
==Syntax==
For the most part, dialogue can be copied and pasted directly from the in-game chat log into this template with no additional formatting. Wikitext can be added for words rendered in italics and for other purposes, and there is some additional syntax for various other features.

Each dialogue box must be on a single line; for dialogue boxes with line breaks, use <code>&lt;br></code> instead.

{{Dialogue/example|<nowiki>
Alphinaud: Lorem
Alisaie: ''Ipsum''<br>Dolor
</nowiki>}}

Wrapping the input in a nowiki tag is required. This nowiki tag doesn't actually prevent wikitext in dialogue from being rendered, like a normal nowiki tag would; it is specially handled by the underlying module in order to enable processing of custom syntax on top of normal wikitext.

===Speakers===
A colon separates the speaker from the rest of a message. By default, each speaker name will be linked to its wiki page. If you want to change the target of the link, or not have it link, use the following:
*Change target of the link: <code>Target of link@Speaker name in game</code>
*No link: <code>x@Speaker name in game</code>.

{{Dialogue/example|<nowiki>
Alphinaud@Smart Elezen Teenager: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
x@Imposing Sign: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
</nowiki>}}

For backwards-compatibility with an old dialogue format the wiki previously used, wikitext bold markers (<code><nowiki>'''</nowiki></code>) surrounding the speaker section will be discarded. Do not rely on this behavior; support will be removed in the future.

{{Dialogue/example|collapse=y|<nowiki>
'''Alphinaud''': This works!
'''Alisaie:''' This also works! Please don't use either of these on purpose though!
</nowiki>}}

====System speakers====
Certain speaker names are special and are used to display non-dialogue text such as system messages. These are:
* "System" for system messages that appear in the chat log.
* "Popup" for pop-up/fly-in messages that appear during duties and certain in-world events, e.g. when a quest spawns enemies which must be defeated to progress. This should be used for both the old style and the new red gimmick text introduced in Dawntrail.
** This style is visually identical to "System" at the moment, but its style will change in the future.
* "Question" for a prompt given when the player has a choice to make.

{{Dialogue/example|<nowiki>
System: This is a system message.
Popup: This is a popup.
Question: This is a question.
Thancred: This is Thancred.
</nowiki>}}

===Placeholders===
For dialogue text which varies to reflect details about your character or progression, placeholders in square brackets can be used. Placeholders render a dotted underline, and hovering over a placeholder shows a more detailed description of what information is displayed there in-game.

Several placeholders are supported:

* <code>[Forename]</code> and <code>[Surname]</code>: Character's first or last name. Use both together when referred to by full name.
* <code>[GC Rank]</code>: Rank in the player's current grand company.
* <code>[Job]</code>: Player's current job.
* <code>[Companion]</code>: Name of the player's chocobo companion.

{{Dialogue/example|<nowiki>
Raubahn: [GC Rank] [surname], how kind of you to join us.
</nowiki>}}

===Alternate phrases===
The {{tl|alternatives}} template can be used within dialogue lines to render words phrases within a line that can vary for different players, e.g. race- or gender-specific phrases. In the future, this template will get more styling and options.

{{Dialogue/example|<nowiki>
Baderon: Someone get this {{alternatives|lad|lass}} a drink!
</nowiki>}}

===Non-dialogue lines===
Any line which doesn't contain a speaker will be rendered as normal wikitext. This can be used to add headings for different sections of a quest's dialogue (usually by journal objective), or for adding descriptions of what's happening during a cutscene. This should only be used for text which doesn't appear in-game at all.

If your markup needs to contain a colon (e.g. when including an image), you can also force the template to treat a line as raw wikitext by putting a colon (<code>:</code>) at the start of the line, with no whitespace afterwards.

{{Dialogue/example|<nowiki>
===Speak with Minfilia===
Minfilia: Thank you for speaking with me!

===Examine the crumpled letter===
:[[File:Crumpled letter icon1.png|right|thumb|The letter in question]]
''The WoL picks up a piece of paper from the table.''
System: Dear Scions...
</nowiki>}}

===Dialogue Choices===
Use <code>></code> to denote potential answers to questions. Combine this with a "Question:" line to display the prompt that's shown when the user is selecting. The responses (if present) to each answer will be shown in collapsible boxes that are collapsed by default. Once the entire section with optional responses ends, use <code>---</code> in its own line to denote the end of the section.

{{Dialogue/example|<nowiki>
Question: What will you say?
> Option A
Alphinaud: Lorem ipsum dolor sit amet
> Option B
Alphinaud: Ut enim ad minim veniam
> Option C (this does not have a unique response)
---
Alphinaud: Duis aute irure dolor
</nowiki>}}

Dialogue choices can be nested by using multiple <code>></code> to signify the level of nesting. Using <code>---</code> after nested choices "goes down" a single nesting level; use multiple as needed to escape the full stack of nested choices.

{{Dialogue/example|<nowiki>
Top level
> Option 1
Response to 1
>> 1.1
Response to 1.1
>> 1.2
Response to 1.2
> 2
Response to 2
>> 2.1
Response to 2.1
>> 2.2
Response to 2.2
---
Response to 2 continued
---
Top level continued
</nowiki>}}

===Optional Dialogue===
Use <code>-optional start</code> in its own line to denote optional dialogue. When the optional dialogue concludes, write <code>-optional end</code> in its own line.

{{Dialogue/example|<nowiki>
Alphinaud: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
Alphinaud: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Alphinaud: Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

-optional start
Alphinaud: Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
-optional end

Alisaie: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
</nowiki>}}

===Cutscenes===
Use <code>-cutscene start</code> or <code>-voiced cutscene start</code>in its own line to denote the start of a cutscene. Use <code>-cutscene end</code> in its own line to denote the end of a cutscene.

{{Dialogue/example|<nowiki>
Alphinaud: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

-voiced cutscene start
Alphinaud: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Alphinaud: Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

Alisaie: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
-cutscene end

Alphinaud: Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
</nowiki>}}

==Quest Accepted/Complete==
Put <code>-quest accepted</code> or <code>-quest complete</code> in its own line in the appropriate section of the dialogue to display a "Quest Accepted/Complete" image.

{{Dialogue/example|<nowiki>
Alphinaud: Good work. As in tradition, your next quest will begin with speaking to Wuk Lamat.

-quest complete
</nowiki>}}

<includeonly>
<!-- Template categories go here -->

</includeonly>