Template:Set index article/doc
This is a documentation subpage for Template:Set index article. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 6,300 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 is the {{Set index article}} template.
It can be used without any parameters to mark a page as a generic set index article. Like this:
{{Set index article}}
Which renders like this:
It then categorises the page into Category:Set index articles.
Parameters
editType
editThis template can also be fed a name of a type of set index article. For instance like this:
{{Set index article|comics}}
And it will then categorise the page into Category:Set index articles on comics, but no change is made to the template's appearance on-page, which is still:
Accepted types
edit- ancient Greece
- ancient Rome
- animals
- astronomical objects
- books
- cars
- case law
- characters
- comics
- films
- Greek mythology
- lakes
- law
- manga
- mathematics
- military vehicles
- mountains
- newspapers
- plants
- Poland
- populated places in Belarus
- populated places in India
- populated places in Lithuania
- populated places in Poland
- populated places in Russia
- populated places in Ukraine
- rivers
- Russia
- Russian districts
- ships
- snakes
- sports
- television programs
- titles of nobility
- tropical cyclones
- urban okrugs in Russia
- urban settlements in Russia
Special cases
edit- scottish island = Category:Scottish Island set index articles
- chemistry = Category:Set index articles on chemistry
Sort key
editTo add a category sort key, use for example:
{{Set index article|comics|(sort key)}}
or if no type is given (note the double pipe):
{{Set index article||(sort key)}}
Defaults to first letter of article title.
Technical details
editIf the page name starts with "List" it does not show the "If an internal link led you here" sentence, since such pages are not likely to be unintentionally linked to.
This template only categorises a page if the page is in the main (article) space. Thus it will not categorise for instance a talk page or this template page where it might be shown or discussed.
Error handling
editIf there are issues with the parameters used in this template, the page will be put into either the Category:Wikipedia disambig or set index box parameter needs fixing or the Category:Unsynchronized disambiguation talk pages category.
TemplateData
editProduces a notice and categories for a set index article, which lists a set of items of a specific type that also share the same (or similar) name.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Subcategory | 1 | Subcategorizes the article into a subcategory of set index articles
| Line | suggested |
Sort key | 2 | Includes category sort key | Unknown | optional |
page-title | page-title | Changes page title in link | Unknown | optional |
nocat | nocat | Suppresses categorization | Boolean | optional |
demospace | demospace | Use when demo-ing the template | Unknown | optional |
See also
edit- {{Given name}} and {{Surname}} for set index articles about names
- {{Lake index}} – For lists of lakes that share the same name
- {{Mountain index}} – For set index articles about mountain names
- {{Animal common name}} - for set index articles on animal species with the same common name
- {{Plant common name}} – For set index articles on plant species (or higher taxonomic groups) with the same common name
- {{Ship index}} – For lists of ships with the same or similar names
- {{Sport index}} – For sport related set index articles
- {{Disambiguation}} – The generic disambiguation message box
- Wikipedia:Set index articles
- Wikipedia:Disambiguation
- Wikipedia:WikiProject Disambiguation