Difference between revisions of "Template:Dialogue/doc"

From SpiralKnights

Jump to: navigation, search
m (Notes: casual request)
m (Notes: eh you can do this "easily" with the other format options too)
Line 75: Line 75:
 
[http://forums.spiralknights.com/en/node/107407 Forum Discussion] about this template.
 
[http://forums.spiralknights.com/en/node/107407 Forum Discussion] about this template.
  
There is probably a more elegant way to code this template regarding the what I call "chunky" number of entries (something instead of cd 1, 2, 3...20), I just don't know quite how to work that in with the flexibility we need. One option is using individual entries per character-player interaction within a space, for example, like the accessory lists. They would just use a different container, not a class=sortable. But that also has downsides, and this template simply does it for you. Most conversations are short with a single NPC. With an entry that doesn't use PAGENAME or built in default switches, the NPC's name would need to be entered each time as far as I know - not a huge problem with copypaste, but annoying to do for different conversations with different NPCs, even with easy mass text replace options. This template takes care of that with a single entry, and has flexibility if there's more than one NPC in the dialogue.
+
There is probably a more elegant way to code this template regarding the what I call "chunky" number of entries (something instead of cd 1, 2, 3...20), I just don't know quite how to work that in with the flexibility we need. One option is using individual entries per character-player interaction within a space, for example, like the accessory lists. They would just use a different container, not a class=sortable, and slightly tweak the entry behavior. But that also has downsides, and this template simply does it for you. Most conversations are short with a single NPC. With an entry that doesn't use PAGENAME or built in default switches, the NPC's name would need to be entered each time as far as I know - not a huge problem with copypaste, but annoying to do for different conversations with different NPCs, even with easy mass text replace options. This template takes care of that with a single entry, and has flexibility if there's more than one NPC in the dialogue.
:Users so far seem to like the ease of entry of the format. It's also very consistent and easy to adjust spacing in the visual conversation for all [[:Category:Dialogues|dialogues]].
+
:Users so far seem to like the ease of entry of the format.

Revision as of 16:56, 29 July 2015

Usage

To replicate the appearance of in-game dialogue. Please make dialogues on their own pages, like so: Kora Dialogue/Welcome to Haven!, with <noinclude>[[Category:Dialogues]]</noinclude> right after the last }} .

Then link to them as needed like so: {{:Kora Dialogue/Welcome to Haven!}} - this is template friendly. Have not encountered problems yet.

It is optional to hide this dialogue with Template:Dialogue/Showhide.

This way, users can:

  • Find dialogues in bulk quickly via Category:Dialogues
  • Update a dialogue that appears in more than one spot in the game/wiki right away and consistently.

Code

{{Dialogue
|location  =
|notes     =
|character = 
|cd 1 = 
|pd 1 = 
|cd 2 = 
|pd 2 = 
|cd 3 = 
|pd 3 = 
|cd 4 = 
|pd 4 = 
|cd 5 = 
|pd 5 = 
|cd 6 = 
|pd 6 =  
|cd 7 = 
|pd 7 =
|cd 8  = 
|pd 8  =
|cd 9  = 
|pd 9  =
|cd 10 = 
|pd 10 =
}}

Parameters

Required

|character

the name of the character - do not use brackets etc. Just the name.

|cd 1

character dialogue.

|pd 1

player response to the character dialogue.

Optional

|location

The location of the dialogue. Please only use if the page the subtemplate is used on is not a Dialogue Mission.

|notes

Any notes about the dialogue. This is prudent to do when dialogues are mostly repeats, but with a few differences, as with Feron in the location vs. the mission.

|cd 2+

Additional dialogue from character
"cd" = character dialogue
Only use if needed, never if not needed

|pd 2+

Additional responses from player
"pd" = character dialogue
Only use if needed, never if not needed

|character 2+

If there is more than one character (more than the character and the player) in the conversation, line up the right number (2, 3, 4 etc.) with the right box in the vertical order and type their name here. This defaults to the character entry, because many dialogues are between the player and a single NPC.

Examples

See what links here for examples of this template in action.

Notes

Forum Discussion about this template.

There is probably a more elegant way to code this template regarding the what I call "chunky" number of entries (something instead of cd 1, 2, 3...20), I just don't know quite how to work that in with the flexibility we need. One option is using individual entries per character-player interaction within a space, for example, like the accessory lists. They would just use a different container, not a class=sortable, and slightly tweak the entry behavior. But that also has downsides, and this template simply does it for you. Most conversations are short with a single NPC. With an entry that doesn't use PAGENAME or built in default switches, the NPC's name would need to be entered each time as far as I know - not a huge problem with copypaste, but annoying to do for different conversations with different NPCs, even with easy mass text replace options. This template takes care of that with a single entry, and has flexibility if there's more than one NPC in the dialogue.

Users so far seem to like the ease of entry of the format.
Personal tools