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 [2013-06-05 19:44] – [Plugin File Structure] Klap-in | devel:plugin_file_structure [2023-04-13 11:47] (current) – [Plugin File Structure] hsins | ||
---|---|---|---|
Line 10: | Line 10: | ||
Class definition: | Class definition: | ||
- | - **Single component** of one plugin type:\\ ''< | + | - **Single component** of one plugin type:\\ ''< |
e.g. file name type class | e.g. file name type class | ||
< | < | ||
- | </ | + | </ |
- | - **More components** of one plugin type:\\ ''< | + | - **More components** of one plugin type:\\ ''< |
e.g. file name type | e.g. file name type | ||
< | < | ||
Line 21: | Line 21: | ||
< | < | ||
< | < | ||
- | </ | + | </ |
+ | |||
+ | === Name conventions of plugin name === | ||
- | ===Name conventions of plugin name=== | ||
* an _ (underscore) is a reserved character and cannot be used in the ''< | * an _ (underscore) is a reserved character and cannot be used in the ''< | ||
* valid ''< | * valid ''< | ||
- | * two different plugins with the same name are mutually | + | * two different plugins with the same name are mutually |
+ | |||
+ | === Combining of plugin types and functions === | ||
- | ===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. | 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, | In addition, a plugin can (optionally) take advantage of other built-in facilities to have its styles, JavaScript, localisation, | ||
- | ===File | + | === 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 41: | Line 44: | ||
* '' | * '' | ||
* '' | * '' | ||
+ | * '' | ||
* '' | * '' | ||
* ''< | * ''< | ||
Line 49: | Line 53: | ||
* '' | * '' | ||
- | ===Use Plugin | + | === Use Plugin |
The simplest and recommended way to create the initial file system structure for new plugin is to use the [[http:// | The simplest and recommended way to create the initial file system structure for new plugin is to use the [[http:// | ||
- | |||
===== CSS Styles ===== | ===== CSS Styles ===== | ||
+ | |||
Please refer to [[devel: | Please refer to [[devel: | ||
Line 64: | Line 69: | ||
* '' | * '' | ||
+ | Since Binky, DokuWiki supports LESS parsing, you may use [[devel: | ||
+ | |||
+ | ===== JavaScript ===== | ||
- | ===== Javascript ===== | ||
Please read [[devel: | Please read [[devel: | ||
Line 75: | Line 82: | ||
See also [[devel: | See also [[devel: | ||
- | ===== Don't include Plugin manager files ===== | ||
- | There can be also auto-generated files around from the plugin | + | ===== Don't include Extension manager files ===== |
+ | |||
+ | There can be also auto-generated files around from the extension | ||
* ''< | * ''< | ||
* '' | * '' | ||
- | * '' | + | * '' |
===== See also ===== | ===== See also ===== | ||
+ | |||
* [[plugins|Plugin Developer documentation]] | * [[plugins|Plugin Developer documentation]] | ||
* [[Common Plugin Functions]] | * [[Common Plugin Functions]] | ||
- | * Plugin types: [[Action plugins|Action]], | + | * Plugin types: [[Action plugins|Action]], |
* [[security|Security Guidelines]] for plugin developers | * [[security|Security Guidelines]] for plugin developers | ||
* [[Plugin programming tips]] | * [[Plugin programming tips]] | ||
+ | |||
+ |
devel/plugin_file_structure.1370454250.txt.gz · Last modified: 2013-06-05 19:44 by Klap-in