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

1. <dokuwiki>/lib/plugins/<plugin name>/<plugin type>.php
   the plugin class name will be <plugin type>_plugin_<plugin name>

   e.g. file                       type          class
        <dokuwiki>/lib/plugins/acl/admin.php  => admin_plugin_acl

   
   

2. <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                        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

   
   

Note that an _ (underscore) is a reserved character and cannot be used in the <plugin name>.

A plugin may contain several different plugins types as well as several different plugin classes 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.

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

• <dokuwiki>/lib/plugins/<pluginname>/
  • style.css – CSS styles for the plugin
  • print.css – print CSS styles for the plugin
  • script.js – JavaScript used by the plugin
  • plugin.info.txt – A text file with plugin informations required!
  • lang/<language>/lang.php – Language strings (accessible via $this->getLang())
  • lang/<language>/settings.php – localised strings used in the configuration manager
  • lang/<language>/<filename>.txt – localised text including DokuWiki markup (accessible via $this->locale_xhtml())
  • conf/default.php – default settings (accessible via $this->getConf(), local settings are added to DokuWiki's global <dokuwiki>/conf/local.php)
  • conf/metadata.php – configuration metadata describing the settings for use by configuration manager

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:

• <dokuwiki>/lib/plugins/<pluginname>/
  • style.css – CSS 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

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

Possible files, all optional:

• <dokuwiki>/lib/plugins/<pluginname>/
  • script.js – JavaScript used by the plugin
  • scripts/<filename>.js – in script.js can be included other script files.

See also FAQ about jQuery

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

• Plugin Developer documentation
• Plugin types: Action, Admin, Remote, Helper, Syntax and Renderer
• Security Guidelines for plugin developers
• Common Plugin Functions