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

From blackwiki
Jump to navigation Jump to search
imported>Tom.Reding
(→‎Usage: Simplify, formatting, tidy)
imported>Tom.Reding
m (→‎top: Update)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
{{High-use|19377}}
+
{{High-use|3007}}
 
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
 
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
 
{{Lua|Module:Check for unknown parameters}}
 
{{Lua|Module:Check for unknown parameters}}

Revision as of 00:54, 2 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