Template:Cite compare/doc
 | This is a documentation subpage for Template:Cite compare. It may contain usage information, categories and other content that is not part of the original template page. |
{{cite compare}} is a debug and documentation tool that allows editors to compare the output created by the various versions of a Citation Style 1 (CS1) template. To invoke {{cite compare}} simply add CS1 template parameters to {{cite compare}}. For example, a simple {{cite web}} comparison might look like this:
{{cite compare |mode=web |url=http://www.example.com |website=Example Website |title=Example comparison}}
which produces this output:
| Wikitext | {{cite web
|
|---|---|
| Live | "Example comparison". Example Website. |
| Sandbox | "Example comparison". Example Website. |
Usage
The default display is a comparison between sandbox and the current live CS1 template.
{{cite compare}} 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.|old=– when set toyes, includes the citation as rendered by {{citation/core}}|comment=– when set to a comment, displays the comment at the bottom of the comparison table|header=– when set, displays additional header text|nosandbox=– when set, removes the line for the sandbox
Display only live
{{cite compare |mode=web |nosandbox=yes |url=http://www.example.com |website=Example Website |title=Example comparison}}
| Wikitext | {{cite web
|
|---|---|
| Live | "Example comparison". Example Website. |
Compare old, live and sandbox
Adding |old=yes will display a comparison of all three versions of a CS1 citation: the current live template, the sandbox template, and the old, pre-Lua-based versions. The non-Lua-based templates are at pages labeled old; for example, {{cite web/old}} is the reference version against which the initial Lua implementation to {{cite web}} were compared.
{{cite compare |mode=web |old=yes |url=http://www.example.com |website=Example Website |title=Example comparison}}
| Wikitext | {{cite web
|
|---|---|
| Old | "Example comparison". http://www.example.com. |
| Live | "Example comparison". Example Website. |
| Sandbox | "Example comparison". Example Website. |
Compare with comment
To add a comment regarding the comparison, set |comment=<comment text>. If <comment text> contains a vertical bar or pipe (|) use {{!}}.
{{cite compare |mode=web |comment=Comment about {{!}}comment=<comment text> |header=(additional header text) |url=http://www.example.com |website=Example Website |title=Example comparison}}
| Wikitext | {{cite web
|
|---|---|
| Live | "Example comparison". Example Website. |
| Sandbox | "Example comparison". Example Website. |
| Comment about |comment=<comment text> | |