Difference between revisions of "Template:Compare pages/doc"

From blackwiki
Jump to navigation Jump to search
imported>Technical 13
(Starting point... More documentation to go.)
 
imported>Jdaloner
(Made a couple minor tweaks to wording. Widened table in "Examples" section a bit to avoid line wrapping.)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
  
Similar to the {{Tl|Diff}} template, 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.  The major difference is that {{Tlc|Diff}} is intended to show two version of the same page, and this creates a link to [[Special:ComparePages]] to show one version of two different pages.
+
Similar to the {{Tl|Diff}} template, 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.  The major difference is that {{Tlc|Diff}} is intended to show two versions of the same page, and this creates a link to [[Special:ComparePages]] to show one version of two different pages.
  
 
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 link for the timestamp, which is of the form:
 
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 link for the timestamp, which is of the form:
Line 15: Line 15:
 
<!-- ADD IN DETAILS FOR {{{3}}}, {{{label}}}, {{{label1}}}, and {{{label2}}} once the bugs are ironed out. -->
 
<!-- ADD IN DETAILS FOR {{{3}}}, {{{label}}}, {{{label1}}}, and {{{label2}}} once the bugs are ironed out. -->
  
All parameters are required. Omitted parameters will return an error.
+
All parameters are required. Omitting parameters will return an error.
  
 
== Examples ==
 
== Examples ==
 
{| class="wikitable"
 
{| class="wikitable"
! style="width:33%;" | Code !! Output
+
! style="width:40%;" | Code !! Output
 
|-
 
|-
 
| <code><nowiki>{{Compare pages|Foo|Bar}}</nowiki></code>
 
| <code><nowiki>{{Compare pages|Foo|Bar}}</nowiki></code>
Line 88: Line 88:
 
</nowiki>
 
</nowiki>
 
-->
 
-->
 +
  
 
<includeonly>
 
<includeonly>

Revision as of 02:21, 18 December 2014

Similar to the {{Diff}} template, 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. The major difference is that {{Diff}} is intended to show two versions of the same page, and this creates a link to Special:ComparePages to show one version of two different pages.

Every version of a page has a revision ID, which you can find from the history of the page by looking at the link for the timestamp, which is of the form:

http[s]://en.wikipedia.org/w/index.php?title=SomePageName&oldid=442212827

The number after oldid= is the revision ID.

Given a page name and one or two revision IDs, you can construct links to several types of diffs.

Usage

{{Compare pages|page/oldid for page 1|page/oldid for page 2}}
  • page – The title of the page.
  • oldid – The revision ID onto which the diff is generated.

All parameters are required. Omitting parameters will return an error.

Examples

Code Output
{{Compare pages|Foo|Bar}} Template:Plain link

This is the form that would be used most often.

{{Compare pages|Foo}} Two pages are needed to compare.
{{Compare pages||Bar}} Two pages are needed to compare.

See also