Difference between revisions of "Template:Diff/doc"

From blackwiki
Jump to navigation Jump to search
imported>Jonesey95
(Undid revision 996287951 by 2804:D55:5247:4400:8449:7D34:5DA0:2A0B (talk). vandalism)
 
(15 intermediate revisions by 15 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 +
{{Twinkle standard installation}}
 
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
 
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
{{High-use| 17,000+}}
+
{{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.
 
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:{{brk}}
+
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>{{brk}}
+
<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.
 
The number after <code>oldid=</code> is the revision ID.
  
Line 71: Line 72:
 
|-
 
|-
 
| <code><nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>''Main Page''<nowiki>|</nowiki>'''<u>cur<nowiki>||</nowiki></u>'''''Diff showing the most recent change to a page''<nowiki>}}</nowiki></code>
 
| <code><nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>''Main Page''<nowiki>|</nowiki>'''<u>cur<nowiki>||</nowiki></u>'''''Diff showing the most recent change to a page''<nowiki>}}</nowiki></code>
:: ''<code>{{font color|brown|<nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>page<nowiki>|</nowiki>'''<u>cur'''<nowiki>||</nowiki></u>label<nowiki>}}</nowiki>}}</code>''
+
:: ''<code>{{font color|brown|<nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>page<nowiki>|</nowiki><u>'''cur'''<nowiki>||</nowiki></u>label<nowiki>}}</nowiki>}}</code>''
 
| {{Diff|Main Page|cur||Diff showing the most recent change to a page}}
 
| {{Diff|Main Page|cur||Diff showing the most recent change to a page}}
 
* The '''diff=''' parameter (parameter number 2) should be the word '''cur'''.
 
* The '''diff=''' parameter (parameter number 2) should be the word '''cur'''.
Line 139: Line 140:
 
"4"
 
"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.",
 
"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.",
Line 165: Line 166:
 
* [[Special:Diff]] serves a similar purpose; see [[Help:Wiki markup#Linking to old revisions of pages, diffs, and specific history pages]].
 
* [[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||
+
<includeonly>{{Sandbox other||
 
<!-- Categories go here and interwikis go in Wikidata. -->
 
<!-- Categories go here and interwikis go in Wikidata. -->
 
[[Category:Diff templates]]
 
[[Category:Diff templates]]
 
[[Category:Special page templates]]
 
[[Category:Special page templates]]
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 19:59, 25 December 2020

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}}

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 Template:Uu. When a parameter is left blank, the resulting two adjacent pipes are underlined (but not bolded): ||.

Code Output
{{Template:Uu|Main Page|prev|204901573|Diff between a numbered version and the previous version}}
{{Template:Uu|page|prev|oldid|label}}
Diff between a numbered version and the previous version

This is the form that would be used most often.

  • The diff= parameter (parameter number 2) should be the word prev.
  • The oldid= parameter (parameter number 3) should be the known revision number.
{{Template:Uu|Foobar|616706711|616706707|Diff between two numbered versions of a page}}
{{Template:Uu|page title|diff|oldid|label}}
Diff between two numbered versions of a page
  • The title= parameter (parameter number 1) should be a name of a page, for instance Foobar.
  • The diff= parameter (parameter number 2) should be the larger revision number.
  • The oldid= parameter (parameter number 3) should be the smaller revision number.
{{Template:Uu||616706711|616706707|Diff between two numbered versions of a page without title parameter}}
{{Template:Uu||diff|oldid|label}}
Diff between two numbered versions of a page without title parameter
  • The title= parameter (parameter number 1) may be left blank, thereby leaving a double pipe.
  • The diff= parameter (parameter number 2) should be the larger revision number.
  • The oldid= parameter (parameter number 3) should be the smaller revision number.
{{Template:Uu|Wikipedia:Pagediff|204934693|204901573|Diff between two numbered versions of a page in Wikipedia namespace}}
{{Template:Uu|page|diff|oldid|label}}
Diff between two numbered versions of a page in Wikipedia namespace
  • The title= parameter (parameter number 1) should be a name of a page, for instance Wikipedia:Pagediff.
  • The diff= parameter (parameter number 2) should be the page revision to appear on the right (proposed change).
  • The oldid= parameter (parameter number 3) should be the page revision to appear on the left (original).
{{Template:Uu|Main Page|next|204901573|Diff between a numbered version and the subsequent version}}
{{Template:Uu|page|next|oldid|label}}
Diff between a numbered version and the subsequent version
  • The diff= parameter (parameter number 2) should be the word next.
  • The oldid= parameter (parameter number 3) should be the known revision number.
{{Template:Uu|Main Page|cur|204901573|Diff between a numbered version and the current version of a page}}
{{Template:Uu|page|cur|oldid|label}}
Diff between a numbered version and the current version of a page
  • The diff= parameter (parameter number 2) should be the word cur.
  • The oldid= parameter (parameter number 3) should be the known revision number.
{{Template:Uu|Main Page|cur||Diff showing the most recent change to a page}}
{{Template:Uu|page|cur||label}}
Diff showing the most recent change to a page
  • The diff= parameter (parameter number 2) should be the word cur.
  • The oldid= parameter (parameter number 3) should be empty.
{{Template:Uu|Main Page||204901573|A link to a numbered version of a page}}
{{Template:Uu|pageTemplate:Uuoldid|label}}
A link to a numbered version of a page
  • The diff= parameter (parameter number 2) should be empty.
  • The oldid= parameter (parameter number 3) should be the known revision number.
  • The result is not actually a diff, so this might be considered misuse of the template. See the {{oldid}} template.
{{Template:Uu|Main Page|204901573|202506579|Comparison display without page display of two numbered versions of a page |diffonly=yes}}
{{Template:Uu|page|diff|oldid|label|diffonly=yes}}
Comparison display without page display of two numbered versions of a page
  • The title= parameter (parameter number 1) should be a name of a page, for instance Main Page.
  • The diff= parameter (parameter number 2) should be the larger revision number.
  • The oldid= parameter (parameter number 3) should be the smaller revision number.
  • The diffonly= parameter, which must include the parameter name, can only be set to yes

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

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.

Template parameters

ParameterDescriptionTypeStatus
titletitle page 1

The title of the page.

Pageoptional
Diffdiff 2

The ID or keyword that is used against the base ID. Possible keywords are:

  • cur – compare with the current version of a page.
  • prev – compare with the previous version of a page.
  • next – compare with the next version of a page.
  • <var>id</var> – compare against this revision ID; should be <em>larger</em> than <code>oldid</code>.

Linerequired
Oldidoldid 3

The base ID onto which the diff is generated. Some number like "442212827" (without the quotes).

Numberoptional
Labellabel 4

Text to display as link. No label will give a numbered link.

Lineoptional
Diffonlydiffonly

Displays the page comparisons only. If you use this, the value should be "yes" (without the quotes).

Lineoptional

See also