---

Class ::xowiki::includelet::categories

::xowiki::includelet::categories create ... \
           [ -parameter_declaration (default "
          {-tree_name ""}
          {-tree_style:boolean 1}
          {-no_tree_name:boolean 0}
          {-count:boolean 0}
          {-summary:boolean 0}
          {-locale ""}
          {-open_page ""}
          {-order_items_by "title,asc"}
          {-style "mktree"}
          {-category_ids ""}
          {-parent /}
          {-except_category_ids ""}
          {-allow_edit false}
          {-ordered_composite}
        ") ] \
           [ -title (default "#xowiki.categories#") ]

List the specified category tree.

Documented Parameters:

tree_name

match pattern, if specified displays only the trees with matching names

no_tree_name

if specified, tree names are not displayed

open_page

name (e.g. en:iMacs) of the page to be opened initially

tree_style

boolean, default: true, render category tree in tree style and not in sections style

parent

page-ref, default: /, select entries from this directory

Defined in packages/xowiki/tcl/includelet-procs.tcl

Class Relations

• class: ::xowiki::IncludeletClass
• superclass: ::xowiki::Includelet

Methods (to be applied on instances)

• category_tree_edit_button (scripted)

• category_tree_missing (scripted)

• include_head_entries (scripted)

• initialize (scripted)

• parameter_declaration (setter)

• render (scripted)

• title (setter)

---