Template:Category pair/doc
This is a documentation subpage for Template:Category pair. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 2,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
This template uses Lua: |
Usage
[edit]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 {{Category series navigation}}
instead, and {{Category series navigation|skip-gaps=yes}}
for gaps up to 15 years from the parent.
- For 2 adjacent categories, a preceding
Category:NAME1
, and a succeedingCategory: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}}
- at the top of the category page.
- If there is no preceding category, then leave the first parameter empty, and simply place:
{{Category pair||NAME2}}
- at the top of the category page.
Examples
[edit]- Preceding and succeeding categories, both exist
{{Category pair|1934 FIFA World Cup|1950 FIFA World Cup}}
→
- Preceding category only, which exists
{{Category pair|1934 FIFA World Cup}}
→
- Succeeding category only, which exists
{{Category pair||1950 FIFA World Cup}}
→
- 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
{{Category pair|AD 10 FIFA World Cup|AD 18 FIFA World Cup}}
→
Error checking
[edit]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 ignoreCategory:NAME3
, and{{Category pair|NAME1||NAME2}}
will ignoreCategory:NAME2
, because a duplicate|
character between the two categories causesCategory:NAME2
to be the third parameter rather the second.
Tracking categories
[edit]- 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
[edit]- {{Category series navigation}} — for similarly named sequential categories
- {{Preceding category}}
- {{Succeeding category}}