Difference between revisions of "Template:Template category/doc"

From Kerbal Space Program Wiki
Jump to: navigation, search
(Import from Wikipedia (CC BY-SA license))
 
m
 
Line 42: Line 42:
 
====''topic''====
 
====''topic''====
 
<hr/>
 
<hr/>
: Adds a default description ending "...relating to ''topic''", where ''topic'' is usually a [[wikilink]] to the main article associated with the category (e.g. [[United States]] for the [[:Category:United States templates]]).
+
: Adds a default description ending "...relating to ''topic''", where ''topic'' is usually a [[w:wikilink]] to the main article associated with the category (e.g. [[w:United States]] for the [[:Category:United States templates]]).
 
{{Hidden begin |showhide=left |title=''topic'' alone |bodystyle=font-size:105%;}}
 
{{Hidden begin |showhide=left |title=''topic'' alone |bodystyle=font-size:105%;}}
<pre>{{Template category |topic=the [[United States]]}}</pre>
+
<pre>{{Template category |topic=the [[w:United States]]}}</pre>
{{Template category |topic=the [[United States]]}}
+
{{Template category |topic=the [[w:United States]]}}
 
{{Hidden end}}
 
{{Hidden end}}
 
{{Hidden begin |showhide=left |title=''type'', ''topic'' |bodystyle=font-size:105%;}}
 
{{Hidden begin |showhide=left |title=''type'', ''topic'' |bodystyle=font-size:105%;}}
<pre>{{Template category |type=infobox |topic=the [[United States]]}}</pre>
+
<pre>{{Template category |type=infobox |topic=the [[w:United States]]}}</pre>
{{Template category |type=infobox |topic=the [[United States]]}}
+
{{Template category |type=infobox |topic=the [[w:United States]]}}
 
{{Hidden end}}
 
{{Hidden end}}
  
Line 59: Line 59:
 
{{Template category
 
{{Template category
 
| type = navbox
 
| type = navbox
| topic = [[China]]
+
| topic = [[w:China]]
| description = <br />{{small|For templates relating specifically to the [[People's Republic of China|People's Republic of China (PRC)]] or the current [[Republic of China|Republic of China (ROC, "Taiwan")]], see, respectively, {{c|People's Republic of China templates}} and {{c|Republic of China (Taiwan) templates}}.}}
+
| description = <br />{{small|For templates relating specifically to the [[w:People's Republic of China|People's Republic of China (PRC)]] or the current [[w:Republic of China|Republic of China (ROC, "Taiwan")]], see, respectively, {{c|People's Republic of China templates}} and {{c|Republic of China (Taiwan) templates}}.}}
 
}}
 
}}
 
</pre>
 
</pre>
 
{{Template category
 
{{Template category
 
| type = navbox
 
| type = navbox
| topic = [[China]]
+
| topic = [[w:China]]
| description = <br />{{small|For templates relating specifically to the [[People's Republic of China|People's Republic of China (PRC)]] or the current [[Republic of China|Republic of China (ROC, "Taiwan")]], see, respectively, {{c|People's Republic of China templates}} and {{c|Republic of China (Taiwan) templates}}.}}
+
| description = <br />{{small|For templates relating specifically to the [[w:People's Republic of China|People's Republic of China (PRC)]] or the current [[w:Republic of China|Republic of China (ROC, "Taiwan")]], see, respectively, {{c|People's Republic of China templates}} and {{c|Republic of China (Taiwan) templates}}.}}
 
}}
 
}}
 
{{Hidden end}}
 
{{Hidden end}}
Line 80: Line 80:
 
<pre>
 
<pre>
 
{{Template category
 
{{Template category
| topic = the [[United States]]
+
| topic = the [[w:United States]]
 
| onright = {{Commons category|United States|the United States}}{{Portal|United States}}
 
| onright = {{Commons category|United States|the United States}}{{Portal|United States}}
 
}}
 
}}
 
</pre>
 
</pre>
 
{{Template category
 
{{Template category
| topic = the [[United States]]
+
| topic = the [[w:United States]]
 
| onright = {{Commons category|United States|the United States}}{{Portal|United States}}
 
| onright = {{Commons category|United States|the United States}}{{Portal|United States}}
 
}}
 
}}
Line 92: Line 92:
 
====''container''====
 
====''container''====
 
<hr/>
 
<hr/>
: Set ''container'' as {{tla|If affirmative|"true", "yes", etc}} to identify the category as a [[Wikipedia:Container category|container category]], i.e. a category meant to contain only subcategories. A note requesting that no templates are added to the template category is then included.
+
: Set ''container'' as {{tla|If affirmative|"true", "yes", etc}} to identify the category as a [[w:Wikipedia:Container category|container category]], i.e. a category meant to contain only subcategories. A note requesting that no templates are added to the template category is then included.
 
{{Hidden begin |showhide=left |title=''container'' alone |bodystyle=font-size:105%;}}
 
{{Hidden begin |showhide=left |title=''container'' alone |bodystyle=font-size:105%;}}
 
<pre>{{Template category |container=true}}</pre>
 
<pre>{{Template category |container=true}}</pre>
Line 103: Line 103:
 
{{Template category
 
{{Template category
 
| type = ''type''
 
| type = ''type''
| topic = ''[[topic]]''
+
| topic = ''[[w:topic|topic]]''
 
| description = This text supplied by the ''description'' parameter.
 
| description = This text supplied by the ''description'' parameter.
 
}}
 
}}
Line 110: Line 110:
 
{{Template category
 
{{Template category
 
| type = ''type''
 
| type = ''type''
| topic = ''[[topic]]''
+
| topic = ''[[w:topic|topic]]''
 
| description = This text supplied by the ''description'' parameter.
 
| description = This text supplied by the ''description'' parameter.
 
}}
 
}}

Latest revision as of 12:09, 7 March 2020

{{Template category}} should be placed at the top of categories that contain template pages and their related subcategories. This template populates Category:Wikipedia template categories.

Template:TOC limit

Usage

Full syntax

{{Template category
| type = 
| topic = 
| description = 
| onright = 
| container = 
| help = 
}}

Parameters

The template may be used without any parameters, i.e. as {{Template category}}.

The following, however, may be used to make the template more informative:

type


Setting type to one of the following values adds a preset note as to which type of template the category (but not necessarily its subcategories) is meant to contain. The values are:
  • ambox
  • campaignbox
  • conversion
  • external link
  • formatting
  • function
  • message
  • meta
  • navbox
  • navigation
  • sidebar
  • stub
  • sub
  • timeline
  • userbox
If type is set to something other than one of these values, the default "The pages listed in this category are templates" note appears unmodified.
Further examples of type's output appear in the examples below.

topic


Adds a default description ending "...relating to topic", where topic is usually a w:wikilink to the main article associated with the category (e.g. w:United States for the Category:United States templates).

description


Use this if a customised description is needed instead of – or, if topic also used, to follow – the default description above.

onright


Use this to place right-aligned boxes beside the template such as {{Portal}} (to provide link/s to related portal/s), {{Commons category}} (to provide a link to the same or a similarly-named Commons category), etc. If more than one box is included, ensure the widest one appears first (see example below) otherwise overlapping may occur.

container


Set container as {{"true", "yes", etc}} to identify the category as a container category, i.e. a category meant to contain only subcategories. A note requesting that no templates are added to the template category is then included.
An alternative to using container is to place {{Container category}} after the {{Template category}} template:

help


Use this to replace the default instructions as to how to add a template to the category ("Further template category notes" section) or, if set negatively, to remove them.

See also

Template:Other category-header templates