Loading...
 
Skip to main content

Plugin to display the toc of a selected page.

Status
Open
Subject
Plugin to display the toc of a selected page.
Version
6.x
Category
  • Feature request
  • Patch
Feature
Wiki Plugin (extends basic syntax)
Submitted by
costamojan
Lastmod by
Marc Laporte
Rating
(0)
Description

For multipage wikis the display of the "table of content" using maketoc isn't ideal as this statement requires to be placed on every page otherwise it wouldn't be visible for other pages.
Usually this "table of content" is used for quick navigation purposes. Therefore an alternate to the maketoc statement should be provided which should allow to specify the wikipage which shall be outline. Such a statement can then be used in a module nearby the original wikipage.

Files
  1. Wikiplugin Externaltoc
  2. Tikilib
Solution

I've managed to write a new plugin EXTERNALTOC which basically behaves similar to the maketoc statement. I'm providing this information here because I'm a noob so my implementation is far away from being optimal. Nevertheless an experienced tiki-wiki developer might know how to optimise my code.

EXTERNALTOC


The API of the plugin itself is similar to the API of the maketoc . It only provides an additional parameter allowing to pass the page.
If the optional parameter page is omitted the name of the current page is used (only if it's given).

  1. page equals the current page:
    1. the plugin returns a maketoc statement.
  2. page is different than the current page:
    1. the plugin fetches the anchor-array from the tikilib and generates the outline (the necessary code has been copied from the tikilib and modified accordingly)

TIKILIB


The tikilib has been extended using copy and paste. The following three functions have been added:

  • get_page_toc_array($pageName)
  • parse_data_for_toc($data, $options = null) based upon parse_data
  • parse_data_process_maketoc_for_toc( &$data, $options, $noparsed) based upon parse_data_process_maketoc


Basically these function are just varieties of the mentioned functions with the difference that they don't provide the altered data. They're just delivering the array with the anchors.

One bad thing about my implementation is the fact that in "case of page equals current page" the data is fetched twice. One solution would be to store the list of anchors.

The plugin in action


To see the result of my currently sloppy implementation you can see my own site as an example:

http://www.kasisoft.com/Plex

I've just added a module to the left which only contains the following plugin content (commented out):

{*EXTERNALTOC()*}{*EXTERNALTOC*}

Therefore the outline is always generated for the current wiki page.

Bye
Kasimir

Importance
1 low
Priority
5
Demonstrate Bug on Tiki 19+
Please demonstrate your bug on show2.tiki.org
Demonstrate Bug (older Tiki versions)
 Show.tiki.org is currently unavailable

Unable to connect to show.tikiwiki.org. Please let us know of the problem so that we can do something about it. Thanks.

Ticket ID
3835
Created
Thursday 24 March, 2011 18:47:04 GMT-0000
by costamojan
LastModif
Saturday 06 July, 2024 10:21:44 GMT-0000