Module:Category series navigation/doc: Difference between revisions

Latest revision as of 01:14, 6 February 2025

Lua error in package.lua at line 80: module 'Module:Yesno' not found. Script error: No such module "High-use". Lua error in package.lua at line 80: module 'Module:Yesno' not found. Script error: No such module "Sidebar".

About[edit source]

{{Category series navigation}} is intended to be a minimal-input, near-universal template for automatically navigating most numerically adjacent categories.

Recognized category types
Type	Example category	BC(E)?	Example output
Season	2001–02 FA Cup	No	Template:Category series navigation
TV season	Futurama season 1 episodes	–	Template:Category series navigation
Office term (regular)	MEPs 2004–2009	No	Template:Category series navigation
Office term (irregular)	Wales AMs 2003–2007	No	Template:Category series navigation
Numerical range	Taxonbars with 30–34 taxon IDs	–	15–19 20–24 25–29 30–34 35–39 40–44 45–49
Decade	1990s in Scotland	BC	Template:Category series navigation
Year	1999 in Scotland	BC(E)	Template:Category series navigation
Year (auto-condensed)	Candidates in the 2000 US presidential election	–	Template:Category series navigation
Year (`\|skip-gaps=yes`)	Amusement parks opened in 1877	–	Template:Category series navigation
Ordinal (temporal)	2nd-century rabbis	BC(E)	Template:Category series navigation
Ordinal (numeric)	9th Lok Sabha	–	Template:Category series navigation
Ordinal (word)	First Dynasty of Egypt	–	Template:Category series navigation
Roman numeral	Deputies of Legislature X of the Kingdom of Italy	–	Template:Category series navigation

Mixed decade	1760s in the Province of Quebec (1763–1791)	–	Template:Category series navigation
Mixed year	1778 establishments in the Province of Quebec (1763–1791)	–	Template:Category series navigation

Searching behavior[edit source]

Most multi-year seasons/office terms/numerical ranges are acceptable, as long as the season duration/term length/range size is <= Template:Category series navigation, and the gap between seasons is <= Template:Category series navigation. For series exceeding either of these criteria, see/use {{Irregular category series navigation}}.

The length of each season is automatically determined from the originating category name, up to and including Template:Category series navigation years. MOS:DATERANGE compliance is preferred, but some deviation is allowed and tracked for regular series with seasons > 1 year long. {{Category redirect}}s are followed, and tracked for either MOS contravention (to be corrected) or for navigational aid (no error). The gap size between successive seasons is also automatically determined, up to and including Template:Category series navigation years, and defaults to 0 (e.g. 1995–96 → 1996–97).

Automatically condensed years are supported for presidential categories only (but can be easily expanded as needed), for gaps up to and including Template:Category series navigation years, and defaults to 1. To skip gaps of up to Template:Category series navigation years in any year categories, use |skip-gaps=yes.

Limitations[edit source]

Numerical limitations and AD/BC/E[edit source]

Season/office term categories do not work for any years BC, which will be hidden, because no working examples were found.
Decade categories recognize BC, but not BCE, because no working examples were found.
Ordinal & numeral words do not work above the ninety-ninth & ninety-nine, because no working examples were found.

Condensation[edit source]

Automatically condensed Olympics display is not supported due to peculiarities; use {{Winter Olympics by year category navigation}}, etc., instead.
Automatically condensed years are supported for US presidential categories only, due to their consistency; use |skip-gaps=yes as desired on other year categories.
|skip-gaps=yes currently only works when starting on a year category, and is not intended to find all hyphenated ranges, which allows it to span much larger gaps.

Work-arounds[edit source]

Base-name changes: create at least 2 logically numbered {{R from category navigation}} (1 backward & 1 forward), to join both related series.
Unaccounted-for name+number conventions: where a fixed number is part of the prefix or suffix text, e.g. Chapter 11 bankruptcies, a non-breaking space may force the template to work. See this fix, where {{title year}} skipped over 11 as part of a word rather than a discrete number. (This case has been accounted for and is no longer required in this example.)
General: for large, permanent gaps^† between successive categories, use {{Preceding category}}, {{Category pair}}, {{Succeeding category}}, as needed, in addition to {{Category series navigation}} on both sides, or in the middle, of the gap. Even if {{Category series navigation}} is isolated, it has the benefit of confirming the absence of nearby categories to the reader or maintainer.
^†Permanent gaps, where there is a confirmed permanent absence of data, and not just a temporary, yet to be filled, gap on Wikipedia.
|skip-gaps=: create {{R from category navigation}} from an appropriate year to the hyphenated category that was not found.

