Difference between revisions of "Template:Category pair/doc"

From blackwiki
Jump to navigation Jump to search
imported>Tom.Reding
(→‎Usage: Typical usage should be on dissimilar preceding/succeeding categories, or where a large gap exists in otherwise sequential categories. For similarly named sequential categories with gaps less than 5 years, use {{tl|Navseasoncats}} instead.)
imported>JJMC89
Line 44: Line 44:
  
 
If more than two parameters are supplied, the template is unlikely to do what the editor intended. For <code>Category:NAME1</code>, <code>Category:NAME2</code>, and <code>Category:NAME3</code>, for example:
 
If more than two parameters are supplied, the template is unlikely to do what the editor intended. For <code>Category:NAME1</code>, <code>Category:NAME2</code>, and <code>Category:NAME3</code>, for example:
* <code><nowiki>{{tlx|Category pair|NAME1|NAME2|NAME3}}</nowiki></code> will ignore <code>Category:NAME3</code>, and
+
* {{tlc|Category pair|NAME1|NAME2|NAME3}} will ignore <code>Category:NAME3</code>, and
* <code><nowiki>{{tlx|Category pair|NAME1||NAME2}}</nowiki></code> will ignore <code>Category:NAME2</code>, because a duplicate <code>|</code> character between the two categories causes <code>Category:NAME2</code> to be the third parameter rather the second.
+
* {{tlc|Category pair|NAME1||NAME2}} will ignore <code>Category:NAME2</code>, because a duplicate <code>|</code> character between the two categories causes <code>Category:NAME2</code> to be the third parameter rather the second.
  
 
== Tracking categories ==
 
== Tracking categories ==

Revision as of 03:29, 10 June 2019

Usage

Typical usage should be on dissimilar preceding/succeeding categories, or where a large gap exists in otherwise sequential categories. For similarly named sequential categories with gaps less than 5 years, use {{Navseasoncats}} instead.

  • For 2 adjacent categories, a preceding Category:NAME1, and a succeeding Category:NAME2, place:
{{Category pair|NAME1|NAME2}}
at the top of the category page. Each category is displayed only if it exists. If neither category exists, nothing will be displayed.
  • If there is no succeeding category, you may simply place:
{{Category pair|NAME1}}
an the top of the category page.
  • If there is no preceding category, then leave the first parameter empty, and simply place:
{{Category pair||NAME2}}
an the top of the category page.

Examples

Preceding and succeeding categories, both exist
Preceding category only, which exists
Succeding category only, which exists
Preceding and succeeding categories, only preceding exists
  • {{Category pair|1934 British Empire Games|1942 British Empire Games}}
Preceding and succeeding categories, only succeeding exists
  • {{Category pair|1946 British Empire Games|1954 British Empire and Commonwealth Games}}
Two non-existent categories, so no output

Error checking

Only the first two parameters are processed, others are ignored.

If more than two parameters are supplied, a warning message is shown when the page is previewed. When it is saved, the page is added to the hidden tracking category: Category:Pages using category pair with more than 2 parameters.

If more than two parameters are supplied, the template is unlikely to do what the editor intended. For Category:NAME1, Category:NAME2, and Category:NAME3, for example:

  • {{Category pair|NAME1|NAME2|NAME3}} will ignore Category:NAME3, and
  • {{Category pair|NAME1||NAME2}} will ignore Category:NAME2, because a duplicate | character between the two categories causes Category:NAME2 to be the third parameter rather the second.

Tracking categories

If neither parameter is a category which currently exists the template will produce no output. This is not necessarily an error; the other categories may simply be part of an incomplete series which will be completed in due course
See above: Error checking

See also