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

From blackwiki
Jump to navigation Jump to search
imported>Tom.Reding
(→‎See also: +{{tl|Navseasoncats}} — for similarly named sequential categories)
imported>Tom.Reding
(→‎Usage: Simplify, formatting, tidy)
Line 5: Line 5:
  
 
==Usage==
 
==Usage==
Place
+
* For 2 adjacent categories, a preceding <code>Category:NAME1</code>, and a succeeding <code>Category:NAME2</code>, place:
* {{tlx|Category pair|CATEGORY NAME1|CATEGORY NAME2}}
+
: {{tlx|Category pair|NAME1|NAME2}}
on the top of the category page, replacing "<code>CATEGORY NAMEn</code>" with the ''names only'' of the target categories, leaving out the term "<code>Category:</code>".
+
: at the top of the category page. Each category is displayed only if it exists. If neither category exists, nothing will be displayed.
  
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:
 +
: {{tlx|Category pair|NAME1}}
 +
: an the top of the category page.
  
If there is no succeeding category, you may simply place:
+
* If there is no preceding category, then leave the first parameter empty, and simply place:
* {{tlx|Category pair|CATEGORY NAME1}}
+
: {{tlx|Category pair|<nowiki></nowiki>|NAME2}}
on the top of the category page, replacing "<code>CATEGORY NAME1</code>" with the ''name only'' of the target category, leaving out the term "<code>Category:</code>".
+
: an the top of the category page.
 
 
If there is no preceding category, then leave the first parameter empty, and simply place:
 
* {{tlx|Category pair|<nowiki> </nowiki>|CATEGORY NAME2}}
 
on the top of the category page, replacing "<code>CATEGORY NAME2</code>" with the ''name only'' of the target category, leaving out the term "<code>Category:</code>".
 
  
 
==Examples==
 
==Examples==

Revision as of 01:34, 1 May 2019

Usage

  • 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

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

Only the first two parameters are processed. Others are ignored.

If more than two parameters are supplied, the template is unlikely to do what the editor intended e.g.

  • {{tlx|Category pair|CATEGORY NAME1|CATEGORY NAME2|CATEGORY NAME3}} will ignore CATEGORY NAME3
  • {{tlx|Category pair|CATEGORY NAME1||CATEGORY 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