Template:Diff/doc

This template 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.

Every version of a page has a revision ID, which you can find from the history of the page by looking at the timestamp link for the edit. The timestamp link is in this form:

The number after  is the revision ID.

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

Usage



 * – The title of the page (optional in most cases)
 * – The ID or keyword that is used against the base ID. Possible keywords are:
 * – Compare with the current version of a page.
 * – Compare with the previous version of a page.
 * – Compare with the next version of a page.
 * id – This should be larger than.
 * – The base ID onto which the diff is generated.
 * – Text to display as link (optional)—‌no label will generate a numbered link as the label.
 * yes – Displays the page comparisons only (optional)—‌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,  ,  , and.

Helper subtemplate
In order to make this template simpler to use the helper subtemplate Diff/translator is available, to be used only in the preview window.


 * Syntax:

For instance, imagine you want to refer to the following diff URL: ; you only need to transcribe that URL in the Diff/translator subtemplate and produce a preview, without saving the page:



Now copy the code generated into the edit window where Diff/translator was and publish the page.

Examples
Below each example in the left-hand column is the pseudocode for that example in   and indented. Elements that should be entered literally are in  . When a parameter is left blank, the resulting two adjacent pipes are underlined (but not bolded):  .

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* id – compare against this revision ID; should be larger than .", "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" ] }