Follow glFusion on Facebook Follow glFusion on Twitter
Sign Up!
Login
Welcome to glFusion
Tuesday, February 09 2010 @ 01:43 AM CST
 

DokuWiki Integration to glFusion CMS

DokuWiki is a standards compliant, simple to use Wiki, mainly aimed at creating documentation of any kind. It is targeted at developer teams, workgroups and small companies. It has a simple but powerful syntax which makes sure the datafiles remain readable outside the Wiki and eases the creation of structured texts. All data is stored in plain text files – no database is required.

The DokuWiki Integration Plugin for glFusion provides an integration with your glFusion v1.0.0+ website. This plugin is based on DokuWiki 2009-02-12b, the latest release available at the time of publishing this plugin release.

This plugin will provide the following features:

  • Integrated user authentication - All glFusion users will be mapped to DokuWiki. There will be no need to have DokuWiki provide any user administration.
  • DokuWiki's contents will be searched using glFusion's Search and Advanced Search.
  • glFusion's administrators (members of the Root group) will have administrative capabilities in DokuWiki.
  • glFusion groups can be used to assign permissions in DokuWiki.
  • Integration with glFusion's What's New block.
  • Support for a [wiki:] auto tag.
  • Automatic detection of the users language setting so DokuWiki will use the same language.
  • DokuWiki will be integrated into the glFusion site's layout (this is accomplished by using a custom DokuWiki skin).

System Requirements

DokuWiki has the following system requirements:

  • PHP 4.3.3 and higher. Because of some security issues PHP 4.3.10 or higher is strictly recommended. (PHP5 should be fine.)
  • PHP's GD extension for use with libGD 2 (a graphics library) is recommended but not needed
  • DokuWiki should work in PHP's Safe Mode, depending on your hosters configuration you may need to use the safemodehack option
  • DokuWiki is designed to run with PHP's Option register_globals set to off.

This integration is based on glFusion v1.1.2 and will not work with previous version of glFusion.

DokuWiki requires that your site be configured with UTF-8 encoding. If you site is not already setup for UTF-8, you may want to consider converting. Installing DokuWiki on a non-UTF-8 site will work, but some characters may get corrupted.
For those running on Windows IIS, if you have IIS password installed to mimic .htaccess password behavior you will have issues with DokuWiki. In order to get around this delete all .htaccess files in /public_html/dokuwiki/. Do not delete the .htaccess files unless you have a problem, this is a rare set of circumstances.

Installation

The DokuWiki Plugin uses the glFusion automated plugin installer. Simply upload the distribution using the glFusion plugin installer located in the Plugin Administration page.

DokuWiki must have write permissions to the public_html/dokuwiki/data/ directory and all directories below it. The plugin installer will check these permissions, please ensure they are writable by your web server.

Upgrading DokuWiki

To upgrade an existing DokuWiki installation, simply upload the latest version through the Plugin Administration page. All your wiki pages will be left as they are.

Configuring DokuWiki

There are a few protected DokuWiki configuration options that cannot be edited:

  • User Manager is disabled by the plugin - user management is done in glFusion
  • The following Configuration Management fields cannot be edited
    • Use access control lists
    • Autogenerate passwords
    • Authentication backend
    • Password encryption method
    • Superuser

All other DokuWiki configuration settings can be customized to meet your specific needs. For full details on each configuration option, please see wiki:config.

DokuWiki Templates

DokuWiki's layout can be customized through templates (aka. skins). The DokuWiki Integration Plugin must use a customized DokuWiki template to properly integrate the look and feel of the glFusion site. Included with the plugin is one customized skins, glfusion.

The glfusion skin is the default skin included with DokuWiki but it has been customized by removing much of the header information that is provided by glFusion.

If you wish to change the look and feel, or use a different DokuWiki template, you must make the following changes (at a minimum):

  • add a call to glFusion's COM_siteHeader() near the beginning of the template
  • add a call to glFusion's COM_siteFooter() at the bottom of the template
  • remove all HTML header tags (you will need to leave the meta data)

Review the modifications to the glfusion templates for examples.

glFusion Groups and DokuWiki Permissions

After a successful installation, there are two default permissions:

  • glFusion Root members will be DokuWiki administrators
  • ALL users will have read access

To grant additional permissions, you can map glFusion groups to DokuWiki permissions. To map these permissions, go into the Admins Only → DokuWiki → Access Control List Management. From here, you will see the group ALL has Read permissions. You can add a new group by entering its name in the text box and selecting the permissions.

DokuWiki does not support spaces or _ (underscores) in the Group names. So these items are stripped from the glFusion groups. For example, the glFusion group Logged-in Users will become LoggedinUsers.

glFusion Integration

The DokuWiki plugin allows you to integrate certain parts of DokuWiki in with your glFusion site.

What's New Block

You can enable / disable having DokuWiki display new / edited files in glFusion's What's New Block by editing the config.php file in the plugins/dokuwiki/ directory. Set $_DW_CONF['enable_whats_new'] = 1 to enable, or 0 to disable.

Auto Tag

This plugin creates a new auto tag: [wiki:] To utilize this tag in your glFusion articles or forums, the syntax is:

  [wiki:documentid optional link text]

The document id can be found in the URL (the document id for this article is dokuwikiplugin:start).

Using DokuWiki

For all usage questions and documentation on how to utilize DokuWiki, please refer to the DokuWiki Web Site.

ChangeLog

v1.7.2

  • Fixed issue where glFusion email was not properly set (Mark)
  • Added autotags plugin to implement glFusion auto tags in the wiki (Mark)
  • Changed initial setting for use nice URLs to none (Mark)
  • Both DokuWiki and glFusion use the same EmailValidator - ensure it is only loaded once.
  • Change initial configuration settings so URL rewrite is not used.
  • Fixed error in image retrieval where it did not know about glFusion permissions. (Mark)

v1.7.1

  • Fixed LFI issue with main DokuWiki code (Mark)
  • What's New block did not use DokuWiki's URL rewrite setting (Mark)
 
Logged in as: Guest (Guest)
dokuwikiplugin/start.txt · Last modified: 2010/02/01 20:12 (external edit)
 
Except where otherwise noted, content on this wiki is licensed under the following license:GNU Free Documentation License 1.2

My Account





Sign up as a New User
Lost your password?

Want to Help?

Join the Dev Community today! Interested in helping out?
Join our Dev Community!

Support glFusion

Vote for glFusion at opensourcecms.com