xref: /plugin/dev/README (revision f57a6a5c44ae91ca3f48acd858a81e992d4131f5)
136c0b2b4SAndreas Gohrdev plugin for DokuWiki
236c0b2b4SAndreas Gohr
336c0b2b4SAndreas GohrThe DokuWiki Developer's tool
436c0b2b4SAndreas Gohr
536c0b2b4SAndreas GohrAll documentation for this plugin can be found at
636c0b2b4SAndreas Gohrhttps://www.dokuwiki.org/plugin:dev
736c0b2b4SAndreas Gohr
836c0b2b4SAndreas GohrIf you install this plugin manually, make sure it is installed in
936c0b2b4SAndreas Gohrlib/plugins/dev/ - if the folder is called different it
1036c0b2b4SAndreas Gohrwill not work!
1136c0b2b4SAndreas Gohr
1236c0b2b4SAndreas GohrPlease refer to http://www.dokuwiki.org/extensions for additional info
1336c0b2b4SAndreas Gohron how to install extensions in DokuWiki.
1436c0b2b4SAndreas Gohr
15*f57a6a5cSAndreas GohrPlugin Wizard
16*f57a6a5cSAndreas Gohr=============
17*f57a6a5cSAndreas Gohr
18*f57a6a5cSAndreas GohrThis repository serves a dual purpose. It's main purpose it to provide
19*f57a6a5cSAndreas Gohra plugin for DokuWiki that helps developers to create new plugins. It
20*f57a6a5cSAndreas Gohralso provides the web interface known as the "DokuWiki Plugin Wizard"
21*f57a6a5cSAndreas Gohravailable at https://pluginwiz.dokuwiki.org/ - files for that are
22*f57a6a5cSAndreas Gohrin the www subdirectory.
23*f57a6a5cSAndreas Gohr
24*f57a6a5cSAndreas GohrUsers of the plugin do not need to bother with the wizard parts (in
25*f57a6a5cSAndreas Gohrfact they are not included in the download when the plugin is installed
26*f57a6a5cSAndreas Gohrvia the plugin manager).
27*f57a6a5cSAndreas Gohr
28*f57a6a5cSAndreas GohrIf you want to work on the wizard code, you need to install the
29*f57a6a5cSAndreas Gohrdependencies using composer. This is needed because the wizard runs
30*f57a6a5cSAndreas Gohrindependent of a DokuWiki installation.
31*f57a6a5cSAndreas Gohr
32*f57a6a5cSAndreas GohrWizard and plugin only share the skeletons (in the skel directory)
33*f57a6a5cSAndreas Gohrand the Skeletor class which implements the logic for using the
34*f57a6a5cSAndreas Gohrskeletons.
35*f57a6a5cSAndreas Gohr
3636c0b2b4SAndreas Gohr----
3736c0b2b4SAndreas GohrCopyright (C) Andreas Gohr <andi@splitbrain.org>
3836c0b2b4SAndreas Gohr
3936c0b2b4SAndreas GohrThis program is free software; you can redistribute it and/or modify
4036c0b2b4SAndreas Gohrit under the terms of the GNU General Public License as published by
4136c0b2b4SAndreas Gohrthe Free Software Foundation; version 2 of the License
4236c0b2b4SAndreas Gohr
4336c0b2b4SAndreas GohrThis program is distributed in the hope that it will be useful,
4436c0b2b4SAndreas Gohrbut WITHOUT ANY WARRANTY; without even the implied warranty of
4536c0b2b4SAndreas GohrMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
4636c0b2b4SAndreas GohrGNU General Public License for more details.
4736c0b2b4SAndreas Gohr
4836c0b2b4SAndreas GohrSee the LICENSING file for details
49