Loading...
 
Display a table of contents of pages in a structure

Plugin Table of Contents

Introduced in Tiki3

Use this wiki plugin in a page belonging to a structure to display a table of contents listing that page's sub-pages (see also Structures). Nothing will be displayed if the page doesn't have sub-pages.
  • Used in the structure's 'root' page, a full table of contents for the entire structure will be created.
  • Used in a sub-page, a chapter table of contents will be created (showing only the sub-pages to that page).

Parameters

Introduced in Tiki3.
Preferences required: wikiplugin_toc, feature_wiki_structure
Parameters Accepted Values Description Default Since
maxdepth digits Maximum number of levels to display. On very large structures, this should be limited. 0 means no limit (and is the default). 0 3.0
mindepth digits Hide number of levels below this number to display. 0 means no limit (and is the default). 0 15.3.
sortalpha (blank)
struct
alpha
Display first level by structure order: struct (the default) or by sorting the items in alphabetical order: alpha struct 15.3.
order (blank)
asc
desc
Order items in ascending or descending order (default is ascending). asc 3.0
pagename pagename By default, the table of contents for the current page will be displayed. Alternate page may be provided. 5.0
showdesc (blank)
1
0
Show the page description instead of the page name 0 3.0
shownum (blank)
1
0
Display the section numbers or not 0 3.0
structId digits By default, structure for the current page will be displayed. Alternate structure may be provided. 3.0
type (blank)
plain
fancy
admin
Style to apply plain 3.0


Same Page in Multiple Structures

Navigating to a page that is included in multiple structures can cause a PluginToc used on that page to behave unexpectedly. In these cases the structId parameter should be used to set behavior.

For example, assume we have one structure called "Full" and one called "Shell" and we have a page called "Examples" that is included in both. In the Full structure, the Examples page has three pages under it called "Example 1", "Example 2" and "Example 3", whereas in the Shell structure there are no pages under the Examples page.

If you want the three example pages to show in PluginToc every time the Examples page is brought up, then the structId parameter should be set to be the page_ref_id of the Examples page in the Full structure. To determine what this page_ref_id is, do the following:
  • Go to tiki-admin_structures.php
  • Click on the name of the structure ("Full" in this example)
  • On the page that comes up, mouse over the page name where PluginToc is being used ("Examples" in this example)
  • Note the page_ref_id that is part of the URL when you mouse over the page name
  • Set the structId parameter in PluginToc to equal the page_ref_id noted
Now PluginToc on the Examples page will show the three pages underneath it in the Full structure.

Using the pagename parameter

Passing the pagename is useful in (at least) two situations:
  1. When you want to have a master table of contents page of a structure as the last page in the structure.
  2. When you want to include a page (using PluginInclude) with PluginTOC used in another page.
    If you include the page with the TOC plugin without passing the name of the page to PluginTOC, the table of contents for the page where PluginTOC is included will be shown, instead of showing the TOC for the included page.
    This is useful for overview/portal pages.

Examples

All levels

This code:
{toc shownum="1" pagename="Author Resources"}


Would produce on this site:


 

The page "Author Resources" used for the pagename parameter in the above example is the root page of a structure.

First level only

This code:
{toc shownum="1" maxdepth="1" pagename="Author Resources"}


Would produce on this site:


From second level and Alpha sorted

This code:
{toc shownum="1" maxdepth="1" pagename="Author Resources"}


Would produce on this site:


Show description and no numbers

This code:
{toc showdesc="1" pagename="Author Resources"}


Would produce on the main page of a structure (using the All the Documentation page in this example):


Note that in this example, the description is shown first and the title field shown second. If a page has no description field (like in many pages of the structure in this example), only this title will be shown.


Alias

doc.tiki.org


Bootstrap

AdminGuide

UserGuide

