Module:Cite/Documentation

From Zelda Wiki, the Zelda encyclopedia
Jump to navigation Jump to search

This is the documentation page for Module:Cite

This is the main module for the following templates:

In addition, this module exports the following functions.

color

color(quote, source, game)

Given a valid game and character (source), this function applies the main color used for that character's dialogue in-game.

Returns

  • The colored text

Examples

#InputOutputResultStatus
1
color(
  "Only the true ruler of the Twili can destroy the Mirror of Twilight.",
  "Midna",
  "TPHD"
)
'<span class="zw-color" style="color:#64b1b3">Only the true ruler of the Twili can destroy the Mirror of Twilight.</span>'
Only the true ruler of the Twili can destroy the Mirror of Twilight.
Green check.svg
Not all characters have a unique color.
2
color("Tingle, Tingle! Kooloo-Limpah!", "Tingle", "MM")
"Tingle, Tingle! Kooloo-Limpah!"
Tingle, Tingle! Kooloo-Limpah!
Green check.svg

printCitation

printCitation(args)

For use by other citation modules to ensure consitent citation formatting wiki-wide.

Returns

  • A formatted citation.

Examples

#InputResult
3
printCitation({
  quote = "Quote",
  source = "source",
  speaker = "Speaker",
  sourceComponents = {"sourceInfo", "sourceInfo"},
})
"Quote" — Speaker (source, sourceInfo, sourceInfo)
4
printCitation({
  quote = "Quote",
  source = "source",
  sourceComponents = {"sourceInfo", [3] = "sourceInfo"},
})
"Quote" (source, sourceInfo, sourceInfo)
5
printCitation({
  speaker = "Speaker",
  source = "source",
  sourceComponents = {"sourceInfo", "sourceInfo", "sourceInfo"},
})
Speaker (source, sourceInfo, sourceInfo, sourceInfo)
6
printCitation({
  quote = "De oplossing voor de graftombe van Gamelon is als volgt",
  translation = "The solution to the tomb of Gamelon is as follows",
  sourceComponents = {"CD Interactief vol. 2 no. 11", "HUB Uitgevers"},
})
"De oplossing voor de graftombe van Gamelon is als volgt" (The solution to the tomb of Gamelon is as follows) (CD Interactief vol. 2 no. 11, HUB Uitgevers)
7
printCitation({
  source = "''[[The Legend of Zelda: Four Swords Adventures|Four Swords Adventures]]''",
  romanization = "Sūpā Piggu",
  quote = "{{H|TWW|スーパーピッグ}}",
  speaker = "[[Sign]]",
  translation = "Super Pig",
})
"スーパーピッグ" (Super Pig) — Sign (Four Swords Adventures)