Reba inkomoko ya Inyandikorugero:Compare pages/doc

{{Documentation subpage}}

Similar to the {{Tl|Diff}} template, this template is intended to be useful for creating links to "[[Help:Diff|diffs]]"; that is, links to pages that show the differences between two versions of a wiki page.  The major difference is that {{Tlc|Diff}} is intended to show two versions of the same page, and this creates a link to [[Special:ComparePages]] to show one version of two different pages.

Every version of a page has a revision ID, which you can find from the [[Help:Page history|history]] of the page by looking at the link for the timestamp, which is of the form:
 <nowiki>https://en.wikipedia.org/w/index.php?title=SomePageName&oldid=442212827</nowiki>
The number after <kbd>oldid=</kbd> is the revision ID.

Given a page name and one or two revision IDs, you can construct links to several types of diffs.

== Usage ==
:{{Tlx|Compare pages|''page'' or ''oldid'' for page 1|''page'' or ''oldid'' for page 2}}
*<kbd>''page''</kbd>&nbsp;– The title of the page.
*<kbd>''oldid''</kbd>&nbsp;– The revision ID onto which the diff is generated.
<!-- ADD IN DETAILS FOR {{{3}}}, {{{label}}}, {{{label1}}}, and {{{label2}}} once the bugs are ironed out. -->

All parameters are required. Omitting parameters will return an error.

== Examples ==
{| class="wikitable"
! style="width:40%;" | Code !! Output
|-
| <code><nowiki>{{Compare pages|Foo|Bar}}</nowiki></code>
| {{Compare pages|Foo|Bar}}
'''This is the form that would be used most often.'''
|-
| <code><nowiki>{{Compare pages|Foo|Bar|Difference between pages}}</nowiki></code>
| {{Compare pages|Foo|Bar|Difference between pages}}
|-
| <code><nowiki>{{Compare pages|Foo}}</nowiki></code>
| {{Compare pages|Foo}}
|-
| <code><nowiki>{{Compare pages||Bar}}</nowiki></code>
| {{Compare pages||Bar}}
|}

== See also ==
* {{Tl|Oldid}}&nbsp;– simplifies the case for linking to a known old version
* {{Tl|Diff}}
* {{Tl|Diff2}}
* {{Tl|Querylink}}&nbsp;– generic template to construct [[query string]]s
* [[diff utility]]&nbsp;– syntax highlight on wiki pages with [[mw:Extension:SyntaxHighlight GeSHi]]
* [[User:Scottywong/diffconverter]], a tool for converting from raw form
* [[Special:ComparePages]]

<!-- NO TEMPLATE DATA UNTIL LABEL PARAMETERS ARE GOOD
<nowiki>
== TemplateData ==
<templatedata>
{
	"params": {
		"page": {
			"required": true,
			"label": "Page",
			"type": "string/wiki-page-name",
			"description": "The title of the page."
		},
		"diff": {
			"required": true,
			"label": "Diff",
			"type": "string/line",
			"description": "The ID or keyword that is used against the base ID. Possible keywords are:\n* cur – compare with the current version of a page.\n* prev – compare with the previous version of a page.\n* next – compare with the next version of a page."
		},
		"oldid": {
			"required": false,
			"label": "Oldid",
			"type": "number",
			"description": "The base ID onto which the diff is generated. Some number like \"442212827\" (without the quotes)."
		},
		"diffonly": {
			"required": false,
			"label": "Diffonly",
			"type": "string/line",
			"description": "Displays the page comparisons only. If you use this, the value should be \"yes\" (without the quotes)."
		},
		"label": {
			"required": false,
			"label": "Label",
			"type": "string/line",
			"description": "Text to display as link. No label will give a numbered link."
		},
		"id": {
			"type": "number",
			"label": "id",
			"description": "The ID to be compared with the base oldid. To be included ONLY if the parameter \"diff\" is NOT specified. This should be *larger* than <kbd>oldid</kbd>. Some number like \"442212827\" (without the quotes)."
		}
	},
	"description": "A template that is intended to be useful for creating links to diffs; that is, links to pages that show the differences between two versions of a wiki page."
}
</templatedata>
</nowiki>
-->


<includeonly>{{Sandbox other||
[[Category:Diff templates|{{PAGENAME}}]]
}}</includeonly>