Related CfDs[edit source]

Usage[edit source]

Typical usage

<syntaxhighlight inline lang="wikitext">Template:Category series navigation</syntaxhighlight>

Specify a minimum and/or maximum year to display

<syntaxhighlight inline lang="wikitext">Template:Category series navigation</syntaxhighlight>
<syntaxhighlight inline lang="wikitext">Template:Category series navigation</syntaxhighlight>
<syntaxhighlight inline lang="wikitext">Template:Category series navigation</syntaxhighlight>
<syntaxhighlight inline lang="wikitext">Template:Category series navigation</syntaxhighlight>

To skip gaps in year categories

<syntaxhighlight inline lang="wikitext">Template:Category series navigation</syntaxhighlight>

To not automatically follow {{Category redirect}}s

<syntaxhighlight inline lang="wikitext">Template:Category series navigation</syntaxhighlight>

Exceptional cases

<syntaxhighlight inline lang="wikitext">Template:Category series navigation</syntaxhighlight> — to behave as if placed on |cat=; consider using {{Category pair}} instead of |cat=

Testing & debugging[edit source]

To test the output of the template on a particular category name, use the |testcase= parameter, and |testcasegap= if necessary:

<syntaxhighlight lang="wikitext" inline>Template:Category series navigation</syntaxhighlight> →

Template:Category series navigation
To see all links produced and/or tested, and what effect each has on their display, use |list-all-links=yes:

<syntaxhighlight lang="wikitext" inline>Template:Category series navigation</syntaxhighlight> →

Category:Nations at the 2006 World Athletics Championships (2006) (2006)
Category:Nations at the 2007 World Athletics Championships (2007) (2007)
Category:Nations at the 2008 World Athletics Championships (2008)
Category:Nations at the 2008–2009 World Athletics Championships (2008–2009) (tried; not displayed)²
Category:Nations at the 2008–09 World Athletics Championships (2008–09) (tried; not displayed)⁴
Category:Nations at the 2009 World Athletics Championships → Category:Nations at the 2009 World Championships in Athletics (2009)
Category:Nations at the 2011 World Athletics Championships → Category:Nations at the 2011 World Championships in Athletics (2011)
Category:Nations at the 2015 World Athletics Championships → Category:Nations at the 2015 World Championships in Athletics (2015)
Category:Nations at the 2017 World Athletics Championships → Category:Nations at the 2017 World Championships in Athletics (2017)
Category:Nations at the 2019 World Athletics Championships (2019)
Category:Nations at the 2020 World Athletics Championships (2020)
Category:Nations at the 2020–2021 World Athletics Championships (2020–2021) (tried; not displayed)²
Category:Nations at the 2020–21 World Athletics Championships (2020–21) (tried; not displayed)⁴
Category:Nations at the 2021 World Athletics Championships (2021)
Category:Nations at the 2021–2022 World Athletics Championships (2021–2022) (tried; not displayed)²
Category:Nations at the 2021–22 World Athletics Championships (2021–22) (tried; not displayed)⁴

All possible element types are shown above (blue, red/grey, hidden, and redirect), and would otherwise display as:

2006
2007
2008
2009
2011
2013
2015
2017
2019
2020
2021

If |list-all-links=yes is used on a hyphenated category, then all tested categories will also be shown:

<syntaxhighlight lang="wikitext" inline>Template:Category series navigation</syntaxhighlight> →

Extended content

Tracking categories[edit source]

Script error: No such module "Purge".

If the template encounters an issue, it displays an error message and/or places the category into one or more of the following tracking categories:

Template:Columns-start

Maintenance required[edit source]

Maintenance possible[edit source]

Module maintenance possible[edit source]

Template:Column

Tracking only[edit source]

Template:Columns-end