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

From blackwiki
Jump to navigation Jump to search
imported>Frietjes
imported>Zyxw
m (note Lua module used, update link to tracking category, add template category)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
 +
{{Lua|Module:Check for unknown parameters}}
  
 
==Usage==
 
==Usage==
Line 42: Line 43:
  
 
== Tracking categories ==
 
== Tracking categories ==
* [[:Category:Pages using category pair with no output]]
+
* {{clc|Pages using category pair with no output}}
 
: 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
 
: 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
* [[:Category:Pages using category pair with more than 2 parameters]]
+
* {{clc|Pages using category pair with more than 2 parameters}}
 
: See above: [[#Error checking|Error checking]]
 
: See above: [[#Error checking|Error checking]]
  
Line 56: Line 57:
 
[[Category:Internal category-link templates]]
 
[[Category:Internal category-link templates]]
 
[[Category:Hatnote templates for category pages]]
 
[[Category:Hatnote templates for category pages]]
 +
[[Category:Templates that add a tracking category]]
 
}}
 
}}
 
</includeonly>
 
</includeonly>

Revision as of 02:40, 8 February 2019

Usage

Place

on the top of the category page, replacing "CATEGORY NAMEn" with the names only of the target categories, leaving out the term "Category:".

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:

on the top of the category page, replacing "CATEGORY NAME1" with the name only of the target category, leaving out the term "Category:".

If there is no preceding category, then leave the first parameter empty, and simply place:

on the top of the category page, replacing "CATEGORY NAME2" with the name only of the target category, leaving out the term "Category:".

Examples

Preceding and succeeding categories, both exist
Preceding category only, which exists
Succeding category only, which exists
Preceding and succeeding categories, only preceding exists
Preceding and succeeding categories, only succeeding exists
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 Template: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