DokuWiki

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

====== 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:

-  **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>'' <code>
e.g. file                  name type          class
     <dokuwiki>/lib/plugins/acl/admin.php  => admin_plugin_acl
</code> \\
  -  **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>''. <code>
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
</code> \\

===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.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 [[devel:plugin info|plugin informations]] **required!**
    * ''lang/''
      * ''<language>/lang.php'' -- [[devel:localization#plugin_localization|Language 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.php'' -- [[configuration#Default settings]] for the [[devel:configuration#plugin settings]] (accessible via ''$this%%->%%getConf()'', saved local settings are stored in DokuWiki's global ''<dokuwiki>/conf/local.php'')
      * ''metadata.php'' -- [[configuration#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 [[http://pluginwizard.dokuwiki.org/|DokuWiki Plugin Wizard]].

===== CSS Styles =====
Please refer to [[devel:css#plugins_styles|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 [[:syndication|feed]]

===== Javascript =====
Please read [[devel:javascript]] for javascript loading and coding guidelines. Javascript files can contain DokuWiki specific syntax for [[devel:javascript#include_syntax|including other javascript files]].

Possible files, all optional:

* ''<dokuwiki>/lib/plugins/<pluginname>/''
    * ''script.js'' -- [[JavaScript]] used by the plugin
    * ''scripts/<filename>.js'' -- in script.js can be [[javascript#include_syntax|included other script files]].

See also [[devel:jqueryfaq|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

Please fill all the letters into the box to prove you're human. N C X W S Please keep this field empty:

Edit summary

Note: By editing this page you agree to license your content under the following license: CC Attribution-Share Alike 4.0 International