CatInclude
From Joomla! Documentation
Revision as of 12:51, 2 December 2012 by Tom Hutchison (talk | contribs) (reformat if and switch calls)
The {{CatInclude}} template makes category inclusion in other templates easier. It eliminates the need for complicated #switches and #ifeq of NAMESPACE to allow category inclusion in templates without including those categories in certain NAMESPACES such as, the Template and JDOC NAMESPACES. The code being used is shown below.
{{#switch: {{NAMESPACE}} |Template=<!-- no categorization --> |JDOC=<!-- no categorization --> |#default={{#arraydefine:cats|{{{1|}}}}} {{#arrayprint:cats||@@@@|[[Category:@@@@|{{PAGENAME}}]]}}{{#arrayreset:cats}} }}
The template makes category inclusion in other templates easier. It eliminates the need for complicated #switches and #ifeq of NAMESPACE to allow category inclusion in templates without including those categories in certain NAMESPACES such as, the Template and JDOC NAMESPACES.
Functions/Features[edit]
Automatic category inclusion in templates.
It is possible to use this template directly in articles. Until this warning is removed, it is not recommended.
Usage[edit]
Must use the parameter {{{1|}}}
- A simple call would be to add {{CatInclude|Development,Tutorial,Plugin}} to pages which use a template to add content to a wiki page.
- A complex template call against a parameter in a template can be used inside a #if, #ifeq or #switch call.
- Example
- {{#ifeq:{{{foo|}}}|tutorial|{{CatInclude|Development,Tutorial,Plugin}}|[[Category:Foo]]}}
- OR
- {{#ifeq:{{{foo|}}}|tutorial|{{CatInclude|Development,Tutorial,Plugin}}|{{CatInclude|Development}}}}
Parameters[edit]
Parameter | Parameter description | req./opt. |
---|---|---|
{{{1}}} | categories (in array format, comma separated) For Example: Development,Tutorial,Plugin |
required |
Known Issues[edit]
None known, please report on this Template's talk page.