Class ::xowiki::includelet::toc

::xowiki::includelet::toc[i] 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 ""} ") ]

Defined in

Class Relations

  • class: ::xowiki::IncludeletClass[i]
  • superclass: ::xowiki::Includelet[i]
  • instmixin: ::xowiki::includelet::PageReorderSupport[i]

Methods (to be applied on the object)

  • anchor (scripted)

Methods (to be applied on instances)

  • __decoration (setter)

  • build_navigation (scripted)

  • build_toc (scripted, private)

     <instance of xowiki::includelet::toc[i]> build_toc package_id \
        locale source range

    Collect pages for the table of contents and initialize navigation state.

    Parameters:
    package_id (required)
    Package instance to query.
    locale (required)
    Locale used to filter pages.
    source (required)
    Optional source defining page order.
    range (required)
    Page order range to include.
    Returns:
    The selected pages.

    Testcases:
    includelet_toc
  • cache_includelet_data (scripted)

  • count (scripted)

  • current (scripted)

  • href (scripted)

  • id (setter)

  • include_head_entries (scripted)

  • initialize (scripted, public)

     <instance of xowiki::includelet::toc[i]> initialize

    Initialize navigation and rendering settings for the table of contents.

    Testcases:
    includelet_toc
  • page_name (scripted)

  • page_number (scripted)

  • parameter_declaration (setter)

  • parent_id (scripted)

  • position (scripted)

  • render (scripted, public)

     <instance of xowiki::includelet::toc[i]> render

    Build the table of contents and render it with the selected renderer.

    Testcases:
    includelet_toc
  • render_list (scripted, private)

     <instance of xowiki::includelet::toc[i]> render_list [ -full full ] \
        pages

    Render the table of contents as a plain HTML list.

    Switches:
    -full (optional, defaults to "false")
    Whether to include the full tree.
    Parameters:
    pages (required)
    Pages to render.

    Testcases:
    includelet_toc
  • render_tree (scripted)

  • render_yui_list (scripted, private)

     <instance of xowiki::includelet::toc[i]> render_yui_list \
        [ -full full ] pages

    Render the table of contents with the YUI tree widget.

    Switches:
    -full (optional, defaults to "false")
    Whether to include the full tree.
    Parameters:
    pages (required)
    Pages to render.

    Testcases:
    includelet_toc
  • yui_ajax (scripted)

  • yui_non_ajax (scripted)