DokuWiki

It's better when it's simple

User Tools

Site Tools


Sidebar

Translations of this page?:

Learn about DokuWiki

Advanced Use

Corporate Use

Our Community


Follow us on Facebook, Twitter and other social networks.

devel:plugin_file_structure

Plugin File Structure

There are two structures for the files of a DokuWiki plugin class. The structure chosen determines the name for the plugin class(es).

Definitions:

  • <pluginname> – simple and unique name, also name of plugin directory
  • <plugin type> – characterizes the function of plugin e.g. syntax, auth, action…
  • <plugin component> – needed when plugin has more components of one type

Class definition:

  1. Single component of one plugin type:
    <dokuwiki>/lib/plugins/<plugin name>/<plugin type>.php
    the plugin class name will be <plugin type>_plugin_<plugin name>
    e.g. file                  name type          class
         <dokuwiki>/lib/plugins/acl/admin.php  => admin_plugin_acl


  2. More components of one plugin type:
    <dokuwiki>/lib/plugins/<plugin name>/<plugin type>/<filename>.php
    This structure allows several plugin classes of one plugin type within one plugin.
    The class names will be <plugin type>_plugin_<plugin name>_<filename>.
    e.g. file                   name type   component     class
         <dokuwiki>/lib/plugins/code/syntax/code.php   => syntax_plugin_code_code
         <dokuwiki>/lib/plugins/code/syntax/file.php   => syntax_plugin_code_file
    or
         <dokuwiki>/lib/plugins/code/auth/file.php     => auth_plugin_code_file
         <dokuwiki>/lib/plugins/code/auth/file.php     => auth_plugin_code_file


Name conventions of plugin name

  • an _ (underscore) is a reserved character and cannot be used in the <pluginname>
  • valid <pluginname> should only contain the characters a-z and 0-9
  • two different plugins with the same name are mutually excluding and inherent incompatible.

Combining of plugin types and functions

A plugin may contain several different plugins types as well as several different plugin classes(components) of each type.

In addition, a plugin can (optionally) take advantage of other built-in facilities to have its styles, JavaScript, localisation, and configuration included in DokuWiki. See also common plugin functions.

File structure

All paths and files are relative to the plugin root directory.

  • <dokuwiki>/lib/plugins/<pluginname>/
    • style.cssCSS styles for the plugin
    • print.css – print CSS styles for the plugin
    • script.jsJavaScript used by the plugin
    • plugin.info.txt – A text file with plugin informations required!
    • lang/
      • <language>/lang.phpLanguage strings (accessible via $this->getLang())
      • <language>/settings.php – localised strings used in the Configuration Manager
      • <language>/<filename>.txt – localised text including DokuWiki markup (accessible via $this->locale_xhtml())
    • conf/
      • default.phpDefault settings for the plugin settings (accessible via $this->getConf(), saved local settings are stored in DokuWiki's global <dokuwiki>/conf/local.php)
      • metadata.phpconfiguration metadata describing properties of the settings for use by Configuration Manager

Use Plugin wizard

The simplest and recommended way to create the initial file system structure for new plugin is to use the DokuWiki Plugin Wizard.

CSS Styles

Please refer to CSS stylesheets for plugins for more info which style files you can use and how. Only the CSS style files listed below are available, all your CSS should be merged into one of these files, including or referring other style files is not available.

Possible files, all optional:

  • <dokuwiki>/lib/plugins/<pluginname>/
    • style.cssCSS styles for the plugin. Usually only used css file.
    • print.css – print CSS styles for the plugin
    • all.css – Applied in all display modes
    • feed.css – Applied when displaying the feed

Since Binky DokuWiki supports LESS parsing, you may use *.less files as well.

Javascript

Please read javascript for javascript loading and coding guidelines. Javascript files can contain DokuWiki specific syntax for including other javascript files.

Possible files, all optional:

See also FAQ about jQuery

Don't include Plugin manager files

There can be also auto-generated files around from the plugin manager, don't include these in your final plugin download package:

  • <dokuwiki>/lib/plugins/<pluginname>/
    • disabled – This 0 byte file indicates the plugin is disabled.
    • manager.dat – Stores plugin manager data e.g. download url and installation date

See also

devel/plugin_file_structure.txt · Last modified: 2013/12/15 12:42 by ach