ଛାଞ୍ଚ:Cite compare/doc ନିମନ୍ତେ ଆଧାର ଦେଖିବେ

{{Documentation subpage}}
{{tld|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.  The tool was developed to aid in the migration of the CS1 templates from the {{tld|citation/core}} engine to [[Module:Citation/CS1]] [[Lua (programming language)|Lua]] engine.

To invoke {{tld|cite compare}} simply add CS1 template parameters to {{tld|cite compare}}.  For example, a simple {{tlx|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>
which produces this output:
{{cite compare |mode=web |url=http://www.example.com |website=Example Website |title=Example comparison}}

== Usage ==
The default display is a comparison between the old {{tlx|citation/core}}-based CS1 template and the current live CS1 template.  Because the tool was developed to compare the new Lua-based versions of a CS1 templates against the older {{tld|citation/core}} reference templates, the reference template are moved to a subpage labeled old.  For example, {{tlx|cite web/old}} is the reference version against which the initial Lua implementation ot {{tld|cite web}} were compared.

{{tld|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|sandbox}} – when set to <code>yes</code>, includes the citation as rendered by [[Module:Citation/CS1/sandbox]]
*{{para|old}} – when set to <code>no</code>, does not include the citation as rendered by {{tlx|citation/core}}; includes the citation as rendered by [[Module:Citation/CS1/sandbox]]
*{{para|comment}} – when set to a comment, displays the comment at the bottom of the comparison table

===Compare old, live and sandbox===
Adding {{para|sandbox|yes}} will display a comparison of all three versions of a CS1 citation:

<code><nowiki>{{cite compare |mode=web |sandbox=yes |url=http://www.example.com |website=Example Website |title=Example comparison}}</nowiki></code>
{{cite compare |mode=web |sandbox=yes |url=http://www.example.com |website=Example Website |title=Example comparison}}

===Compare live and sandbox===
As more of the CS1 templates are migrated to [[Module:Citation/CS1]] and new features / enhancements are added, it becomes less important to compare the sandbox version to the old version.  Setting {{para|old|no}} displays a comparison between the live and sandbox versions.

<code><nowiki>{{cite compare |mode=web |old=no |url=http://www.example.com |website=Example Website |title=Example comparison}}</nowiki></code>
{{cite compare |mode=web |old=no |url=http://www.example.com |website=Example Website |title=Example comparison}}

Though perfectly acceptable, simultaneously setting {{para|old|no}} and {{para|sandbox|yes}} is the same as simply setting {{para|old|no}}.

<code><nowiki>{{cite compare |mode=web |sandbox=yes |old=no |url=http://www.example.com |website=Example Website |title=Example comparison}}</nowiki></code>
{{cite compare |mode=web |sandbox=yes |old=no |url=http://www.example.com |website=Example Website |title=Example comparison}}

===Compare with comment===
To add a comment regarding the comparison, set {{para|comment|<comment text>}}.  If <comment text> contains a vertical bar or pipe (|) use {{tlx|!}}.

<code><nowiki>{{cite compare |mode=web |sandbox=yes |comment=Comment about {{!}}comment=<comment text> |url=http://www.example.com |website=Example Website |title=Example comparison}}</nowiki></code>
{{cite compare |mode=web |sandbox=yes |comment=Comment about {{!}}comment=<comment text> |url=http://www.example.com |website=Example Website |title=Example comparison}}

==See also==
* {{tlx|cite compare2}} – for a live-only display

<includeonly>
<!-- Categories go here, and interwikis go in Wikidata -->

</includeonly>