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.

1. Navigating Structures
2. Slide Show
3. Table of contents tag ({toc})
4. Print whole Structures at once
5. Watch Structures
6. Page versus Page in a structure
7. How to add new pages directly in a pre-existing structure
Create a Menu from a structure toc

1. 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.

2. 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!

3. Table of contents tag ({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. See PluginToc for full documentation of this plugin.

4. 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

5. Watch Structures

tikiwiki>=2
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

6. 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

7. How to add new pages directly in a pre-existing structure

Sometimes you structure of wiki pages willbe long, such as the case of the Full Documentation structure here at doc.t.o.

Imagine that you want to add a page for a new Plugin. let's say "PluginExercise". You can create the new wiki page as orphan, or linked from a previous wiki page, but you lack the ability to have them inside the structure.

Having them inside the structure will allow users to find the page when they view the "toc" dynamically produced from the plugins list, or when printing the full structure, etc. So it's sensible to learn how to add new pages directly in the right spot of the previous structure that is supposed to work as a site map, etc.

You can do it by means of the page header of the previous page in the full toc structure. It's just 2 clicks away for the author willing to create a new page:

First click: doc.t.o left column : doc.tiki.org > "All the Documentation" ( https://doc.tiki.org/Documentation+TOC )
Second click: at the page name prior to the page where you want to create yours. "Plugin Events" (in this case). Well, yes, you have to scroll the page (which implies some extra click or Ctrl+F for the word "Plugin" ... )
Third click (same number of clicks as when creating the page by other means) : write the (new) page name at the header section of that page, and click at "Add page".
Add you content, Save. Done.

This can be done in a later stage, which will add your page to the previous structure.

Create a Menu from a structure toc

You can create Menus from structure table of contents by means of several ways:

Module menu <- recommended, which allows vertical or horizontal menus from a structure toc
Module wikistructure , which allows vertical menus from a structure toc
Module menupage plus hand written inclusion of structure tocs for a specific structId

alias

StructuresUser | Using Structures | UsingStructures