View source for Template:Set index article/doc

{{Documentation subpage}}
{{High-risk}}
This is the {{tl|Set index article}} template.

It can be used without any parameters to mark a page as a generic [[Wikipedia:Set index articles|set index article]]. Like this:

:{{tlc|Set index article}}

Which renders like this:

{{Set index article|nocat=true}}

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

==Parameters==
===Type===
This template can also be fed a name of a type of set index article. For instance like this:

:{{tlc|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:

{{Set index article|comics|nocat=true}}

====Accepted types====
{{column|num=3
|
* 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=====
* scottish island = [[:Category:Scottish Island set index articles]]
* chemistry = [[:Category:Set index articles on chemistry]]

===Sort key===
To add a category [[WP:SORTKEY|sort key]], use for example:

:{{tlc|Set index article|comics|(sort key)}}

or if no type is given (note the double pipe):

:{{tlc|Set index article|{{!}}(sort key)}} <!-- {{tlc}} doesn't respect || so we use {{!}} -->

Defaults to first letter of article title.

== Technical details ==
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 ==
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==
<templatedata>
{
	"params": {
		"1": {
			"label": "Subcategory",
			"description": "Subcategorizes the article into a subcategory of set index articles",
			"example": "comics",
			"type": "line",
			"suggested": true
		},
		"2": {
			"label": "Sort key",
			"description": "Includes category sort key"
		},
		"page-title": {
			"description": "Changes page title in link"
		},
		"nocat": {
			"description": "Suppresses categorization",
			"type": "boolean"
		},
		"demospace": {
			"description": "Use when demo-ing the template"
		}
	},
	"description": "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."
}
</templatedata>

== See also ==
* {{tl|Given name}} and {{tl|Surname}} for set index articles about names
* {{tl|Lake index}} – For lists of lakes that share the same name 
* {{tl|Mountain index}} – For set index articles about mountain names
* {{tl|Animal common name}} - for set index articles on animal species with the same common name
* {{tl|Plant common name}} – For set index articles on plant species (or higher taxonomic groups) with the same common name
* {{tl|Ship index}} – For lists of ships with the same or similar names
* {{tl|Sport index}} – For sport related set index articles
* {{tl|Disambiguation}} – The generic disambiguation message box
* [[Wikipedia:Set index articles]]
* [[Wikipedia:Disambiguation]]
* [[Wikipedia:WikiProject Disambiguation]]

<includeonly>{{Sandbox other||
[[Category:Set index article templates| ]]
}}</includeonly>