Template:auto cat/documentation

	Documentation for Template:auto cat. [edit]
	This page contains usage information, categories, interwiki links and other content describing the template.

Uses Lua:

• Module:category tree

This template is used on category pages to automatically add a category boilerplate template. It deciphers the category name and transcludes the correct template with the correct parameters.

No parameters are needed in most cases. A few categories have optional or required parameters to help out the categorization; see below.

Note: all categories should now be handled by {{auto cat}}. See Module:category tree/poscatboiler/data/documentation for more information, and for specifics regarding the category tree.

Most categories have an Edit category data button in the upper right that takes you directly to the module that implements the category.

To more easily add this template, place importScript('User:Erutuon/addAutoCat.js'); in your common.js. This will add buttons directly below the first heading. Click them to add the template and save, or add the template and preview.

Some categories allow or require parameters to {{auto cat}} to help out categorization.

These are categories are categories such as Category:Latin terms suffixed with -inus and Category:Japanese terms prefixed with 真っ. The types of affixes currently recognized are prefix, suffix, infix, interfix, circumfix and transfix. For these categories, the following parameters are allowed (none are required):

|alt=

The affix with diacritics. Only needed for languages with extra diacritics in their headwords (e.g. Latin, Russian, Arabic and Old English), and only if those diacritics are present. For example, for Category:Latin terms suffixed with -inus, specify {{auto cat|alt=-īnus}} so that the suffix in the category description, and the breadcrumb at the top of the page, are displayed as -īnus, with a macron.

|sort=

The sort key. Mostly only needed for Japanese. For example, for Category:Japanese terms prefixed with 真っ, use {{auto cat|sort=まっ}} so that the page is properly sorted in its parent category Category:Japanese terms by prefix.

|tr=

Manual transliteration. Occasionally needed for non-Latin-script languages if the automatic transliteration is incorrect or if the language doesn't have automatic transliteration (e.g. Persian and Hebrew).

|sc=

Script code. Almost never needed.

These are categories such as Category:French language and Category:Proto-Indo-European language. These are the root categories for the various languages represented in Wiktionary. These categories have required parameters specifying the country or countries where the language is spoken, as well as additional optional parameters:

|1=, |2=, |3=, ...

The country or countries where the language is spoken. See Category:Languages by country and its subcategories. Make sure to include the word the if warranted, e.g. the Philippines or the United States. At least one country is required unless the language is reconstructed (e.g. Proto-Indo-European) or constructed/artificial (e.g. Esperanto). If the country is truly unknown, use the value UNKNOWN.

|extinct=1

Specify that this language is extinct (no longer spoken).

|setwiki=

The name of the Wikipedia article about the language to link to. If omitted, the Wikipedia article in the language's wikidata entry or the language's category name will be used (e.g. French language). Specify |setwiki=- to show no Wikipedia article link. Preferably, the wikidata entry for the language should be added to the language's data file rather than specified manually in this template.

|setwikt=

The code of the language's Wiktionary edition. If omitted, the Wiktionary language code for the language will be used. Specify |setwikt=- to show no Wiktionary edition link.

|setsister=

The name of the category on Wikimedia Commons with files related to the language. If omitted, the category name will be used (e.g. French language). Specify |setsister=- to show no Commons category link.

|entryname=

The English term on this Wiktionary to link to. If omitted, the canonical name of the language will be used (e.g. French). Specify |entryname=- to show no entry link.

These are categories that refer to regional, temporal and sociolectal varieties of languages such as Category:Latin American Spanish (regional), Category:Early Modern English (temporal) and Category:Classical Persian (sociolectal), including those that don't have the containing language in their name (e.g. Category:Provençal and Category:Dari) or have only part of the containing language in their name (e.g. Category:Walser German, which is a variety of the Alemannic German language and not a variety of German). Because of the diversity of naming conventions, {{auto cat}} won't recognize or process such categories unless |lect=1 is given. The handler in {{auto cat}} that handles such categories will attempt to infer the relevant properties of the lect in various ways:

