Loading...
 
How to use Structures
This page needs review


1. Introduction

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.


2.1. Browsing

When browsing through the Wiki:
  • If a page is part of one or more structures, a dedicated icon will appear at the top of the page (Image ). Select the structure name from this list to activate it.
    the dedicated icon doesn't appears and a structure is automatically activated in the following cases :
    • the wiki page is the structure's root Wiki page
    • the wiki page is part of only one structure and the "Open page as structure" option has been activated (see Structure Admin)
    • the wiki page is part of only one structure and the structure is defined in the url (wiki_page_url&structure=your_structure)

Once a stucture is active, pages belonging to the structure are displayed with a navigation bar.
Structure User Navigating
The navigation bar provides icons to the next (Image ), parent (Image ), previous (Image ) and homepage (Image ) structure pages.

If you have tiki_p_edit_structures permission, a structure icon (Image ) will appear to let you modify the structure and from Tiki15 you can also lock the Structure if you have the tiki_p_lock_structures permission (see below Managing an existing structure).

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

2.3. Table of contents tag ({toc})

Using a {toc} tag in a page belonging to the structure will display a Table of Contents for any sub-pages the page has. For this to work, the page must have sub-pages. The toc plugin can be used to display the Table of Contents for any structure by using its 'pagename' parameter and from Tiki12 it can also be used in a page that is not in a structure - see PluginToc for full documentation of this plugin.

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

3. Structure permissions


As could be expected, both global and category permissions can be granted for Structures, but as a Structure itself is not a categorisable object - whereas all the individual pages in a Structure are - the Structure permissions that apply to categorisation are 'taken' from whatever are applied to the top page of the Structure. This does provide a great deal of flexibility but can be a little confusing if not considered carefully.

From Tiki15 to make the Structure permissions more accessible/visible in the permission tables, a separate section has been created, labelled 'wiki structure' and the following Structure permissions are available:

  • tiki_p_admin_structures - both a global and a category/object permission that gives all the structure permissions to the user (this permission was added in Tiki15)
  • tiki_p_edit_structures - both a global and a category/object permission that enables the user to edit an existing structure and create new ones
  • tiki_p_lock_structures - both a global and a category/object permission that enables the user to lock the structure (this permission was added in Tiki15)
  • tiki_p_watch_structure - just a global permission at present that enables the user to monitor changes in the structure and receive email notification of changes (logically at some point this could also be made a category/object permission)

4. Managing existing structures / creating new ones

To create a new Structure or to modify an existing one, users must have tiki_p_edit_structures or tiki_p_admin_structures permission, either as a global permission for a non-categorised Structure or that permission must be applied to user for the category of the Structure's top page if categorisation is being used.

Access to the structure administration screens is from tiki-admin_structures.php, available from the menu Wiki > Structures, or while navigating the wiki, and the main administration is as shown below in the various tabs for different Tiki versions. It should be noted that the user must also have tiki_p_view wiki permission for the top page in order to see the Structure in the listing shown from tiki-admin_structures.php



Estest Struct Admin15 01

The listing of the existing structures and the 'creation' form for a new structure are separated into two individual tabs with a screen shot of the listing as shown above (the creation form is the same as in Tiki14): the actions for managing an individual structure are accessed by hovering over the 'wrench' icon as shown in the screen shot.

Depending upon what features have been 'switched on' the following are all the Actions that are possible and which permissions are needed in order to be able to use them:
  • Image View Structure: no structure permissions needed but when the Structure admin page is subsequently shown the Structure admin tools will only be displayed if the user has either tiki_p_admin_structures or tiki_p_edit_structures
  • Image View page: no structure permissions needed
  • Image Export pages: must have tiki_p_admin_structures to see this Action
  • PDF - detail still to be added
  • Image Dump tree: must have either tiki_p_admin_structures or tiki_p_edit_structures to see this Action
  • Image Remove: must have tiki_p_admin_structures to see this Action
  • Create WebHelp - detail still to be added
  • View WebHelp - detail still to be added
  • Image XML Zip: must have tiki_p_admin_structures to see this Action


From Tiki 15 a wiki structure can also be locked, meaning that the pages that are in a structure and the order/hierarchy of these pages can only be changed by the locking user. A new preference needs to be set to allow this structure locking option to be available and when set, a locked/unlocked icon is shown alongside the 'actions' wrench icon as illustrated above.

If the item is locked, hovering over the icon will show the user that has locked it and if the user has the 'locking' permission i.e. tiki_p_lock_structures, clicking this icon with lock/unlock the structure.

The tiki_p_lock_structures permission was created from Tiki15 onwards to allow individual users the privilege to carry out locking/unlocking and this is applied (as with all Structure permissions) to the top page of the Structure if categorisation is used or as a global permission if categorisation is not being used.

As with all the various permissions 'sets', if a user has been granted tiki_p_admin_structures (also added as a new permission in Tiki15) they can do all the various Structure activities including the unlocking of a structure locked by another user. To make structure permission management clearer and easier to find, a new 'wiki structure' section has been created in the permission tables from Tiki15 onwards.



DocTiki Struct Admin14 01 DocTiki Struct Admin14 02


The listing of the existing structures and the 'creation' form for a new structure are separated into two individual tabs as shown above, and the actions for managing an individual structure are accessed by hovering over the 'wrench' icon as shown in the screen shot on the left.



Structure User Select





5. Editing an existing structure

From the main structure listing table, as discussed above, you can select an individual structure and use the 'View structure' action to show the detailed hierarchy of the structure and from this screen, shown below for various Tiki versions, you can carry out different edits tasks that are discussedin the following sections.



Estest Struct Admin15 02

The only difference between Tiki14 and Tiki15 for this screen is that a lock/unlock icon is shown at the top of the hierarchy. In the same way as used in the main structure table, hovering over this icon will show the user that locked the structure if it locked, and if the user has the appropriate permission clicking the icon will lock/unlock the structure.





DocTiki Struct Admin14 03





5.1. Adding a new page

Select the structure you wish to edit in tiki-admin_structures.php (see above)

From tiki 9, as illustrated in the Tiki14 screen shot above, it is possible to simply drag an existing page from the page list shown at the bottom of the screen, and drop it where you want in the tree. It should be noted that as soon as this is done a Save button appears and the addition will only be finalised in the central database once this button is clicked.

Or you can use the "Add a new child page" button (Image ), shown to the right of each item in the structure page listing, to add a new page which will be created with a PluginToc inside.

Alternatively, you can add a new page while browsing the wiki, as a sister or child page to the page you are viewing.
This second process is often easier to work with in the case of a very long structure (such as the case of the Full Documentation structure here at doc.t.o).
For example you can add a page in the Documentation structure here at doc.t.o with just just 3 clicks :
  • First click: doc.t.o left column : doc.tiki.org > "All the Documentation" (All the Documentation)
  • 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".
    Image
  • Add you content, Save. Done.

5.2. Moving a page around

You can move a page in a structure via tiki-admin_structures.php with simple drag&drop, even through different levels.



5.3. Removing a page

You can remove a page from a structure via tiki-admin_structures.php. Just click on the associated button.
screenshot ?

Users with the tiki_p_admin_wiki permission on a wiki page (or globally) will be prompted a choice to delete the wiki page as well as removing it from the structure.
screenshot ?

5.4. 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. Alias

StructuresUser | Using Structures | UsingStructures | Structures User | Structure Usage

doc.tiki.org


Bootstrap

AdminGuide

UserGuide

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

Tiki Newsletter

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