Template:Given name/sandbox

This page or section lists people that share the same given name. If an internal link led you here, you may wish to change that link to point directly to the intended article.

This is the template sandbox page for Template:Given name (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

This template is used on approximately 20,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 template adds an automatically generated short description. If the automatic short description is not optimal, replace it by adding {{Short description}} at the top of the article.

Template:{{given name}} is only for use on Wikipedia set index articles.

It is not for and should not be used on disambiguation pages! The template will not render output if transcluded on a page that ends with "(disambiguation)" and its title will sort in Category:Wikipedia page transclusions with strong class errors until corrected.

When disambiguation pages have lists of people by given name, among the ambiguous clarifications, on the page, therein made: set |1= to "given name" in the {{disambiguation}} template (for example, {{Disambiguation|given name}}). This will sort the disambiguation page in Category:Disambiguation pages with given-name-holder lists.

Usage

When a page is titled in the following form: "Name (given name)" where "Name" is any given name and "(given name)" is the parenthetical index identifier, use template "{{given name}}"; placed at the bottom of a page to identify it as a set index article and, without parameters, will render text in broad generalizations. For example, the introduction says: "this page or section" lists ...". For more specific text, use |page= or |section= to modify the template's output to say: "this page lists ..." or "this section lists ..." respectively.

By default, articles that include this template will be auto-categorized into Category:Given names. To override this functionality:

Use cat=name of category when the category should be changed to something else.
Example: {{Given name|cat=Welsh given names}}
Use cat=none when no category should be included at all (e.g. when using as an example in discussion or template documentation).
Example: {{Given name|cat=none}}

If it's just for a section, you can say so:

Example: {{Given name|section=y}}

Multiple categories are also possible. To accomplish this, use cat1= for the first category, cat2= for the second, and so on. Note that this will auto-categorize the article into Category:Given names.

Example: {{Given name|cat1=Welsh given names|cat2=English given names}}

cat= can still be used with multiple categories to suppress auto-categorization into Category:Given names:

Example: {{Given name|cat=English given names|cat1=French given names|cat2=German given names}}

Pages that include both given names and family names may be tagged with type=both. This adjusts the displayed text accordingly, and obviates the need to include multiple templates.

Example: {{Given name|type=both}}

However, category names must still be provided in full.

Example: {{Given name|type=both|cat1=Welsh given names|cat2=Welsh surnames}}

In addition, cat= must still be used in order to avoid auto-categorization into Category:Given names and Category:Surnames:

Example: {{Given name|type=both|cat=Welsh given names|cat1=English given names|cat2=Welsh surnames}}

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Given name in articles based on its TemplateData.

TemplateData for Given name

Indicates that an article is about a given name. Typically, such articles contain a list of notable people with this name.

Template parameters[Edit template data]
Parameter		Description	Type	Status
section	`section`	no description	Unknown	optional
page	`page`	no description	Unknown	optional
Type	`type`	If set to "both", it indicates that the article also covers people having the same name as their surname. Example both	String	optional
nocat	`nocat`	no description	Unknown	optional
First category	`cat` `cat1` `1`	The first category to categorize the article into. Example Welsh given names	String	optional
Second category	`cat2` `2`	The second category to categorize the article into.	String	optional
Third category	`cat3`	The third category to categorize the article into.	String	optional
cat4	`cat4`	no description	Unknown	optional
cat5	`cat5`	no description	Unknown	optional
cat6	`cat6`	no description	Unknown	optional
cat7	`cat7`	no description	Unknown	optional
cat8	`cat8`	no description	Unknown	optional
cat9	`cat9`	no description	Unknown	optional