atest=1">Adding items to a tracker
  • How to change tracker field types
  • Linking trackers
  • Multilingual trackers
  • Searching tracker items
  • Viewing Tracker Results
  • Export trackers
  • Terms and Conditions
  • Accounting
  • MyAccount
  • User Preferences
  • Inter-User Messages
  • Gmap User
  • Bookmarks
  • Watch
  • User Page
  • MyTiki Details
  • Karma
  • Score vs Karma
  • User Action log
  • Search User
  • Mobile Tiki User
  • User Wizard
  • Must Reads

  • ropdown option4757 menuSection menuSection2 menuLevel2">The Wiki

    Keywords

    Keywords serve as "hubs" for navigation within the Tiki documentation. They correspond to development keywords (bug reports and feature requests):

    Accessibility (WAI and 508)
    Accounting (7.x)
    Articles and Submissions
    Backlinks
    Banners
    Batch (6.x)
    BigBlueButton audio/video/chat/screensharing (5.x)
    Blog
    Bookmark
    Browser Compatibility
    Link Cache
    Calendar
    Category
    Chat
    Clean URLs
    Comments
    Communication Center
    Compression (gzip)
    Contacts (Address Book)
    Contact us
    Content Templates
    Contribution (2.x)
    Cookie
    Copyright
    Credit (6.x)
    Custom Home and Group Home Page
    Date and Time
    Debugger Console
    Directory of hyperlinks
    Documentation link from Tiki to doc.tiki.org (Help System)
    Docs 8.x
    Draw 7.x
    Dynamic Content
    Dynamic Variable
    External Authentication
    FAQ
    Featured links
    File Gallery
    Forum
    Friendship Network (Community)
    Gmap Google maps
    Groups
    Hotword
    HTML Page
    i18n (Multilingual, l10n, Babelfish)
    Image Gallery
    Import-Export
    Install
    Integrator
    Interoperability
    Inter-User Messages
    InterTiki
    Kaltura video management (4.x)
    Karma
    Live Support
    Login
    Logs (system & action)
    Look and Feel
    Lost edit protection
    Mail-in
    Map with Mapserver
    Menu
    Meta Tags
    Mobile Tiki and Voice Tiki
    Mods
    Module
    MultiTiki
    MyTiki
    Newsletter
    Notepad
    Payment
    Performance Speed / Load
    Permissions
    Platform independence (Linux-Apache, Windows/IIS, Mac, BSD)
    Polls
    Profiles
    Profile Manager
    Report
    Toolbar
    Quiz
    Rating
    Feeds
    Score
    Search engine optimization
    Search
    Search and Replace
    Security
    Semantic links (3.x)
    Shadowbox
    Shadow Layers
    Share
    Shopping cart
    Shoutbox
    Slideshow
    Smiley
    Social Networks
    Spam protection (Anti-bot CATPCHA)
    Spellcheck
    Spreadsheet
    Stats
    Surveys
    Tags (2.x)
    Task
    Tell a Friend, alert + Social Bookmarking
    TikiTests (2.x)
    Theme CSS & Smarty
    Trackers
    Transitions (5.x)
    TRIM
    User Administration including registration and banning
    User Files
    User Menu
    Watch
    WebHelp
    WebDAV (5.x)
    Webmail
    Web Services
    Wiki 3D
    Wiki History, page rename, etc
    Wiki Page Staging and Approval (2.x)
    Wiki Plugin extends basic syntax
    Wiki Syntax
    Wiki structure (book and table of content)
    Workspace
    WSOD
    WYSIWYCA
    WYSIWYG (2.x)
    XMLRPC


    Latest Changes

    1. Tutorial - HowTo Create a Sitemap
    2. Wiki Admin,ca
    3. 티키 스타일 설명서
    4. 목록 작성 위키문법
    5. 메뉴 입문서
    6. Blog User
    7. Using Blogs,es
    8. Tiki Manual of Style
    9. Wiki-Syntax Text,el
    10. Wiki-Syntax Lists,el
    ...more

    Tiki Newsletter

    Delivered fresh to your email inbox!
    Newsletter subscribe icon
    Don't miss major announcements and other news!
    Contribute to Tiki