Difference between revisions of "1"

From Opengenome.net
Line 1: Line 1:
<categorytree mode=pages>Manual</categorytree>
+
=== The &lt;categorytree&gt; tag ===
 +
Example:
 +
<pre><categorytree mode=pages>Manual</categorytree></pre>
 +
 
 +
 
 +
<categorytree mode=pages style="float:right; clear:right; margin-left:1ex; border:1px solid gray; padding:0.7ex; background-color:white;">Manual</categorytree>
 +
 
 +
 
 +
The custom tag is called &lt;categorytree&gt;. For example, if you put &lt;categorytree&gt;Foo&lt;/categorytree&gt; on a wiki page, it will show the contents of category Foo as a dynamic tree on that page (see example to the right). <span id="options">The tag accepts the following attributes, using a HTML-like syntax</span>:
 +
 
 +
;mode: determines which pages are shown in the tree. This may be overridden by the use of the <tt>namespaces</tt> option. Possible values:
 +
:;categories: show subcategories only (configuration constant <tt>CT_MODE_CATEGORIES</tt>)
 +
:;pages: show subcategories and pages, except images (configuration constant <tt>CT_MODE_PAGES</tt>)
 +
:;all: show all pages, subcategories, images, etc  (configuration constant <tt>CT_MODE_ALL</tt>)
 +
:;parents: list parent categories instead of subcategories (configuration constant <tt>CT_MODE_PARENTS</tt>). This puts CategoryTree into "inverse" operation (supported since [[rev:36892]], July 2008).
 +
;depth: determines how many levels of the tree are shown initially. Default is 1. 0 means only the root node. The maximum value depends on the mode specified, and on the $wgCategoryTreeMaxDepth option.  (introduced between [[rev:r20410]] and [[rev:20840]], Mar 30 2007; fully functional even with <tt>$wgCategoryTreeDynamicTag</tt> since [[rev:36864]], July 2008)
 +
;<s>onlyroot</s>: <s>set this to "on" to only show the "root" node of the tree initially. Equivalent to depth="0". ''(introduced in [[rev:20385]], March 13 2007)''</s> Deprecated as of [[rev:36864]], July 2008: use <tt>depth="0"</tt> instead.
 +
;hideroot: set this to "on" to hide the "root" node of the tree, i.e. <tt>hideroot=on</tt>. For example, it will not display the category name Foo.
 +
;hideprefix: determines when the namespace prefix should be hidden from entries in the tree (since [[rev:36864]], July 2008). Possible values are:
 +
:;always: always hide the prefix. Should be used only if all pages come from the same namespace (configuration constant <tt>CT_MODE_CT_HIDEPREFIX_ALWAYS</tt>).
 +
:;never: never hide the namespace prefix, not even for categories (configuration constant <tt>CT_MODE_CT_HIDEPREFIX_NEVER</tt>).
 +
:;auto: hide the namespace of categories, if only categories are shown, as with <tt>mode="categories"</tt> (configuration constant <tt>CT_MODE_CT_HIDEPREFIX_AUTO</tt>); This is equivalent to the old default behavior (before Jun 2008).
 +
:;categories: always hide the namespace of categories, but show all other prefixes (configuration constant <tt>CT_MODE_CT_HIDEPREFIX_CATEGORIES</tt>). This is the new default behavior (since [[rev:36864]], July 2008).
 +
;showcount: set this to "on" to show the number of entries in subcategories, i.e. <tt>showcount="on"</tt> (since [[rev:36864]], July 2008). This is disabled per default for category trees inlined on pages, but enabled per default in category listings an on Special:CategoryTree.
 +
;namespaces: a list of namespaces from which pages should be shown in the tree (since [[rev:36864]], July 2008). The entries in the list must be namespace names, separated by spaces. The main namespaces can be represented by "-" or "0". This overrides the <tt>mode</tt> option.
 +
;class, style, id, ''etc'': The &lt;categorytree&gt; tag supports all standard HTML attributes for block elements (since [[rev:36864]], July 2008. Before that, only <tt>style</tt> was supported).

Revision as of 17:14, 11 April 2011

The <categorytree> tag

Example:

<categorytree mode=pages>Manual</categorytree>


Manual
no pages or subcategories


The custom tag is called <categorytree>. For example, if you put <categorytree>Foo</categorytree> on a wiki page, it will show the contents of category Foo as a dynamic tree on that page (see example to the right). The tag accepts the following attributes, using a HTML-like syntax:

mode
determines which pages are shown in the tree. This may be overridden by the use of the namespaces option. Possible values:
categories
show subcategories only (configuration constant CT_MODE_CATEGORIES)
pages
show subcategories and pages, except images (configuration constant CT_MODE_PAGES)
all
show all pages, subcategories, images, etc (configuration constant CT_MODE_ALL)
parents
list parent categories instead of subcategories (configuration constant CT_MODE_PARENTS). This puts CategoryTree into "inverse" operation (supported since rev:36892, July 2008).
depth
determines how many levels of the tree are shown initially. Default is 1. 0 means only the root node. The maximum value depends on the mode specified, and on the $wgCategoryTreeMaxDepth option. (introduced between rev:r20410 and rev:20840, Mar 30 2007; fully functional even with $wgCategoryTreeDynamicTag since rev:36864, July 2008)
onlyroot
set this to "on" to only show the "root" node of the tree initially. Equivalent to depth="0". (introduced in rev:20385, March 13 2007) Deprecated as of rev:36864, July 2008: use depth="0" instead.
hideroot
set this to "on" to hide the "root" node of the tree, i.e. hideroot=on. For example, it will not display the category name Foo.
hideprefix
determines when the namespace prefix should be hidden from entries in the tree (since rev:36864, July 2008). Possible values are:
always
always hide the prefix. Should be used only if all pages come from the same namespace (configuration constant CT_MODE_CT_HIDEPREFIX_ALWAYS).
never
never hide the namespace prefix, not even for categories (configuration constant CT_MODE_CT_HIDEPREFIX_NEVER).
auto
hide the namespace of categories, if only categories are shown, as with mode="categories" (configuration constant CT_MODE_CT_HIDEPREFIX_AUTO); This is equivalent to the old default behavior (before Jun 2008).
categories
always hide the namespace of categories, but show all other prefixes (configuration constant CT_MODE_CT_HIDEPREFIX_CATEGORIES). This is the new default behavior (since rev:36864, July 2008).
showcount
set this to "on" to show the number of entries in subcategories, i.e. showcount="on" (since rev:36864, July 2008). This is disabled per default for category trees inlined on pages, but enabled per default in category listings an on Special:CategoryTree.
namespaces
a list of namespaces from which pages should be shown in the tree (since rev:36864, July 2008). The entries in the list must be namespace names, separated by spaces. The main namespaces can be represented by "-" or "0". This overrides the mode option.
class, style, id, etc
The <categorytree> tag supports all standard HTML attributes for block elements (since rev:36864, July 2008. Before that, only style was supported).