Documentation  »  Features  »  Structures  »  Structure User

Structures user

Structures are used to group an arbitrary set of wiki pages into a navigable tree . They are very useful for grouping Wiki pages into documentation, manuals, FAQs, HowTos, etc.

Navigating Structures

When browsing through the Wiki:

• If a page is part of one or more structures, a select box containing the word 'structures...' will appear at the top of the page. Select the structure name from this list to activate it.
• If the wiki page is the structures root Wiki page, the structure will be automatically activated.

Once a stucture is active, pages belonging to the structure are displayed with a navigation bar.

The navigation bar provides icons to the next, parent, previous and homepage structure pages. In 1.10, there will be a tree icon which you can click to see the structure layout tree. On that page, if you have "tiki_p_edit_structures" permissions, you can modify the structure (see "Editing an Existing Structure" on Structure Admin for more info.

Slide Show

If the slide-show feature is enabled, selecting the 'slides' button from the page bar will display a structure page as a slide-show!

Table of contents tag ( {toc} )

Plugin Toc

TOC is short for "table of contents." Using a {toc} tag in a page belonging to a structure will 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).

A similar tag is {maketoc}, which makes a table of contents from the headings on a page (see PluginMaketoc).

Parameters

Default options for the possible parameters are shown below in bold.

Example 1: type plain

This code:

{toc order=asc shownum=1 type=plain }

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

Example 2: type fancy

This code:

{toc order=asc shownum=1 type=fancy }

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

Example 3: type fancy, showdesc

This code:

{toc order=asc shownum=1 type=fancy showdesc=1 }

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

Note that in this example, the description is shown first and is the hyperlink, and the title field shown second. If a page has no description field (like in many pages of the structure in this example), no description, link or title will be shown. So only use this option if ALL the pages in the table of contents have the description field set.

Example 4: pagename

This code:

{toc pagename="Documentation"}

Would produce a table of contents for the Documentation page.

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 a toc tag in another page.
   If you include the page with the toc tag without passing the name of the page to the toc tag, the toc will show the table of contents for the page where it is included, instead of showing the toc for the included page.
   This is useful for overview/portal pages.

Note: If you need to include a page with a toc from a different struture, you might need to pass the structure ID as well.

Navigation of toc in a module

You can do a dynamic side menu out from a table of contents of a structure of wiki pages through the module wikistructure.

Alias

• TOC

Using a {toc} tag in a page belonging to a structure will display a Table Of Contents for any sub-pages the page has. For this to work, the page must have sub-pages.

• Used in the structures 'root' page, this creates a full TOC.
• Used in a sub-page, this creates a chapter TOC.

Example 1: type plain

This code:

{toc order=asc shownum=1 type=plain }

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

Example 2: type fancy

This code:

{toc order=asc shownum=1 type=fancy }

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

Example 3: type fancy, showdesc

This code:

{toc order=asc shownum=1 type=fancy showdesc=1 }

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

Note that in this example, the description is used as the name of the page, instead of the title field, which is shown next to it. If a page has no description field (like in many pages of the structure in this example), no title is shown for the page, and no description is shown next to it. Since the link is shown at the page name, no description field means no link to go to that page. So that only use this option if ALL your pages have the description field set.

Print whole Structures at once

You can print a whole structure at once into a single html containing all pages with their corresponding images, etc., through the Wiki > Multiple print feature.

And you can optionally produce an odt file out of that, that you can use to create a pdf out of it easily with OpenOffice.org

See an example explained for the whole documentation here in doc.tw.o: Printing the Documentation

Watch Structures

tikiwiki>=1.10 If the perms(tiki_p_watch_structure) and the feature (feature_user_watches) have been set, it is possible to watch a structure. It means each time a page in the structure is changed or a page in the structure is added or removed, you can receive an email notification

Page versus Page in a structure

If you want by default that a page opens as a part of a structure, you have to check admin-> wiki -> Open page as structure: In this case the url tiki-index.php?page=Structures will display the structure navigation. If you do not check this option, the url tiki-index.php?page=Structures will not display the structure navigation, only the url tiki-index.php?page_ref_id=104 will do it