Template:Diff/doc

2019-12-03T16:12:13Z

96.5.246.66: /* Examples */

{{Documentation subpage}}

{{High-use| 23301 }}
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.

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 timestamp link for the edit. The timestamp link is in this form:<br />
<code>http[s]://en.wikipedia.org/w/index.php?title=SomePageName&oldid=442212827</code><br />
The number after <code>oldid=</code> is the revision ID.

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

== Usage ==
:{{tlx|Diff|''title''|''diff''|''oldid''|''label''|''diffonly{{=}}yes''}}
*<code>''title''</code>{{snds}}The title of the page (optional in most cases).
*<code>''diff''</code>{{snds}}The ID or keyword that is used against the base ID. Possible keywords are:
*:<code>cur</code>{{snds}}compare with the current version of a page.
*:<code>prev</code>{{snds}}compare with the previous version of a page.
*:<code>next</code>{{snds}}compare with the next version of a page.
*:''id''{{snds}}This should be ''larger'' than <code>oldid</code>.
*<code>''oldid''</code>{{snds}}The base ID onto which the diff is generated.
*<code>''label''</code>{{snds}}Text to display as link (optional){{nsmdns}}no label will generate a numbered link as the label.
*{{para|diffonly|yes}}{{snds}}Displays the page comparisons only (optional){{nsmdns}}parameter name required if used.

Only the ''diff'' parameter is required; all other parameters are optional. Omitted parameters must be empty (by using a double pipe). You can also use the named parameters <code>'''title'''</code>, <code>'''diff'''</code>, <code>'''oldid'''</code>, and <code>'''label'''</code>.

Wikipedia is mine yours truly obama.

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
"params": {
"title": {
"required": false,
"label": "title",
"type": "string/wiki-page-name",
"description": "The title of the page.",
"aliases": [
"page",
"1"
]
},
"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.\n* <var>id</var> – compare against this revision ID; should be <em>larger</em> than <code>oldid</code>.",
"aliases": [
"2"
]
},
"oldid": {
"required": false,
"label": "Oldid",
"type": "number",
"description": "The base ID onto which the diff is generated. Some number like \"442212827\" (without the quotes).",
"aliases": [
"3"
]
},
"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.",
"aliases": [
"4"
]
}
},
"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.",
"paramOrder": [
"title",
"diff",
"oldid",
"label",
"diffonly"
]
}
</templatedata>

== See also ==
* {{Tl|Oldid}} – simplifies the case for linking to a known old version
* {{Tl|Diff2}} – same as {{Tl|Diff}}, but assumes a diff between the given revision and the one immediately before
* {{Tl|Diff3}}
* {{Tl|Diff4}}
* {{Tl|URL to diff}} - takes a diff URL and makes a {{tl|Diff}} template
* {{Tl|Diffsandbox}} – compares a given page with the sandbox version
* {{Tl|DiffPages}} – accepts two pagenames (no id's needed)
* {{Tl|Querylink}} – generic template to construct [[query string]]s
* [[diff utility]] – syntax highlight on wiki pages with [[mw:Extension:SyntaxHighlight GeSHi]]
* [[User:Scottywong/diffconverter]], a tool for converting from raw form
* [[Special:Diff]] serves a similar purpose; see [[Help:Wiki markup#Linking to old revisions of pages, diffs, and specific history pages]].

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||

[[Category:Diff templates]]
[[Category:Special page templates]]
}}</includeonly>

blackwiki - User contributions [en]

Template:Diff/doc