Difference between revisions of "Template:Diff/doc"
(←Replaced content with 'Fgjk') |
imported>CLCStudent m (Reverted 1 edit by 2600:1011:B058:37D5:9893:B385:42A4:1AAE (talk) to last revision by 50.53.1.33. (TW)) |
||
| Line 1: | Line 1: | ||
| − | + | {{Documentation subpage}} | |
| + | <!-- Categories go at the bottom of this page and interwikis go in Wikidata. --> | ||
| + | {{High-use| 17,000+}} | ||
| + | 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}} | ||
| + | <code>http[s]://en.wikipedia.org/w/index.php?title=SomePageName&oldid=442212827</code>{{brk}} | ||
| + | The number after <code>oldid=</code> is the revision ID. | ||
| + | |||
| + | Given one or two revision IDs, you can construct links to several types of diffs. | ||
| + | |||
| + | == Usage == | ||
| + | :{{tlx|Diff|''title''|''diff''|''oldid''|''label''|''diffonly{{=}}yes''}} | ||
| + | *<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>cur</code>{{snds}}compare with the current version of a page. | ||
| + | *:<code>prev</code>{{snds}}compare with the previous version of a page. | ||
| + | *:<code>next</code>{{snds}}compare with the next version of a page. | ||
| + | *:''id''{{snds}}This should be ''larger'' than <code>oldid</code>. | ||
| + | *<code>''oldid''</code>{{snds}}The base ID onto which the diff is generated. | ||
| + | *<code>''label''</code>{{snds}}Text to display as link (optional){{nsmdns}}no label will generate a numbered link as the label. | ||
| + | *{{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>'''title'''</code>, <code>'''diff'''</code>, <code>'''oldid'''</code>, and <code>'''label'''</code>. | ||
| + | |||
| + | ==Examples== | ||
| + | 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>||</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 header}} | ||
| + | <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* <var>id</var> – compare against this revision ID; should be <em>larger</em> than <code>oldid</code>.", | ||
| + | "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" | ||
| + | ] | ||
| + | } | ||
| + | </templatedata> | ||
| + | |||
| + | == See also == | ||
| + | * {{Tl|Oldid}} – simplifies the case for linking to a known old version | ||
| + | * {{Tl|Diff2}} – same as {{Tl|Diff}}, but assumes a diff between the given revision and the one immediately before | ||
| + | * {{Tl|Diff3}} | ||
| + | * {{Tl|Diff4}} | ||
| + | * {{Tl|URL to diff}} - takes a diff URL and makes a {{tl|Diff}} template | ||
| + | * {{Tl|Diffsandbox}} – compares a given page with the sandbox version | ||
| + | * {{Tl|DiffPages}} – accepts two pagenames (no id's needed) | ||
| + | * {{Tl|Querylink}} – generic template to construct [[query string]]s | ||
| + | * [[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]]. | ||
| + | |||
| + | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | ||
| + | <!-- Categories go here and interwikis go in Wikidata. --> | ||
| + | [[Category:Diff templates]] | ||
| + | [[Category:Special page templates]] | ||
| + | }}</includeonly> | ||
Revision as of 21:38, 8 December 2017
| 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. |
| This template is used on 27,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.
Transclusion count updated automatically (see documentation). |
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.
Contents
Usage
{{Diff|title|diff|oldid|label|diffonly=yes}}
titleTemplate:SndsThe title of the page (optional in most cases).diffTemplate:SndsThe ID or keyword that is used against the base ID. Possible keywords are:curTemplate:Sndscompare with the current version of a page.prevTemplate:Sndscompare with the previous version of a page.nextTemplate:Sndscompare with the next version of a page.- idTemplate:SndsThis should be larger than
oldid.
oldidTemplate:SndsThe base ID onto which the diff is generated.labelTemplate:SndsText to display as link (optional)Template:Nsmdnsno label will generate a numbered link as the label.|diffonly=yesTemplate:SndsDisplays the page comparisons only (optional)Template:Nsmdnsparameter 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 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}}
|
Diff between a numbered version and the previous version
This is the form that would be used most often.
|
{{Template:Uu|Foobar|616706711|616706707|Diff between two numbered versions of a page}}
|
Diff between two numbered versions of a page
|
{{Template:Uu||616706711|616706707|Diff between two numbered versions of a page without title parameter}}
|
Diff between two numbered versions of a page without title parameter
|
{{Template:Uu|Wikipedia:Pagediff|204934693|204901573|Diff between two numbered versions of a page in Wikipedia namespace}}
|
Diff between two numbered versions of a page in Wikipedia namespace
|
{{Template:Uu|Main Page|next|204901573|Diff between a numbered version and the subsequent version}}
|
Diff between a numbered version and the subsequent version
|
{{Template:Uu|Main Page|cur|204901573|Diff between a numbered version and the current version of a page}}
|
Diff between a numbered version and the current version of a page
|
{{Template:Uu|Main Page|cur||Diff showing the most recent change to a page}}
|
Diff showing the most recent change to a page
|
{{Template:Uu|Main Page||204901573|A link to a numbered version of a page}}
|
A link to a numbered version of a page
|
{{Template:Uu|Main Page|204901573|202506579|Comparison display without page display of two numbered versions of a page |diffonly=yes}}
|
Comparison display without page display of two numbered versions of a page
|
TemplateData
TemplateData for Diff
Syntax error in JSON.
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.