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,000 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:

This article includes a list of related items that share the same name (or similar names).
If an internal link incorrectly led you here, you may wish to change the link to point directly to the intended article.

It then categorises the page into Category:Set index articles.

Parameters edit

Type edit

This 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:

This article includes a list of related items that share the same name (or similar names).
If an internal link incorrectly led you here, you may wish to change the link to point directly to the intended article.

Accepted types edit

ancient Greece
ancient Rome
animals
astronomical objects
Belarus
books
cars
case law
characters
comics
films
Greek mythology
lakes

law
manga
mathematics
military vehicles
mountains
newspapers
plants
Poland
pop
populated places in India
populated places in Poland
populated places in Russia

rivers
Russia
Russian districts
ships
snakes
sports
television programs
titles of nobility
tropical cyclones
populated places in Ukraine
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 edit

To 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 edit

If 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 edit

If 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 edit

Produces 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.

Template parameters
Parameter		Description	Type	Status
Subcategory	`1`	Subcategorizes the article into a subcategory of set index articles Example comics	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