Sarna News: Bad 'Mechs - Icestorm

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

(Created page with "<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude> <!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> =...")
 
m (Creation (as this is needed))
Line 1: Line 1:
<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
+
{{Documentation}}
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
==Usage instructions==
+
<hr style="margin-bottom: 1.25em;">
This template is used to link to categories
+
{{Template shortcut|cl|CL|categ|category}}
  
The following code will simply produce a link to a category:
+
: {{Tlx|Cl|''category name''}}
<pre>
+
: {{Tlx|Cl|''category name''|''link text''}}
{{Category|Category name}}
+
: {{Tlx|Cl|''category name''|''link text''|count{{=}}yes}}
</pre>
+
: {{Tlx|Cl|''category name''|''link text''|count{{=}}yes|count_type{{=}}''type''}}
 +
: {{Tlx|Cl|''category name''|''link text''|count{{=}}yes|count_type{{=}}''type''|backlog{{=}}'''backlog threshold'''}}
  
You can also have the link use custom text if you use the following:
+
{{Tl|Cl}} ("[C]ategory [l]ink") produces a link to a category in a similar fashion to {{Tl|Tl}} for a template. For example:
<pre>
+
: {{Tlf|Cl|Africa}} produces: {{Cl|Africa}}
{{Category|Category Name|Link Text}}
+
 
</pre>
+
To specify the text used for the link, add it as a second parameter:
 +
: {{Tlf|Cl|Africa|this category}} produces: {{Cl|Africa|this category}}
 +
 
 +
To add a count of everything in the category, add the {{Para|count|yes}} parameter:
 +
: {{Tlf|Cl|Africa|count{{=}}yes}} produces: {{Cl|Africa|count=yes}}
 +
 
 +
If you just want to get a count of pages, files, or subcats, use the [[MW:Help:Magic words#PAGESINCAT|{{Para|count_type}} parameter]]:
 +
: {{Tlf|Cl|Africa|count{{=}}yes|count_type{{=}}all}} produces: {{Cl|Africa|count=yes|count_type=all}} ('''default''')
 +
: {{Tlf|Cl|Africa|count{{=}}yes|count_type{{=}}pages}} produces: {{Cl|Africa|count=yes|count_type=pages}}
 +
: {{Tlf|Cl|Africa|count{{=}}yes|count_type{{=}}subcats}} produces: {{Cl|Africa|count=yes|count_type=subcats}}
 +
: {{Tlf|Cl|Africa|count{{=}}yes|count_type{{=}}files}} produces: {{Cl|Africa|count=yes|count_type=files}}
 +
 
 +
If you want to make counts standout for categories that have a backlog, use {{Para|backlog}}:
 +
: {{Tlf|Cl|Africa|count{{=}}yes|backlog{{=}}20}} produces: {{Cl|Africa|count=yes|backlog=20}}
 +
 
 +
== See also ==
 +
* {{Tl|C}}, which produces output such as: {{C|Africa}} and {{C|Africa|Afrika}}
 +
* {{Tl|Cls}}, which produces output such as: {{Cls|Africa}}
 +
* {{Tl|Clc}}, which produces output such as: {{Clc|Africa}} and {{Clc|Africa|pages}}
 +
* {{Tl|lc}}, which produces output such as: {{Lc|Africa}}
 +
* {{Tl|lcs}}, which produces output such as {{Lcs|Africa}}
 +
* {{Tl|tl}}, which links produces a link to a template surrounded by template-style double-braces (e.g. {{Tl|Africa}}).
 +
* {{Cl|Internal category-link templates}}
 +
* {{Cl|Internal link templates}}
 +
* {{tl|Category see also}}
 +
{{Internal category-link templates}}
 +
 
 +
<includeonly>{{Sandbox other|
 +
| <!-- Categories below this line, please: -->
 +
[[Category:Internal category-link templates]]
 +
}}</includeonly>

Revision as of 13:48, 30 May 2022


{{Cl|category name}}
{{Cl|category name|link text}}
{{Cl|category name|link text|count=yes}}
{{Cl|category name|link text|count=yes|count_type=type}}
{{Cl|category name|link text|count=yes|count_type=type|backlog=backlog threshold}}

{{Cl}} ("[C]ategory [l]ink") produces a link to a category in a similar fashion to {{Tl}} for a template. For example:

{{Cl|Africa}} produces: Category:Africa

To specify the text used for the link, add it as a second parameter:

{{Cl|Africa|this category}} produces: this category

To add a count of everything in the category, add the |count=yes parameter:

{{Cl|Africa|count=yes}} produces: Category:Africa ( 0 )

If you just want to get a count of pages, files, or subcats, use the |count_type= parameter:

{{Cl|Africa|count=yes|count_type=all}} produces: Category:Africa ( 0 ) (default)
{{Cl|Africa|count=yes|count_type=pages}} produces: Category:Africa ( 0 )
{{Cl|Africa|count=yes|count_type=subcats}} produces: Category:Africa ( 0 )
{{Cl|Africa|count=yes|count_type=files}} produces: Category:Africa ( 0 )

If you want to make counts standout for categories that have a backlog, use |backlog=:

{{Cl|Africa|count=yes|backlog=20}} produces: Category:Africa ( 0 )

See also

Template Example output
{{c}} Help
{{cl}} Category:Help
{{cls}} Cat:Help
Template Example output
{{cconly}} 45
{{clc}} Category:Help (45)
{{lc}} Category:Help (edit | talk | history | links | watch | logs)
{{lcs}} Category:Help (Edit Discussion links Page history)