Jump to content

Template:Category explanation/doc: Difference between revisions

From Wikipedia, the free encyclopedia
Content deleted Content added
No edit summary
add high-use (more than 100k transclusions)
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{#ifeq:{{SUBPAGENAME}}|sandbox||{{High-use}}}}


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:
== Usage ==
: ''This [[Help:Categories|category]] is for''
[[Wikt:mnemonic|Mnemonically]] '''''C'''ategory'' '''''e'''xplanation''.
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>]]).


== Examples ==
This template is meant to be a brief explanation of a [[Wikipedia:Categorization|category]].
* <span style="color:darkgreen;">This code: {{tlc|{{BASEPAGENAME}}|articles related to <nowiki>[[foo]]</nowiki>}} produces:</span> {{{{BASEPAGENAME}}|articles related to [[foo]]}}

* <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:red;">This code: {{tlc|{{BASEPAGENAME}}|articles related to <nowiki>[[foo]]:</nowiki>}} (undesirably) produces:</span>{{{{BASEPAGENAME}}|articles related to [[foo]]:}}
''This [[Wikipedia:Categorization|category]] is for {{{1}}}.''

Where the parameter '''<nowiki>{{{1}}}</nowiki>''' can be any text, including text with [[Help:Link|links]].


==Redirects==
==Redirects==
Line 18: Line 18:
* {{Tlx|Catexp}}
* {{Tlx|Catexp}}
* {{Tlx|Cat exp}}
* {{Tlx|Cat exp}}
* {{Tlx|Category description}}
* {{Tlx|Cat description}}


==See also==
==See also==
{{Category hatnote templates}}
* [[WP:HAT]] about hatnotes
* {{Tlx|Cat main}}
* {{Tlx|Cat more}}
* {{Tlx|Category main section}}

{{Namespace category}}
{{Namespace category}}



Latest revision as of 01:16, 7 April 2023

This template is for use on category pages (in the Category: namespace), producing a hatnote describing the category. It takes a single parameter – the category description – 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

[edit]
  • 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

[edit]

See also

[edit]

Other category-header templates

[edit]