Template

Difference between revisions of "Template category/doc"

From Joomla! Documentation

< Template:Template category
m
 
(One intermediate revision by the same user not shown)
Line 4: Line 4:
  
 
== Functions/Features ==
 
== Functions/Features ==
 +
The upper part of this message box uses {{tl|for}} to link to the Joomla! Templates category. The description and output of the usage notice can be replaced via parameters.
 +
 
If the <code>help</code> parameter is not given, the template automatically explains to readers how to add a template to the category. Specify your own help instructions to override the default. You may also set additional description of the category that will appear beneath the box.
 
If the <code>help</code> parameter is not given, the template automatically explains to readers how to add a template to the category. Specify your own help instructions to override the default. You may also set additional description of the category that will appear beneath the box.
  
The optional parameter <code>small</code> (when any value specified) makes the messagebox small and right-floating.
+
The optional parameter <code>small</code> (when any value specified) makes the messagebox small and right-floating. The default help messages will be reworded to fit into the narrow box.
  
 
== Usage ==
 
== Usage ==
<!-- examples should be given using any of the following formats -->
 
 
{{tlx|template category|description|help|small}}
 
{{tlx|template category|description|help|small}}
 +
 +
Standard box with alternative texts
 
<pre>{{template category
 
<pre>{{template category
| description =
+
| description = supplemental description
| help =
+
| help = alternative help text
 
}}</pre>
 
}}</pre>
 +
Narrow box
 +
<pre>{{template category|small=yes}}</pre>
  
 
== See also ==
 
== See also ==

Latest revision as of 03:14, 11 May 2008

This is a documentation subpage for Template:Template category.
It contains usage information, categories and other content that is not part of the original template page.
To view the template page itself, see Template:Template category.

Use {{template category}} at the top of categories containing pages in the template namespace (for example, Category:Link templates).

Functions/Features[edit]

The upper part of this message box uses {{for}} to link to the Joomla! Templates category. The description and output of the usage notice can be replaced via parameters.

If the help parameter is not given, the template automatically explains to readers how to add a template to the category. Specify your own help instructions to override the default. You may also set additional description of the category that will appear beneath the box.

The optional parameter small (when any value specified) makes the messagebox small and right-floating. The default help messages will be reworded to fit into the narrow box.

Usage[edit]

{{template category|description|help|small}}

Standard box with alternative texts

{{template category
| description = supplemental description
| help = alternative help text
}}

Narrow box

{{template category|small=yes}}

See also[edit]