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
- 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.- 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).- page equals the current page:
- the plugin returns a maketoc statement.
- page is different than the current page:
- 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: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- page equals the current page:
- Importance
- 1 low
- Priority
- 5
- Demonstrate Bug (Tiki 19+)
-
This bug has been demonstrated on show2.tiki.org
Please demonstrate your bug on show2.tiki.org
Version: Create show2.tiki.org instanceAbout show2.tiki.orgTo help developers solve the bug, we kindly request that you demonstrate your bug on a show2.tiki.org instance. To start, simply select a version and click on "Create show2.tiki.org instance". Once the instance is ready (in a minute or two), as indicated in the status window below, you can then access that instance, login (the initial admin username/password is "admin") and configure the Tiki to demonstrate your bug. Priority will be given to bugs that have been demonstrated on show2.tiki.org.
- Ticket ID
- 3835
- Created
- Thursday 24 March, 2011 18:47:04 GMT-0000
by costamojan - LastModif
- Thursday 26 January, 2012 10:48:52 GMT-0000
;){kind=link}
;){kind=link}
- fresh opening of tiki home page tiki-index (I removed a warning) is it OK
- Tracker with field type "Numeric" won't
- tiki 25.1 Database 'xxxx'. Unable to connect to database (when 25.0 will connect)
- Kanban plugin; the Swimlane field throw an error if using a category field type
- Kanban plugin: Error if the fields Description and Swimlane are empty
;){kind=link}
;){kind=link}