Template:Navseasoncats/doc
This is a documentation subpage for Template:Navseasoncats. It contains usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 230,000 pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them. |
This template uses Lua: |
Related pages |
---|
About[edit source]
Type | Example category | BC(E)? | Example output | |
---|---|---|---|---|
Season | 2001–02 FA Cup | No |
| |
TV season | Futurama (season 1) episodes | – |
| |
Office term (regular) | MEPs 2004–2009 | No |
| |
Office term (irregular) | Wales AMs 2016–2021 | No |
| |
Numerical range | Taxonbars with 30–34 taxon IDs | – | Lua error: too many expensive function calls. | |
Decade | 2020s awards | BC | Lua error: too many expensive function calls. | |
Year | 1999 in Scotland | BC(E) | Lua error: too many expensive function calls. | |
Year (auto-condensed) | Candidates in the 2000 US presidential election | – | Lua error: too many expensive function calls. | |
Year (|skip-gaps=yes) | Nations at the 1980 World Championships in Athletics | – | Lua error: too many expensive function calls. | |
Ordinal (temporal) | 2nd-century rabbis | BC(E) | Lua error: too many expensive function calls. | |
Ordinal (numeric) | 1st Lok Sabha members | – | Lua error: too many expensive function calls. | |
Ordinal (word) | First Dynasty of Egypt | – | Lua error in Module:Navseasoncats at line 1271: attempt to call local 'eng2ord' (a nil value). | |
Roman numeral | Deputies of Legislature X of the Kingdom of Italy | – | Lua error: too many expensive function calls. | |
Mixed decade | 1760s in the Province of Quebec (1763–1791) | – | Lua error: too many expensive function calls. | |
Mixed year | 1778 establishments in the Province of Quebec (1763–1791) | – | Lua error: too many expensive function calls. |
Searching behavior[edit source]
Multi-year seasons/office terms/numerical ranges are acceptable as long as the duration/range size remains constant, and no years/numbers are irregularly skipped. Irregular term lengths are acceptable, if a common year exists between them (e.g. 2000–2001
→2001–2005
). For categories with irregular ranges and gaps, see {{Irregular navseasoncats}}.
The length of each duration/range 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. {{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 durations/ranges is also automatically determined, up to and including 5 years if a surrounding category is found, and defaults to 0 (e.g. 1995–96 → 1996–97).
Automatically condensed year display is 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 up to 10–15 years (position-dependent) in any year categories, use |skip-gaps=yes
.
Limitations[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.
- Automatically condensed year display is supported for
presidential
categories only, due to their consistency. Use|skip-gaps=yes
as desired elsewhere. - Automatically condensed Olympics display is not supported due to peculiarities; use {{Winter Olympics by year category navigation}}, etc., instead.
- Ordinal words do not work above the ninety-ninth, because no higher working examples were found.
- 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 [1], where {{title year}} skipped over "11" as part of a word rather than a discrete number. (This is no longer required in that example.)
- General: for large, permanent gaps between successive categories, or when the base category name changes, use {{Category pair}} in addition to {{Navseasoncats}} on both sides of the gap/name change. Even if {{Navseasoncats}} is isolated, it has the benefit of confirming the absence of nearby categories to the reader or maintainer.
Related CfDs[edit source]
- 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[edit source]
- 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=2026}}
- 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[edit source]
To test the output of the template on a particular category name, use the |testcase=
parameter, and |testcasegap=
if necessary:
{{Navseasoncats | testcase=Birds described in 1761 | min=1758}}
→
Lua error: too many expensive function calls.
{{Navseasoncats | testcase=2025 elections | max=2027}}
→
Lua error: too many expensive function calls.
To see all links produced, 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}}
→
Lua error: too many expensive function calls.
- Technically, this is an inappropriate category for {{Navseasoncats}} placement, but it best shows the
|list-all-links=yes
behavior for all element variants (blue, red/grey, hidden, and redirect), and would otherwise display as:
- Technically, this is an inappropriate category for {{Navseasoncats}} placement, but it best shows the
Lua error: too many expensive function calls.
Tracking categories[edit source]
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[edit source]
- Category:Navseasoncats failed to generate navbox (0)
- Category:Navseasoncats range abbreviated (0)
- Category:Navseasoncats range redirected (MOS) (0)
- Category:Navseasoncats range not using en dash (0)
Maintenance possible[edit source]
- Category:Navseasoncats default season gap size (0)
- Category:Navseasoncats using cat parameter (0)
- Category:Navseasoncats using testcase parameter (0)
- Category:Navseasoncats isolated (0)
Tracking only[edit source]
- Category:Navseasoncats range redirected (base change) (0)
- Category:Navseasoncats range redirected (end) (0)
- Category:Navseasoncats range unredirected (end) (0)
- Category:Navseasoncats range irregular, no gaps (0)
- Category:Navseasoncats range redirected (other) (0)
- Category:Navseasoncats TV season redirected (0)
- Category:Navseasoncats decade redirected (0)
- Category:Navseasoncats year redirected (0)
- Category:Navseasoncats roman numeral redirected (0)
- Category:Navseasoncats nordinal redirected (0)
- Category:Navseasoncats wordinal redirected (0)
- Category:Navseasoncats using skip-gaps parameter (0)
See also[edit source]
- {{Navseasoncats with centuries below decade}}
- {{Navseasoncats with decades below year}}
- {{Irregular navseasoncats}}
- {{Year by category}}
- {{R from category navigation}}