devel:plugin_file_structure
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
devel:plugin_file_structure [2010-05-17 20:27] – andi | devel:plugin_file_structure [2023-04-13 11:47] (current) – [Plugin File Structure] hsins | ||
---|---|---|---|
Line 3: | Line 3: | ||
There are two structures for the files of a DokuWiki plugin class. The structure chosen determines the name for the plugin class(es). | There are two structures for the files of a DokuWiki plugin class. The structure chosen determines the name for the plugin class(es). | ||
- | | + | Definitions: |
- | e.g. file | + | * ''< |
+ | * ''< | ||
+ | * ''< | ||
+ | |||
+ | Class definition: | ||
+ | |||
+ | - **Single component** of one plugin type: | ||
+ | e.g. file name type | ||
< | < | ||
- | </ | + | </ |
- | - ''< | + | - **More components** of one plugin type: |
- | e.g. file type | + | e.g. file name type component |
< | < | ||
< | < | ||
- | </ | + | or |
+ | <dokuwiki>/ | ||
+ | < | ||
+ | </ | ||
- | Note that an _ (underscore) is a reserved character and cannot be used in the ''< | + | === Name conventions of plugin name === |
- | A plugin may contain | + | * an _ (underscore) is a reserved character and cannot be used in the ''< |
+ | * valid ''< | ||
+ | * two different plugins | ||
- | In addition, a plugin can (optionally) take advantage of other built-in facilities to have its styles, JavaScript, localisation, | + | === 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, | ||
+ | |||
+ | === File Structure === | ||
All paths and files are relative to the plugin root directory. | All paths and files are relative to the plugin root directory. | ||
Line 26: | Line 44: | ||
* '' | * '' | ||
* '' | * '' | ||
- | * '' | + | |
- | * '' | + | |
- | * '' | + | * '' |
- | * '' | + | * ''< |
- | * '' | + | * ''< |
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
- | The simplest and recommended way to create the initial file system structure for new plugin is to use the [[http:// | + | === Use Plugin Wizard |
- | ===== How to include more than one JavaScript | + | The simplest and recommended way to create the initial |
- | [[:DokuWiki]] supports | + | ===== CSS Styles ===== |
+ | |||
+ | Please refer to [[devel:css# | ||
+ | |||
+ | Possible files, all optional: | ||
+ | |||
+ | * ''< | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | Since Binky, DokuWiki | ||
+ | |||
+ | ===== JavaScript ===== | ||
+ | |||
+ | Please read [[devel: | ||
+ | |||
+ | Possible files, all optional: | ||
+ | |||
+ | * ''< | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | See also [[devel: | ||
+ | |||
+ | ===== 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: | ||
+ | |||
+ | * ''< | ||
+ | * '' | ||
+ | * '' | ||
- | ===== How to include more than one CSS file ===== | + | ===== See also ===== |
- | The CSS should be merged into one file. | + | * [[plugins|Plugin Developer documentation]] |
+ | * [[Common Plugin Functions]] | ||
+ | * Plugin types: [[Action plugins|Action]], | ||
+ | * [[security|Security Guidelines]] for plugin developers | ||
+ | * [[Plugin programming tips]] | ||
- | ===== Disabled plugins ===== | ||
- | A plugin can be installed but disabled. |
devel/plugin_file_structure.1274120854.txt.gz · Last modified: 2010-05-17 20:27 by andi