Editing Template:Dialogue/doc

{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->

This is a complex template designed to make it easy to write out lines of [[dialogue]]. '''This template ''cannot'' be <code>subst:</code>'d'''. The template can handle most standard formats of writing dialogue, and can be indented, bulleted or numbered.

{{tl|Dialogue}} facilitates the writing of [[dialogue]] in a standard format.

==Syntax==
This is how to write the template in [[wikitext]] onto your article:

<syntaxhighlight lang="wikitext">{{dialogue
|short=full
|short=full
|short=full
...
|Character|Speech
|Character|Speech
|Character|Speech
...
}}</syntaxhighlight>

These parameters are explained more fully below.

==Parameters==

'''Named parameters specify name shortcuts. They are all optional.''' They are placed at the top of the template call, like this:

<syntaxhighlight lang="wikitext">{{dialogue
|short=full
|short=full
|short=full
...</syntaxhighlight>

Name shortcuts apply to your main dialogue text. If you use a shortcut specified here for a character name, then the full name will be replaced for it.

Named parameters of the form "<code>mood1</code>", "<code>mood2</code>", "<code>mood3</code>", etc., up to "<code>mood10</code>", specify moods for the corresponding line number (e.g. "<code>mood1</code>" specifies line 1). They are placed in a line like this:

<syntaxhighlight lang="wikitext">...
|Character|Speech|mood1=angry
|Character|Speech|mood2=quiet
|Character|Speech|mood3=ecstatic
...</syntaxhighlight>

Positional parameters form the text of the dialogue (i.e. any line not containing an "<code>=</code>" will be construed as part of the dialogue.

:;<code>Parameter 1</code> ''(required)'' : Character name speaking
:;<code>Parameter 2</code> ''(optional)'' : Line to speak
:;<code>Parameter 3</code> ''(optional)'' : Next character
:;<code>Parameter 4</code> ''(optional)'' : Next line
:;<code>Parameter 5</code> ''(optional)'' : Next character
:;<code>Parameter 6</code> ''(optional)'' : Next line
:;<code>Parameter 7</code> ''(optional)'' : so on...

This extends for 10 lines at maximum. After that, unfortunately the template will have to be manually called again from the code.

Note: if any character is called "<code>action</code>" then that line will be construed as an action line. It still counts as a ''line'' nonetheless.

==Examples==
Here is an example of a full template usage:

<syntaxhighlight lang="wikitext">{{dialogue
|officer=Officer
|chicolini=Chicolini
|firefly=[[Rufus T. Firefly|Firefly]]
|officer|Chicolini, you're charged with high treason, and if found guilty, you will be shot.
|chicolini|I object.
|officer|Oh, you object? On what grounds?|mood3=derisively
|chicolini|I couldn't think of anything else to say.
|firefly|Objection sustained.|mood5=interrupting
|officer|Your Excellency, you sustained the objection?!|mood6=surprised
|firefly|Sure, I couldn't think of anything else to say, either. Why don't you object?
}}</syntaxhighlight>

The above would generate:

{{dialogue
|officer=Officer
|chicolini=Chicolini
|firefly=[[Rufus T. Firefly|Firefly]]
|officer|Chicolini, you're charged with high treason, and if found guilty, you will be shot.
|chicolini|I object.
|officer|Oh, you object? On what grounds?|mood3=derisively
|chicolini|I couldn't think of anything else to say.
|firefly|Objection sustained.|mood5=interrupting
|officer|Your Excellency, you sustained the objection?!|mood6=surprised
|firefly|Sure, I couldn't think of anything else to say, either. Why don't you object?
}}

The below code demonstrates examples of extended use:

<syntaxhighlight lang="wikitext">{{dialogue
|george=George
|rachel=Rachel

|action|Enter: George and Rachel
|george|Good morrow dearest Rachel! And what a beautiful morning it is! The sun is shining, the birds are singing in the trees, why it is enough to make one feel as if...|mood2=happy
|action|Rachel turns to see him
|rachel|Oh, George, it's you!
|george|
|rachel|Is something wrong, George?|mood6=worried
|action|Enter: Guards
|Guards|We are announcing George's arrest!
|rachel|Oh my!|mood9=horrified
|action|George is dragged away.
}}</syntaxhighlight>

The above would generate:

{{dialogue
|george=George
|rachel=Rachel

|action|Enter: George and Rachel
|george|Good morrow dearest Rachel! And what a beautiful morning it is! The sun is shining, the birds are singing in the trees, why it is enough to make one feel as if...|mood2=happy
|action|Rachel turns to see him
|rachel|Oh, George, it's you!
|george|
|rachel|Is something wrong, George?|mood6=worried
|action|Enter: Guards
|Guards|We are announcing George's arrest!
|rachel|Oh my!|mood9=horrified
|action|George is dragged away.
}}

===Notes===

You can number, bullet or indent your dialogue:

<syntaxhighlight lang="wikitext"><blockquote>{{dialogue|Alice|Hello.|Bob|Good morning!}}</blockquote></syntaxhighlight>

<blockquote>{{dialogue|Alice|Hello.|Bob|Good morning!}}</blockquote>

<syntaxhighlight lang="wikitext">#{{dialogue|Alice|Hello.|Bob|Good morning!}}
#{{dialogue|Carol|What lovely weather we're having.|Dan|I quite agree.}}</syntaxhighlight>

#{{dialogue|Alice|Hello.|Bob|Good morning!}}
#{{dialogue|Carol|What lovely weather we're having.|Dan|I quite agree.}}

<syntaxhighlight lang="wikitext">*{{dialogue
|angel=Fortitude
|angel|I am an angel!|Crowd|We don't believe you!}}
*{{dialogue
|angel=Fortitude
|angel|But I'm being quite serious!|Crowd|Too bad for you then!}}</syntaxhighlight>

*{{dialogue
|angel=Fortitude
|angel|I am an angel!|Crowd|We don't believe you!}}
*{{dialogue
|angel=Fortitude
|angel|But I'm being quite serious!|Crowd|Too bad for you then!}}

You will get the odd spacing error (e.g. "Speech<code><space></code>") if you lay out your dialogue on multiple lines. If you need 11 or more lines, you must split the template up. Otherwise you'll see this:

{{dialogue|Line 10|21=Demonstration}}

<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Quotation templates]]
<!-- ADD INTERWIKIS BELOW THIS LINE -->

</includeonly>