Template:Category series navigation/doc: Difference between revisions
Tom.Reding (talk | contribs) →Testing: +|testcase= |
Tom.Reding (talk | contribs) m Update; rem stale 2 year old notice, currently stable and in high-use (45k) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
{{High-use| |
{{High-use|44686}} |
||
{{Improve documentation}} |
{{Improve documentation}} |
||
{{Lua|Module:Navseasoncats/navyear}} |
{{Lua|Module:Navseasoncats/navyear}} |
||
==About== |
==About== |
||
This template is for categories only - originally intended for football seasons etc which span two years but the new version is much more flexible. Automatically creates a navbox linking to 3 seasons either side assuming that PAGENAME is of the form \"(foo) 2015(-16) (bar)\". Foo, bar and -16 are all now optional and it now works with decades so it can cope with eg {{cl|1999 in Scotland}}, {{cl|Austrian football clubs 1999–2000 season}} and {{cl|Novels set in the 1990s}}. It only works from 1000AD onwards, and it can only handle nnnn-nn in consecutive years, so 2000-01 works but not 2000-05 which you get in eg parliament categories. |
|||
==Usage== |
==Usage== |
||
Revision as of 12:30, 28 February 2019
 | This is a documentation subpage for Template:Category series navigation. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 526,000 pages, or roughly 1% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
 | This template's documentation is missing, inadequate, or does not accurately describe its functionality or the parameters in its code. Please help to expand and improve it. |
 | This template uses Lua: |
About
This template is for categories only - originally intended for football seasons etc which span two years but the new version is much more flexible. Automatically creates a navbox linking to 3 seasons either side assuming that PAGENAME is of the form \"(foo) 2015(-16) (bar)\". Foo, bar and -16 are all now optional and it now works with decades so it can cope with eg Category:1999 in Scotland, Category:Austrian football clubs 1999–2000 season and Category:Novels set in the 1990s. It only works from 1000AD onwards, and it can only handle nnnn-nn in consecutive years, so 2000-01 works but not 2000-05 which you get in eg parliament categories.
Usage
- Typical usage
{{Navseasoncats}}
- Specify a minimum year to display
{{Navseasoncats|min=1753}}
- Specify a minimum and maximum year to display
{{Navseasoncats|min=1753|max=1810}}
- Specify a maximum year to display
{{Navseasoncats|max=1753}}
Testing
To test the output of the template on a particular category name, use the |testcase= parameter:
{{Navseasoncats|testcase=Birds described in 1901}}
Errors
If the template fails to generate a navbox, it displays an error message and places the page in a tracking category:
- Category:Navseasoncats failed to generate navbox (population:0)
See also
- {{Category in year}}
- {{Year by category}}