Template:Cite compare2/doc

From blackwiki
Jump to navigation Jump to search

{{cite compare2}} is a documentation tool similar to {{cite compare}}, but only used to display the live Module:Citation/CS1 Lua engine output, and optionally the Module:Citation/CS1/sandbox output. {{cite compare}} forces the display of either the old or the sandbox versions.

{{cite compare2}} also has the optional |header= parameter, which adds text after the Cite <mode> compare heading, for a more compact display.

Usage

{{cite compare2}} is controlled by four parameters:

  • |mode= – selects which of the CS1 templates will be compared; for {{cite web}}, |mode=web; for {{cite journal}}, |mode=journal; etc.
  • |sandbox= – when set to yes (or any text), includes the citation as rendered by Module:Citation/CS1/sandbox
  • |comment= – when set to a comment, displays the comment at the bottom of the comparison table
  • |header= – analogous to |comment=, but displays in bold after the Cite <mode> compare heading text

Default display

The default display is simply the wiki markup text and the current live CS1 template.

{{cite compare2 |mode=web |url=http://www.example.com |website=Example Website |title=Example comparison |header=(header comment) |comment=(footer comment)}} produces:

Cite web comparison (header comment)
WT {{cite web |title=Example comparison |url=http://www.example.com |website=Example Website}}
Live "Example comparison". Example Website.
Sandbox Lua error in Module:Citation/CS1/sandbox at line 126: Argument map not defined for this variable.
(footer comment)

Compare live and sandbox

{{cite compare2 |mode=web |url=http://www.example.com |website=Example Website |title=Example comparison |header=(header comment) |comment=(footer comment)}} produces:

Cite web comparison (header comment)
WT {{cite web |title=Example comparison |url=http://www.example.com |website=Example Website}}
Live "Example comparison". Example Website.
Sandbox Lua error in Module:Citation/CS1/sandbox at line 126: Argument map not defined for this variable.
(footer comment)