Template:Diff/doc
This is a documentation subpage for Template:Diff. It contains usage information, categories and other content that is not part of the original template page. |
If you plan to make breaking changes to this template, move it, or nominate it for deletion, please notify Twinkle's users and maintainers at Wikipedia talk:Twinkle as a courtesy, as this template is used in the standard installation of Twinkle. Thank you! |
This template is used on approximately 23,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
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:
http[s]://en.wikipedia.org/w/index.php?title=SomePageName&oldid=442212827
The number after oldid=
is the revision ID.
Given one or two revision IDs, you can construct links to several types of diffs.
Usage
{{Diff|title|diff|oldid|label|diffonly=yes}}
title
- REDIRECT Template:Spaced en dash space
- From a shortcut: This is a redirect from a shortcut in any namespace to a page in any namespace except template namespace.
- Shortcuts are wikilinked on community pages, talk pages, and edit summaries, but not in mainspace articles.
The title of the page (optional in most cases).
diff
- REDIRECT Template:Spaced en dash space
- From a shortcut: This is a redirect from a shortcut in any namespace to a page in any namespace except template namespace.
- Shortcuts are wikilinked on community pages, talk pages, and edit summaries, but not in mainspace articles.
The ID or keyword that is used against the base ID. Possible keywords are:
cur
- REDIRECT Template:Spaced en dash space
- From a shortcut: This is a redirect from a shortcut in any namespace to a page in any namespace except template namespace.
- Shortcuts are wikilinked on community pages, talk pages, and edit summaries, but not in mainspace articles.
compare with the current version of a page.
prev
- REDIRECT Template:Spaced en dash space
- From a shortcut: This is a redirect from a shortcut in any namespace to a page in any namespace except template namespace.
- Shortcuts are wikilinked on community pages, talk pages, and edit summaries, but not in mainspace articles.
compare with the previous version of a page.
next
- REDIRECT Template:Spaced en dash space
- From a shortcut: This is a redirect from a shortcut in any namespace to a page in any namespace except template namespace.
- Shortcuts are wikilinked on community pages, talk pages, and edit summaries, but not in mainspace articles.
compare with the next version of a page.
- id
- REDIRECT Template:Spaced en dash space
- From a shortcut: This is a redirect from a shortcut in any namespace to a page in any namespace except template namespace.
- Shortcuts are wikilinked on community pages, talk pages, and edit summaries, but not in mainspace articles.
This should be larger than oldid
.
oldid
- REDIRECT Template:Spaced en dash space
- From a shortcut: This is a redirect from a shortcut in any namespace to a page in any namespace except template namespace.
- Shortcuts are wikilinked on community pages, talk pages, and edit summaries, but not in mainspace articles.
The base ID onto which the diff is generated.
label
- REDIRECT Template:Spaced en dash space
- From a shortcut: This is a redirect from a shortcut in any namespace to a page in any namespace except template namespace.
- Shortcuts are wikilinked on community pages, talk pages, and edit summaries, but not in mainspace articles.
Text to display as link (optional)
- From a shortcut: This is a redirect from a shortcut in any namespace to a page in any namespace except template namespace.
- Shortcuts are wikilinked on community pages, talk pages, and edit summaries, but not in mainspace articles.
no label will generate a numbered link as the label.
|diffonly=yes
- REDIRECT Template:Spaced en dash space
- From a shortcut: This is a redirect from a shortcut in any namespace to a page in any namespace except template namespace.
- Shortcuts are wikilinked on community pages, talk pages, and edit summaries, but not in mainspace articles.
Displays the page comparisons only (optional)
- From a shortcut: This is a redirect from a shortcut in any namespace to a page in any namespace except template namespace.
- Shortcuts are wikilinked on community pages, talk pages, and edit summaries, but not in mainspace articles.
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 title
, diff
, oldid
, and label
.
Examples
Below each example in the left-hand column is the pseudocode for that example in brown italics
and indented. Elements that should be entered literally are in
REDIRECT Template:Underline
. When a parameter is left blank, the resulting two adjacent pipes are underlined (but not bolded):||
.
Code | Output |
---|---|
{{
|
Diff between a numbered version and the previous version
This is the form that would be used most often.
|
{{
|
Diff between two numbered versions of a page
|
{{
|
Diff between two numbered versions of a page without title parameter
|
{{
|
Diff between two numbered versions of a page in Wikipedia namespace
|
{{
|
Diff between a numbered version and the subsequent version
|
{{
|
Diff between a numbered version and the current version of a page
|
{{
|
Diff showing the most recent change to a page
|
{{
|
A link to a numbered version of a page
|
{{
|
Comparison display without page display of two numbered versions of a page
|
TemplateData
TemplateData for Diff
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.
Parameter | Description | Type | Status | |
---|---|---|---|---|
title | title page 1 | The title of the page. | Page | optional |
Diff | diff 2 | The ID or keyword that is used against the base ID. Possible keywords are:
| Line | required |
Oldid | oldid 3 | The base ID onto which the diff is generated. Some number like "442212827" (without the quotes). | Number | optional |
Label | label 4 | Text to display as link. No label will give a numbered link. | Line | optional |
Diffonly | diffonly | Displays the page comparisons only. If you use this, the value should be "yes" (without the quotes). | Line | optional |
See also
- {{Oldid}} – simplifies the case for linking to a known old version
- {{Diff2}} – same as {{Diff}}, but assumes a diff between the given revision and the one immediately before
- {{Diff3}}
- {{Diff4}}
- {{URL to diff}} - takes a diff URL and makes a {{Diff}} template
- {{Diffsandbox}} – compares a given page with the sandbox version
- {{DiffPages}} – accepts two pagenames (no id's needed)
- {{Querylink}} – generic template to construct query strings
- 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.
- {{TextDiff}}