Difference between revisions of "Template:Category explanation/doc"

From blackwiki
Jump to navigation Jump to search
imported>Senator2029
(Add wikilinks to related templates, guidelines, and categories)
imported>Uanfala
(→‎See also: covered by the navbox)
 
(7 intermediate revisions by 4 users not shown)
Line 2: Line 2:
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
  
== Usage ==
+
This template is for use on [[WP:CATEGORY|category]] pages (in the Category: namespace), producing a [[WP:HATNOTE|hatnote]] describing the category. It takes a single parameter{{Snd}} the category description{{Snd}} producing the hatnote:
[[Wikt:mnemonic|Mnemonically]] '''''C'''ategory'' '''''e'''xplanation''.
+
: ''This [[Help:Categories|category]] is for''
 +
followed by that description. Any spaces surrounding the parameter are removed, and a space is inserted before it. It should be worded so as to make the result a complete English sentence. A [[Full stop|period (full stop)]] will be added to the end if the parameter does not already end with a period. The hatnote is indented and on a new line (technically, in a new [[Span and div|<code><nowiki><div></nowiki></code>]]).
  
This template is meant to be a brief explanation of a [[Wikipedia:Categorization|category]].
+
== Examples ==
 
+
* <span style="color:darkgreen;">This code: {{tlc|{{BASEPAGENAME}}|articles related to <nowiki>[[foo]]</nowiki>}} produces:</span> {{{{BASEPAGENAME}}|articles related to [[foo]]}}
=== Template contents ===
+
* <span style="color:darkgreen;">This code: {{tlc|{{BASEPAGENAME}}|articles related to <nowiki>[[foo]].</nowiki>}} produces:</span>{{{{BASEPAGENAME}}|articles related to [[foo]].}}
''This [[Wikipedia:Categorization|category]] is for {{{1}}}.''
+
* <span style="color:red;">This code: {{tlc|{{BASEPAGENAME}}|articles related to <nowiki>[[foo]]:</nowiki>}} (undesirably) produces:</span>{{{{BASEPAGENAME}}|articles related to [[foo]]:}}
 
 
Where the parameter '''<nowiki>{{{1}}}</nowiki>''' can be any text, including text with [[Help:Link|links]].
 
  
 
==Redirects==
 
==Redirects==
Line 18: Line 17:
 
* {{Tlx|Catexp}}
 
* {{Tlx|Catexp}}
 
* {{Tlx|Cat exp}}
 
* {{Tlx|Cat exp}}
 +
* {{Tlx|Category description}}
 +
* {{Tlx|Cat description}}
  
 
==See also==
 
==See also==
{{see also|Wikipedia:Hatnote#Categories}}
+
{{Category hatnote templates}}
{{main category|Hatnote templates for category pages}}
 
* {{Tlx|Cat main}}
 
* {{Tlx|Cat more}}
 
* {{Tlx|Category main section}}
 
* {{Tlx|Category see also}}
 
 
 
 
{{Namespace category}}
 
{{Namespace category}}
  

Latest revision as of 15:17, 16 April 2020

This template is for use on category pages (in the Category: namespace), producing a hatnote describing the category. It takes a single parameterTemplate:Snd the category descriptionTemplate:Snd producing the hatnote:

This category is for

followed by that description. Any spaces surrounding the parameter are removed, and a space is inserted before it. It should be worded so as to make the result a complete English sentence. A period (full stop) will be added to the end if the parameter does not already end with a period. The hatnote is indented and on a new line (technically, in a new <div>).

Examples

  • This code: {{Category explanation|articles related to [[foo]]}} produces:
  • This code: {{Category explanation|articles related to [[foo]].}} produces:
  • This code: {{Category explanation|articles related to [[foo]]:}} (undesirably) produces:

Redirects

See also

Other category-header templates