1. It will infer some default properties from the name of the lect itself. For example Category:Jakarta Indonesian is assumed to be a variety of Indonesian and spoken in Jakarta.
2. It will look for a language-specific label that categorizes into the category in question. If and only if the label definition of that label has a parent field, the relevant fields of the label definition will be used to establish the lect's properties. This is now the preferred method of specifying a lect's properties, because it centralizes all information about the lect in the language-specific label modules. As an example, consider the category Category:Javanese Indonesian. The Indonesian label data module Module:labels/data/lang/id defines a label Java that has the setting regional_categories = "Javanese" (causing that label to categorize into Category:Javanese Indonesian) and also has a setting parent = "Indonesia" (indicating that the label is a lect whose parent lect is defined by the Indonesia label). As a result of the parent setting, the properties of the Java label will be taken from the fields specified for this label, such as prep = "on" and region = "the island of ]", which together cause the description of the category to read Terms or senses in Indonesian as spoken on the island of Java. (See below for fields like prep and region.) The value of the parent field, Indonesia, will cause the category associated with that label (Category:Indonesian Indonesian) to be the parent category of Category:Javanese Indonesian. Top-level lects should use parent = true, which puts them directly under e.g. Category:Regional Indonesian (unless noreg = true is also given, in which case they go under the higher-level category Category:Varieties of Indonesian; non-regional lects such as Category:Classical Indonesian and Category:Prokem Indonesian should use this). NOTE: The value of the parent field is a label, not a category. Labels and categories do not have to match exactly in name (cf. the label Java vs. the corresponding category Category:Javanese Indonesian, and the label Indonesia vs. the corresponding category Category:Indonesian Indonesian). However, if they do not match, the connection between them should still be clear.
3. It will take properties from parameters directly specified to {{auto cat}}. Generally, the same recognized parameters to {{auto cat}} (described below) have the same names and semantics as the fields in label definitions that control lect properties.

In the above list, properties specified lower down override those specified higher-up. In other words, default properties inferred from the name itself are overridden by properties derived from a lect label that categorizes into the category in question, which are in turn overridden by properties directly specified by {{auto cat}} parameters.

The following parameters are recognized to {{auto cat}}, which are listed along with the corresponding fields in the lect label definition:

1. For Category:Hong Kong English, use:

{{auto cat|lect=1|cat=Chinese English}}

Here, |1= does not need to be specified because the inferred description "Hong Kong" is correct. The language is automatically inferred as English (and in any case, this is an etymology-only language with code en-HK, from which the language can be inferred). The parent category is set to Category:Chinese English in place of the default Category:Regional English.

2. For Category:Durham University English, use:

{{auto cat|lect=1|prep=at|{{w|Durham University}} in ]|cat=Durham English|othercat=en:Universities}}

Here, we specify the region description in |1= but the language is automatically inferred as English. The parent category is set to Category:Durham English in place of the default Category:Regional English (which leads to a breadcrumb chain Regional » European » British » English » Northern England » Northumbrian » Durham » Durham University based on parent categories). Category:en:Universities is added as an additional parent category.

3. For Category:Limburgan-Ripuarian transitional dialects, you could use:

{{auto cat|lect=1|lang=gmw-cfr|the tri-state region of <country>|cat=Ripuarian Franconian|country=Belgium,the ],Germany|wp=Southeast Limburgish dialect}}

This is a more complex example. We have to set the language (Central Franconian) explicitly using |lang= because it is not inferrable from the name and the category does not refer to an etymology-only language. The description in |1= contains <country>, which substitutes the countries mentioned in |country= (which also cause the category to be added to Category:Languages of Belgium, Category:Languages of the Netherlands and Category:Languages of Germany. We also specify a parent category and Wikipedia page to link to.

However, this is now handled in the preferred way, using properties of the lect label, as follows (as found in Module:labels/data/lang/gmw-cfr):

labels = {
	region = "the tri-state region of <country>",
	country = "Belgium,the ],Germany",
	aliases = {"Tri-state Limburgish", "Limburgan-Ripuarian", "Southeast Limburgish dialect", "Limburgan-Ripuarian Transitional Dialects"},
	Wikipedia = "Southeast Limburgish dialect",
	plain_categories = "Limburgan-Ripuarian transitional dialects",
	parent = "Ripuarian",
}

4. For Category:Dobhashi, use:

{{auto cat|lect=1|lang=bn|def=a literary register of Bengali that was in common use from the 14th century to the 19th century|type=extinct|noreg=1|wp=1}}

Here, we have to set the language (Bengali), and we override the definition after "Terms or senses in" using |def= in place of specifying |1=. Since this isn't a regional lect, we set |noreg=1 so the parent defaults to Category:Bengali language. We set |type=extinct because this lect is extinct and this cannot be inferred from the parent (which is not extinct). We also use |wp=1 to link to Dobhashi on Wikipedia.

5. For Category:The BMAC substrate, use:

{{auto cat|lect=1|def=the ](s) spoken in the {{w|Bactria–Margiana Archaeological Complex}} and possibly found as a {{w|substratum in Vedic Sanskrit}}|breadcrumb=BMAC}}

Here, the language in question is an etymology-only substrate language whose actual name begins with a lowercase letter (the BMAC substrate), but the lect handler automatically takes care of the mismatch and recognizes the etymology-only language. The type is automatically inferred to be unattested based on it being a substrate language (this is done by checking the code; all substrate language codes begin with qsb-). Based on the type, the default parent is Substrate languages. We set a breadcrumb to override the default breadcrumb The BMAC substrate.

These are categories such as Category:Languages of India and Category:Languages of the United States. These categories contain subcategories for all the languages and sublects spoken in the country in question. The following parameters are allowed (none are required):

|flagfile=

