Loading...
 

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.

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
Demonstrate Bug
Please demonstrate your bug on show2.tikiwiki.org

 About show2.tikiwiki.org

To help developers solve the bug, we kindly request that you demonstrate your bug on a show2.tikiwiki.org instance. To start, simply select a version and click on "Create show2.tikiwiki.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.tikiwiki.org.

Version: Create show2.tikiwiki.org instance
Ticket ID
3835
Created
Thursday 24 March, 2011 18:47:04 GMT-0000
LastModif
Thursday 26 January, 2012 10:48:52 GMT-0000

Attachments

 filenamecreatedhitscommentversionfiletype 
wikiplugin_externaltoc.php 24 Mar 11 18:48 GMT-000044Plugin implementation
tikilib.php 24 Mar 11 18:50 GMT-000042The currently used tikilib implementation.


Keywords

The following is a list of keywords that should serve as hubs for navigation within the Tiki development and should correspond to documentation keywords.

Each feature in Tiki has a wiki page which regroups all the bugs, requests for enhancements, etc. It is somewhat a form of wiki-based project management. You can also express your interest in a feature by adding it to your profile. You can also try out the Dynamic filter.

Accessibility (WAI & 508)
Accounting
Administration
Ajax
Articles & Submissions
Backlinks
Banner
Batch
BigBlueButton audio/video/chat/screensharing
Blog
Bookmark
Browser Compatibility
Calendar
Category
Chat
Comment
Communication Center
Consistency
Contacts Address book
Contact us
Content template
Contribution
Cookie
Copyright
Credits
Custom Home (and Group Home Page)
Database MySQL - MyISAM
Database MySQL - InnoDB
Date and Time
Debugger Console
Directory (of hyperlinks)
Documentation link from Tiki to doc.tiki.org (Help System)
Docs
DogFood
Draw
Dynamic Content
Preferences
Dynamic Variable
External Authentication
FAQ
Featured links
Feeds (RSS)
File Gallery
Forum
Friendship Network (Community)
Group
Help
History
Hotword
HTML Page
i18n (Multilingual, l10n, Babelfish)
Image Gallery
Import-Export
Install
Integrator
Interoperability
Inter-User Messages
InterTiki
jQuery
Kaltura video management
Karma
Live Support
Logs (system & action)
Lost edit protection
Mail-in
Map
Menu
Meta Tag
Missing features
Visual Mapping
Mobile
Mods
Modules
MultiTiki
MyTiki
Newsletter
Notepad
OS independence (Non-Linux, Windows/IIS, Mac, BSD)
Organic Groups (Self-managed Teams)
Packages
Payment
PDF
Performance Speed / Load / Compression / Cache
Permission
Poll
Profiles
Quiz
Rating
Realname
Report
Revision Approval
Scheduler
Score
Search engine optimization (SEO)
Search
Security
Semantic links
Share
Shopping Cart
Shoutbox
Site Identity
Slideshow
Smarty Template
Social Networking
Spam protection (Anti-bot CATPCHA)
Spellcheck
Spreadsheet
Staging and Approval
Stats
Survey
Syntax Highlighter (Codemirror)
Tablesorter
Tags
Task
Tell a Friend, alert + Social Bookmarking
Terms and Conditions
Theme
TikiTests
Timesheet
Token Access
Toolbar (Quicktags)
Tours
Trackers
TRIM
User Administration
User Files
User Menu
Watch
Webmail and Groupmail
WebServices
Wiki History, page rename, etc
Wiki plugins extends basic syntax
Wiki syntax text area, parser, etc
Wiki structure (book and table of content)
Workspace and perspectives
WYSIWTSN
WYSIWYCA
WYSIWYG
XMLRPC
XMPP




Useful Tools