Module:Navseasoncats/doc
This is the documentation page for Module:Navseasoncats
This is a documentation subpage for Module:Navseasoncats. It contains usage information, categories and other content that is not part of the original module page. |
This Lua module is used on approximately 448,000 pages, or roughly 1118% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
This module depends on the following other modules: |
Related pages |
---|
About
{{Navseasoncats}} is intended to be a minimal-input, near-universal template for navigating most sequential categories.
Type | Example category | BC(E)? | Example output | |
---|---|---|---|---|
Season | 2001–02 FA Cup | No | Lua error in mw.title.lua at line 209: too many expensive function calls. | |
TV season | Futurama (season 1) episodes | – | Lua error in mw.title.lua at line 209: too many expensive function calls. | |
Office term (regular) | MEPs 2004–2009 | No | Lua error in mw.title.lua at line 209: too many expensive function calls. | |
Office term (irregular) | Wales AMs 2003–2007 | No | Lua error in mw.title.lua at line 209: too many expensive function calls. | |
Numerical range | Taxonbars with 30–34 taxon IDs | – |
| |
Decade | 1990s in Scotland | BC | Lua error in mw.title.lua at line 209: too many expensive function calls. | |
Year | 1999 in Scotland | BC(E) | Lua error in mw.title.lua at line 209: too many expensive function calls. | |
Year (auto-condensed) | Candidates in the 2000 US presidential election | – | Lua error in mw.title.lua at line 209: too many expensive function calls. | |
Year (|skip-gaps=yes ) |
Amusement parks opened in 1880 | – | Lua error in mw.title.lua at line 209: too many expensive function calls. | |
Ordinal (temporal) | 2nd-century rabbis | BC(E) | Lua error in mw.title.lua at line 209: too many expensive function calls. | |
Ordinal (numeric) | 1st Lok Sabha members | – | Lua error in mw.title.lua at line 209: too many expensive function calls. | |
Ordinal (word) | First Dynasty of Egypt | – | Lua error in mw.title.lua at line 209: too many expensive function calls. | |
Roman numeral | Deputies of Legislature X of the Kingdom of Italy | – | Lua error in mw.title.lua at line 209: too many expensive function calls. | |
Mixed decade | 1760s in the Province of Quebec (1763–1791) | – | Lua error in mw.title.lua at line 209: too many expensive function calls. | |
Mixed year | 1778 establishments in the Province of Quebec (1763–1791) | – | Lua error in mw.title.lua at line 209: too many expensive function calls. |
Searching behavior
Most multi-year seasons/office terms/numerical ranges are acceptable, as long as the season duration/term length/range size is <= 10, and the gap between seasons is <= 6. For series exceeding either of these criteria, see/use {{Irregular navseasoncats}}.
The length of each season is automatically determined from the originating category name, up to and including 10 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 5 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 5 years, and defaults to 1. To skip gaps of up to 25 years in any year categories, use |skip-gaps=yes
.
Limitations
- Numerical limitations & AD/BC/E
- 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
- 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
presidential
categories only, due to their consistency; use|skip-gaps=yes
as desired elsewhere.
- Work-arounds
- Base-name changes: create at least 2 logically numbered {{R from category navigation}} (1 forward & 1 backward), to join both related series.
- Unaccounted-for name+number conventions: where a fixed number is part of the prefix 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 has been accounted for and is no longer required in this example.)
- General: for large, permanent gaps† between successive categories, use {{Succeeding category}}, {{Preceding category}}, {{Category pair}}, as needed, in addition to {{Navseasoncats}} on both sides, or in the middle, of the gap. Even if {{Navseasoncats}} is isolated, it has the benefit of confirming the absence of nearby categories to the reader or maintainer.
†Permanent gaps, where there is confirmed to be an absence of data, and not just a current, yet to be filled, gap on Wikipedia.
Related CfDs
- Wikipedia:Categories for discussion/Log/2019 June 8#Category:Northern Ireland MLAs 2016–17
- Wikipedia:Categories for discussion/Log/2019 May 29#Category:MEPs 1952–58
- Wikipedia:Categories for discussion/Log/2019 April 19#Category:Aircraft piston engines 1900–1909
Usage
- Typical usage
{{Navseasoncats}}
- Specify a minimum and/or maximum year to display
{{Navseasoncats|min=-100}}
{{Navseasoncats|min=100 BC}}
{{Navseasoncats|min=1753|max=1810}}
{{Navseasoncats|max=2024}}
- To skip gaps in year categories
{{Navseasoncats|skip-gaps=yes}}
- To not automatically follow {{Category redirect}}s
{{Navseasoncats|follow-redirects=no}}
- Exceptional cases
{{Navseasoncats|cat=2010s albums}}
— to behave as if placed on|cat=
; consider using {{Category pair}} instead of|cat=
Testing & debugging
To test the output of the template on a particular category name, use the |testcase=
parameter, and |testcasegap=
if necessary:
{{Navseasoncats |testcase=1770s in the Province of Quebec (1763–1791) |min=1760}}
→
Lua error in mw.title.lua at line 209: too many expensive function calls.
{{Navseasoncats |testcase=1770s in the Province of Quebec (1763–1791) |max=1970s}}
→
Lua error in mw.title.lua at line 209: too many expensive function calls.
To see all links produced and/or tested, and what effect each has on their display, use |list-all-links=yes
:
{{Navseasoncats |testcase=Nations at the 2013 World Athletics Championships |min=2008 |skip-gaps=yes |list-all-links=yes}}
→
- Category:Nations at the 2006 World Athletics Championships (2006) ( )
- Category:Nations at the 2007 World Athletics Championships (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:
Tracking categories
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:
Maintenance required
- Category:Navseasoncats failed to generate navbox (0)
- Category:Navseasoncats redirection error (0)
- Category:Navseasoncats range abbreviated (MOS) (0)
- Category:Navseasoncats range redirected (MOS) (0)
- Category:Navseasoncats range ends (blank, MOS) (0)
- Category:Navseasoncats range not using en dash (0)
- Category:Navseasoncats in mainspace (0)
Maintenance possible
- Category:Navseasoncats isolated (0)
- Category:Navseasoncats default season gap size (0)
- Category:Navseasoncats using cat parameter (0)
- Category:Navseasoncats using testcase parameter (0)
- Category:Navseasoncats using unknown parameter (0)
Module maintenance possible
Tracking only
- Category:Navseasoncats range redirected (base change) (0)
- Category:Navseasoncats range redirected (end) (0)
- Category:Navseasoncats range gaps (0)
- Category:Navseasoncats range irregular (0)
- Category:Navseasoncats range irregular, 0-length (0)
- Category:Navseasoncats range ends (present) (0)
- Category:Navseasoncats TV season redirected (0)
- Category:Navseasoncats decade redirected (0)
- Category:Navseasoncats year redirected (base change) (0)
- Category:Navseasoncats year redirected (var change) (0)
- Category:Navseasoncats roman numeral redirected (0)
- Category:Navseasoncats nordinal redirected (0)
- Category:Navseasoncats wordinal redirected (0)
- Category:Navseasoncats using skip-gaps parameter (0)
- Category:Navseasoncats year and range (0)
- Category:Navseasoncats year and decade (0)
- Category:Navseasoncats decade and century (0)
See also