---

Class ::xowiki::includelet::toc

::xowiki::includelet::toc create ... \
           [ -__decoration (default "plain") ] \
           [ -id id ] \
           [ -parameter_declaration (default "
          {-style ""}
          {-renderer ""}
          {-open_page ""}
          {-book_mode false}
          {-folder_mode false}
          {-ajax false}
          {-expand_all false}
          {-remove_levels 0}
          {-category_id}
          {-locale ""}
          {-orderby ""}
          {-source ""}
          {-range ""}
          {-allow_reorder ""}
          {-include_in_foldertree "true"}
          {-CSSclass_top_ul ""}
          {-CSSclass_ul ""}
        ") ]

Show table of contents of the current wiki. The "toc" includelet renders the page titles of the current files based on the value of the "page_order" attributes. Only those pages are rendered that have a nonempty "page_order" field.

Documented Parameters:

style

renderer

open_page

folder_mode

ajax

expand_all

remove_levels

category_id

locale

orderby

by default, sorting is done via page_order (and requires pages with page_order). Alternatively, one can use e.g. "title,asc".

source

range

allow_reorder

include_in_foldertree

CSSclass_top_ul

CSS class for top-level UL element

CSSclass_ul

CSS class for all UL elements

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

Class Relations

• class: ::xowiki::IncludeletClass
• superclass: ::xowiki::Includelet
• instmixin: ::xowiki::includelet::PageReorderSupport

Methods (to be applied on instances)

• build_toc (scripted)

   <instance of xowiki::includelet::toc> build_toc

  Partial Call Graph (max 5 caller/called nodes):

  Testcases:

  includelet_toc, xowiki

• initialize (scripted)

   <instance of xowiki::includelet::toc> initialize

  Partial Call Graph (max 5 caller/called nodes):

  Testcases:

  includelet_toc, xowiki

• render (scripted)

   <instance of xowiki::includelet::toc> render

  Partial Call Graph (max 5 caller/called nodes):

  Testcases:

  includelet_toc, xowiki

• render_list (scripted)

   <instance of xowiki::includelet::toc> render_list

  Partial Call Graph (max 5 caller/called nodes):

  Testcases:

  includelet_toc, xowiki

• render_yui_list (scripted)

   <instance of xowiki::includelet::toc> render_yui_list

  Partial Call Graph (max 5 caller/called nodes):

  Testcases:

  includelet_toc, xowiki

---