Difference between revisions of "Template:Diff/doc"

From blackwiki
Jump to navigation Jump to search
imported>Rchard2scout
m (fix syntax error in json)
Line 24: Line 24:
 
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>.
 
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>.
  
==Examples==
+
Wikipedia is mine yours truly obama.
Below each example in the left-hand column is the pseudocode for that example in ''<code>{{font color|brown|brown italics}}</code>'' and indented. Elements that should be entered literally are in '''''<code>{{font color|brown|{{uu|brown bold underlined italics}}}}</code>'''''. When a parameter is left blank, the resulting two adjacent pipes are underlined (but not bolded): ''<code>{{font color|brown|<u>&#x7c;&#x7c;</u>}}</code>''.
 
 
 
{| class="wikitable"
 
! style="width:33%;" | Code !! Output
 
|-
 
| <code><nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>''Main Page''<nowiki>|</nowiki>'''<u>prev</u>'''<nowiki>|</nowiki>''204901573''<nowiki>|</nowiki>''Diff between a numbered version and the previous version''<nowiki>}}</nowiki></code>
 
::''<code>{{font color|brown|<nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>page<nowiki>|</nowiki>'''<u>prev</u>'''<nowiki>|</nowiki>oldid<nowiki>|</nowiki>label<nowiki>}}</nowiki>}}</code>''
 
| {{Diff|Main Page|prev|204901573|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.
 
|-
 
| <code><nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>''Foobar''<nowiki>|</nowiki>''616706711''<nowiki>|</nowiki>''616706707''<nowiki>|</nowiki>''Diff between two numbered versions of a page''<nowiki>}}</nowiki></code>
 
::''<code>{{font color|brown|<nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>page title<nowiki>|</nowiki>diff<nowiki>|</nowiki>oldid<nowiki>|</nowiki>label<nowiki>}}</nowiki>}}</code>''
 
| {{Diff|Main Page|616706711|616706707|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.
 
|-
 
| <code><nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>||</nowiki>''616706711''<nowiki>|</nowiki>''616706707''<nowiki>|</nowiki>''Diff between two numbered versions of a page without title parameter''<nowiki>}}</nowiki></code>
 
::''<code>{{font color|brown|<nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>||</nowiki>diff<nowiki>|</nowiki>oldid<nowiki>|</nowiki>label<nowiki>}}</nowiki>}}</code>''
 
| {{Diff||616706711|616706707|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.
 
|-
 
| <code><nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>''Wikipedia:Pagediff''<nowiki>|</nowiki>''204934693''<nowiki>|</nowiki>''204901573''<nowiki>|</nowiki>''Diff between two numbered versions of a <!-- Pagediff --> page in Wikipedia namespace''<nowiki>}}</nowiki></code>
 
::''<code>{{font color|brown|<nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>page<nowiki>|</nowiki>diff<nowiki>|</nowiki>oldid<nowiki>|</nowiki>label<nowiki>}}</nowiki>}}</code>''
 
| {{Diff|Wikipedia:Pagediff|204934693|204901573|Diff between two numbered versions of a <!-- Pagediff --> 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).
 
|-
 
| <code><nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>''Main Page''<nowiki>|</nowiki>'''<u>next</u>'''<nowiki>|</nowiki>''204901573''<nowiki>|</nowiki>''Diff between a numbered version and the subsequent version''<nowiki>}}</nowiki></code>
 
:: ''<code>{{font color|brown|<nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>page<nowiki>|</nowiki>'''<u>next</u>'''<nowiki>|</nowiki>oldid<nowiki>|</nowiki>label<nowiki>}}</nowiki>}}</code>''
 
| {{Diff|Main Page|next|204901573|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.
 
|-
 
| <code><nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>''Main Page''<nowiki>|</nowiki>'''<u>cur</u>'''<nowiki>|</nowiki>''204901573''<nowiki>|</nowiki>''Diff between a numbered version and the current version of a page''<nowiki>}}</nowiki></code>
 
:: ''<code>{{font color|brown|<nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>page<nowiki>|</nowiki>'''<u>cur</u>'''<nowiki>|</nowiki>oldid<nowiki>|</nowiki>label<nowiki>}}</nowiki>}}</code>''
 
| {{Diff|Main Page|cur|204901573|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.
 
|-
 
| <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>''
 
| {{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 '''oldid=''' parameter (parameter number 3) should be empty.
 
|-
 
| <code><nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>''Main Page'''''<u><nowiki>||</nowiki></u>'''''204901573''<nowiki>|</nowiki>''A link to a numbered version of a page''<nowiki>}}</nowiki></code>
 
:: ''<code>{{font color|brown|<nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>page{{uu|<nowiki>||</nowiki>}}oldid<nowiki>|</nowiki>label<nowiki>}}</nowiki>}}</code>''
 
| {{Diff|Main Page||204901573|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 {{tl|oldid}} template.
 
|-
 
| <code><nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>''Main Page''<nowiki>|</nowiki>''204901573''<nowiki>|</nowiki>''202506579''<nowiki>|</nowiki>''Comparison display without page display of two numbered versions of a page'' <nowiki>|</nowiki>'''<u>diffonly=yes</u>'''<nowiki>}}</nowiki></code>
 
: ''<code>{{font color|brown|<nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>page<nowiki>|</nowiki>diff<nowiki>|</nowiki>oldid<nowiki>|</nowiki>label<nowiki>|</nowiki>'''<u>diffonly{{=}}yes</u>'''<nowiki>}}</nowiki>}}</code>''
 
| {{Diff|Main Page|204901573|202506579|Comparison display without page display of two numbered versions of a page |diffonly=yes}}
 
* 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 <code>yes</code>
 
|}
 
  
 
== TemplateData ==
 
== TemplateData ==

Revision as of 16:12, 3 December 2019

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.

Wikipedia is mine yours truly obama.

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