Difference between revisions of "Template:Diff/doc"

From blackwiki
Jump to navigation Jump to search
imported>Pigsonthewing
imported>Edokter
(Use 'title' in line with url parameter names)
Line 11: Line 11:
 
== Usage ==
 
== Usage ==
 
:{{tlx|Diff|''page''|''diff''|''oldid''|''label''|''diffonly{{=}}yes''}}
 
:{{tlx|Diff|''page''|''diff''|''oldid''|''label''|''diffonly{{=}}yes''}}
*<code>''page''</code>{{snds}}The title of the page (optional in most cases).
+
*<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>''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>cur</code>{{snds}}compare with the current version of a page.
Line 21: Line 21:
 
*{{para|diffonly|yes}}{{snds}}Displays the page comparisons only (optional){{nsmdns}}parameter name required if used.
 
*{{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>'''page'''</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==
 
==Examples==
Line 39: Line 39:
 
::''<code>{{font color|brown|<nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>page<nowiki>|</nowiki>diff<nowiki>|</nowiki>oldid<nowiki>|</nowiki>label<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|Main Page|204901573|202506579|Diff between two numbered versions of a page}}
 
| {{Diff|Main Page|204901573|202506579|Diff between two numbered versions of a page}}
* The '''page=''' parameter (parameter number 1) should be a name of a page, for instance [[:Main 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 '''diff=''' parameter (parameter number 2) should be the larger revision number.
 
* The '''oldid=''' parameter (parameter number 3) should be the smaller revision number.
 
* The '''oldid=''' parameter (parameter number 3) should be the smaller revision number.
Line 46: Line 46:
 
::''<code>{{font color|brown|<nowiki>{{</nowiki>'''{{uu|Diff}}'''<nowiki>|</nowiki>page<nowiki>|</nowiki>diff<nowiki>|</nowiki>oldid<nowiki>|</nowiki>label<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}}
 
| {{Diff|Wikipedia:Pagediff|204934693|204901573|Diff between two numbered versions of a <!-- Pagediff --> page in Wikipedia namespace}}
* The '''page=''' parameter (parameter number 1) should be a name of a page, for instance [[:Wikipedia:Pagediff]].
+
* 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 '''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).
 
* The '''oldid=''' parameter (parameter number 3) should be the page revision to appear on the left (original).
Line 78: Line 78:
 
: ''<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>''
 
: ''<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}}
 
| {{Diff|Main Page|204901573|202506579|Comparison display without page display of two numbered versions of a page |diffonly=yes}}
* The '''page=''' parameter (parameter number 1) should be a name of a page, for instance [[:Main 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 '''diff=''' parameter (parameter number 2) should be the larger revision number.
 
* The '''oldid=''' parameter (parameter number 3) should be the smaller revision number.
 
* The '''oldid=''' parameter (parameter number 3) should be the smaller revision number.

Revision as of 09:02, 10 April 2016

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|page|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|Main Page|204901573|202506579|Diff between two numbered versions of a page}}
{{Template:Uu|page|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 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.
{{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

Syntax error in JSON.

See also