Table of Contents
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).
<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
- 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
- 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
If you are creating multiple syntax components, their mode name in the
connectTo()method must also have
Name conventions of plugin name
- an _ (underscore) is a reserved character and cannot be used in the
<pluginname>should only contain the characters a-z and 0-9
- two different plugins with the same name are mutually exclusive and inherently 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.
All paths and files are relative to the plugin root directory.
style.css– CSS styles for the plugin
print.css– print CSS styles for the plugin
plugin.info.txt– A text file with plugin informations required!
deleted.files– (optional) A text file that lists files that are deleted if the plugin is updated.
<language>/lang.php– Language strings (accessible via
<language>/settings.php– localised strings used in the Configuration Manager
<language>/<filename>.txt– localised text including DokuWiki markup (accessible via
metadata.php– configuration 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.
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:
Since Binky, DokuWiki supports LESS parsing, you may use *.less files as well.
Possible files, all optional:
See also FAQ about jQuery
Don't include Extension manager files
There can be also auto-generated files around from the extension manager, don't include these in your final plugin download package:
disabled– This 0 byte file indicates the plugin is disabled.
manager.dat– Stores extension manager data e.g. download url and installation date