View source for Template:Given name/doc

<noinclude>{{pp-template|small=yes}}</noinclude>{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{High-use}}
{{Transclude only}} 
{{Auto short description}}

Template:'''{{tlc|given name}}''' is ''only for use'' on Wikipedia [[Wikipedia:Set index articles|set index article]]s. 

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 {{para|1}} to "given name" in the {{tl|disambiguation}} template (for example, <code><nowiki>{{Disambiguation|given name}}</nowiki></code>). 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: "'''{{xt|Name (given name)}}'''" where "''Name''" is any [[given name]] and "''(given name)''" is the parenthetical '''[[Wikipedia:Set index articles|index]] identifier''', use template "{{tlc|given name}}"; placed at the bottom of a page to identify it as a [[Wikipedia:Set index articles|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 {{para|page}} or {{para|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 <code>cat={{var|name of category}}</code> when the category should be changed to something else.<br />{{in5}}Example: <code><nowiki>{{</nowiki>Given name|<span style="color:#066;">cat=Welsh given names</span><nowiki>}}</nowiki></code>
* Use <code>cat=none</code> when no category should be included at all (e.g. when using as an example in discussion or template documentation).<br />{{in5}}Example: <code><nowiki>{{</nowiki>Given name|<span style="color:#066;">cat=none</span><nowiki>}}</nowiki></code> <!--For backwards compatibility, a nocat option as the second parameter is also supported but deprecated.-->

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

{{in5}}Example: <code><nowiki>{{Given name|</nowiki><span style="color:#066;">section=y</span><nowiki>}}</nowiki></code>

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

{{in5}}Example: <code><nowiki>{{</nowiki>Given name|<span style="color:#066;">cat1=Welsh given names</span>|<span style="color:#066;">cat2=English given names</span><nowiki>}}</nowiki></code>

<code>cat=</code> can still be used with multiple categories to suppress auto-categorization into [[:Category:Given names]]:

{{in5}}Example: <code><nowiki>{{</nowiki>Given name|<span style="color:#066;">cat=English given names</span>|<span style="color:#066;">cat1=French given names</span>|<span style="color:#066;">cat2=German given names</span><nowiki>}}</nowiki></code>

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

{{in5}}Example: <code><nowiki>{{</nowiki>Given name|<span style="color:#066;">type=both</span><nowiki>}}</nowiki></code>

However, category names must still be provided in full.

{{in5}}Example: <code><nowiki>{{</nowiki>Given name|'''type=both'''|<span style="color:#066;">cat1=Welsh given names</span>|<span style="color:#066;">cat2=Welsh surnames</span><nowiki>}}</nowiki></code>

In addition, <code>cat=</code> must still be used in order to avoid auto-categorization into [[:Category:Given names]] and [[:Category:Surnames]]:

{{in5}}Example: <code><nowiki>{{</nowiki>Given name|'''type=both'''|<span style="color:#066;">cat=Welsh given names</span>|<span style="color:#066;">cat1=English given names</span>|<span style="color:#066;">cat2=Welsh surnames</span><nowiki>}}</nowiki></code>

=== See also ===

* [[Wikipedia:Name pages]] – How-to guide for articles about surnames and given names
* {{tl|Hndis}} – For disambiguation pages that list articles associated with the same personal name
* {{tl|Nickname}} – For nickname pages or sections of disambiguation pages that list people by nicknames
* {{tl|Surname}} – For surname pages or sections of disambiguation pages that list people by family name
* {{tl|R from given name}} – Add to redirects instead of {{tl|Given name}}
* {{tl|Given name links}} – Aids searching for articles related to a given name

<includeonly>{{Sandbox other||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:WikiProject Anthroponymy templates]]
[[Category:Set index article templates]]
}}</includeonly>