Table of Contents
WikkaWiki Plugin
This is a port of the WikkaWiki Wiki system to be integrated with glFusion.
Requirements
- glFusion v1.1.8 or newer
Installation
This plugin uses the glFusion automated plugin installer. Simply upload the distribtuion using the glFusion plugin installer located in the Plugin Administration page.
The plugin may be installed manually, if necessary.
Upgrading
The upgrade process is identical to the installation process, simply upload the distribution from the Plugin Administration page.
Features
WikkaWiki is a relatively lightweight Wiki that stores its pages in the MySQL database. Compared to DokuWiki, it has a much smaller footprint, but is missing a couple of key features.
For a list of WikkaWiki's features, visit the web site. The features added in this port are:
- Integration with glFusion's user management. User names (“WikiNames”) are replaced by the user ID number. ACL's are still used by name.
- Support for autotags.
There are some missing features:
- Media Uploads : While WikkaWiki can display images via tags in the wiki pages, it has no method for uploading or searching for them. One solution is to use autotags and a hidden Media Gallery album.
- Table of Contents : This is under development as an action/formatter combination, and works in testing.
AutoTags
WikkiWiki supports “actions” which are called by surrounding a string with pairs of braces. For example, including “{{myaction}}” in a page would cause the wiki to execute “myaction.php”, located in the actions or plugins/actions directory. Additional variables may be provided, such as “{{myaction var1:var2 var3}}”. This syntax is different from glFusion's autotag format of “[tagname:var var var]”. To call a glFusion autotag from within a wiki page, use this syntax:
{{autotag tagname:var var var}}
The wiki will format the tag properly and call PLG_replaceTags() with the correct content.
For example, and as a workaround to the lack of a media upload facility, you can use {{autotag img:mg_image_id src:disp}}. This has the same effect as using [img:mg_image_id src:disp] elsewhere in glFusion.
Table of Contents
A table of contents can be dynamically generated for each Wiki page by adding {{toc}} where you would like the TOC to be located. This is currently under development, and does not seem to display correctly if the action tag used by itself. You should use
>>{toc}>>
to have the table of contents moved to the right and displayed similarly to DokuWiki's TOC.
Administration
Configuration Options
Under construction. All configurations must currently be done via the plugin's configuration file.
| Option | Description |
|---|
License
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.