Difference between revisions of "Template:Cite compare/doc"
imported>Jonesey95 (→See also: rm template that was tfd'd and redirected here) |
imported>Bsherr m (replacing Template:Tld with Template:Tlf, plus general and typo fixes as found) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
| − | {{ | + | <!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> |
| + | {{tlf|cite compare}} is a debug and documentation tool that allows editors to compare the output created by the various versions of a {{cs1}} (CS1) template. To invoke {{tlf|cite compare}} simply add CS1 template parameters to {{tlc|cite compare}}. For example, a simple {{tlf|cite web}} comparison might look like this: | ||
<code><nowiki>{{cite compare |mode=web |url=http://www.example.com |website=Example Website |title=Example comparison}}</nowiki></code> | <code><nowiki>{{cite compare |mode=web |url=http://www.example.com |website=Example Website |title=Example comparison}}</nowiki></code> | ||
which produces this output: | which produces this output: | ||
| Line 8: | Line 9: | ||
The default display is a comparison between sandbox and the current live CS1 template. | The default display is a comparison between sandbox and the current live CS1 template. | ||
| − | {{ | + | {{tlf|cite compare}} is controlled by four parameters: |
* {{para|mode}} – selects which of the CS1 templates will be compared; for {{tlx|cite web}}, {{para|mode|web}}; for {{tlx|cite journal}}, {{para|mode|journal}}; etc. | * {{para|mode}} – selects which of the CS1 templates will be compared; for {{tlx|cite web}}, {{para|mode|web}}; for {{tlx|cite journal}}, {{para|mode|journal}}; etc. | ||
* {{para|old}} – when set to <code>yes</code>, includes the citation as rendered by {{tlx|citation/core}} | * {{para|old}} – when set to <code>yes</code>, includes the citation as rendered by {{tlx|citation/core}} | ||
| Line 20: | Line 21: | ||
===Compare old, live and sandbox=== | ===Compare old, live and sandbox=== | ||
| − | Adding {{para|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, {{ | + | Adding {{para|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, {{tl|cite web/old}} is the reference version against which the initial Lua implementation to {{tlf|cite web}} were compared. |
<code><nowiki>{{cite compare |mode=web |old=yes |url=http://www.example.com |website=Example Website |title=Example comparison}}</nowiki></code> | <code><nowiki>{{cite compare |mode=web |old=yes |url=http://www.example.com |website=Example Website |title=Example comparison}}</nowiki></code> | ||
Latest revision as of 18:44, 9 August 2020
| This is a documentation subpage for Template:Cite compare. It contains 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:
| WT | {{cite web |url=http://www.example.com |website=Example Website |title=Example comparison}}
|
|---|---|
| Live | "Example comparison". Example Website. |
| Sandbox | Lua error in Module:Citation/CS1/sandbox at line 126: Argument map not defined for this variable. |
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}}
| WT | {{cite web |title=Example comparison |website=Example Website |url=http://www.example.com}}
|
|---|---|
| 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}}
| WT | {{cite web |title=Example comparison |website=Example Website |url=http://www.example.com}}
|
|---|---|
| Old | "Example comparison". http://www.example.com. |
| Live | "Example comparison". Example Website. |
| Sandbox | Lua error in Module:Citation/CS1/sandbox at line 126: Argument map not defined for this variable. |
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}}
| WT | {{cite web |url=http://www.example.com |website=Example Website |title=Example comparison}}
|
|---|---|
| Live | "Example comparison". Example Website. |
| Sandbox | Lua error in Module:Citation/CS1/sandbox at line 126: Argument map not defined for this variable. |
| Comment about |comment=<comment text> | |