An image file specifying the flag of the country in question, displayed in the upper right corner of the category page. The File: prefix should be omitted. An example is |flagfile=Flag of Afghanistan (2013–2021).svg for Afghanistan. The default is Flag of country.svg; if this file does not exist, no flag is displayed. Use |flagfile=- to cause the flag to be omitted even if the appropriate flag file is present.

|wp=

A link to a Wikipedia article describing the languages of the country, such as Languages of Australia. Use |wp=+ or |wp=1 to specify that the name of the Wikipedia article is the same as the category name.

|commonscat=

A link to a Commons category describing the languages of the country, such as Commons:Category:Languages of Chad. Use |commonscat=+ or |commonscat=1 to specify that the name of the Commons category is the same as the category name.

These are categories such as Category:User fr-4 indicating that the user speaks French at near-native competency. The following parameters are allowed (none are required):

|text=

The native-language text specifying a translation of the English text describing the competency of the users in the category in the language in question. An image file specifying the flag of the country in question, displayed in the upper right corner of the category page. The File: prefix should be omitted. An example is |text=Ces utilisateurs parlent <<français>> à un niveau '''comparable à la langue maternelle'''. for the translation of "These users speak French at a near-native level." The text describing the level of competency should be boldfaced and the text specifying the language should be surrounded in double angle brackets, as shown. The language in double angle brackets will be boldfaced and linked to the higher-level user-competency category (e.g. Category:User fr); in that category, double angle bracket text is linked to the language category (e.g. Category:French language). If the text is omitted, the category is placed in two cleanup categories: Category:Requests for translations in user-competency categories by language and Category:Requests for translations in user-competency categories with ##-## users (e.g. Category:Requests for translations in user-competency categories with 16-31 users). (The purpose of the latter categories is to segment the categories with missing text by number of users so that the ones with more users can be focused on first.)

|verb=

The correct verb to use in the English text, in place of "speak" or (for sign languages) "communicate in". For example, protolanguages may prefer the verb "know".

|langname=

Override the name of the language. This is chiefly used in user competency categories for invalid language codes (e.g. eml for Emiliano-Romagnol; on Wiktionary, this code is represented by two languages, Emilian with code egl and Romagnol with code rgn). Such categories should be actively eliminated by moving the users in them to the nearest valid Wiktionary code and then deleting the category when empty.

These are categories such as Category:English terms spelled with É, Category:Japanese terms spelled with 愛 and Category:Ladino terms derived from the Hebrew root ח־ב־ר. Normally, what follows spelled with is a single character, but occasionally multiple characters are used, as in Category:Ladino terms derived from the Hebrew root ח־ב־ר. For these categories, the following parameters are allowed (none are required):

|sort=

The sort key; used to sort the page in its parent category (e.g. Category:Japanese terms by their individual characters). Only needed if the automatically generated sort key is wrong. Examples are Category:Spanish terms spelled with Î, which should use {{auto cat|sort=I}}, and Category:Japanese terms spelled with 衛, which should use {{auto cat|sort=行10}}. Japanese and Okinawan terms use Module:Hani-sortkey to generate the sort key, but currently this always generates Chinese sort keys, which in rare cases are wrong for Japanese (for example, the autogenerated sort key for Category:Japanese terms spelled with 衛 is 行09 instead of 行10).

|char=

If the category name has a descriptive word in it, such as gershayim, this should be the actual character referred to (in this case, {{auto cat|char=״}}). Otherwise, it should be left out.

|context=, |context2=

Provided for compatibility purposes, but unused.

These are categories such as Category:Japanese terms spelled with 学 read as がく and Category:Okinawan terms spelled with 光 read as ふぃちゃい. These contain terms spelled with individual kanji read in particular ways (where the reading is written in hiragana). These categories have required parameters specifying the type(s) of reading(s):

|1=, |2=, |3=, ... (required)

The reading type(s); one or more of kun, on, goon, kan'on, kan'yōon, tōon, sōon or nanori. For example, Category:Japanese terms spelled with 学 read as がく should use {{auto cat|goon|kan'on}} and Category:Okinawan terms spelled with 光 read as ふぃちゃい should use {{auto cat|kun}}. The particular reading type(s) can often be found on the page dedicated to the kanji in question.

These are categories such as Category:Japanese terms with 諒 replaced by daiyōji 了. These contain terms spelled with specific uncommon kanji that normally have that character replaced by another homophonic character (a daiyōji) chosen only for the sound and not the meaning. These categories have a required parameter specifying the sort key:

|sort= (required)

The sort key; in this case, hiragana representing the pronunciation of the character in question.

These are categories such as Category:Japanese kanji read as ゐ. These are umbrella categories grouping categories for kanji read with specific readings that have specific origins (e.g. kun, on). These categories have the following optional parameters:

|histconsol=modern

Specify that this is a historical reading and that such readings are normally consolidated into the modern reading <var>modern</var> (with modernized pronunciation). A message to this effect appears in the category text.