Learn about DokuWiki
Learn about DokuWiki
This page is both a template and a set of general guidelines for how to create a page for your plugin in the plugin namespace. Most of these guidelines are, of course, optional, but following them will make your plugin documentation more consistent with other entries on the web site.
Instructions for each section will be in italics. Example text is provided for most sections. You should remove all of the instructions and example text when you create your plugin page.
This structure of this template is primary specified for syntax plugins. However, please use your best judgement and adjust the content as necessary. For example, for most other plugins you would not need the Syntax or Example sections.
====== Example Plugin ====== ---- plugin ---- description: Just an example to prove the point author : Joe Blow email : email@example.com type : syntax, action, admin, helper, render lastupdate : 2007-12-17 compatible : Anteater, 2010-02-14 depends : plugin1 conflicts : plugin2 similar : plugin3 tags : example, sample downloadurl: https://github.com/example/dokuwiki-plugin-sample/zipball/master bugtracker : https://github.com/example/dokuwiki-plugin-sample/issues sourcerepo : https://github.com/example/dokuwiki-plugin-sample/ donationurl: https://www.paypal.com/... ----
This section is required.
A short description of what your plugin does… and why it's useful. It should be in more detail than 'description' field of plugin header. This is marketing!
This section should be a compliment to the Description section above. Its purpose is to demonstrate the basic usage of your plugin. It is not intended to be the place to demonstrate every feature and option, nor show off all that your plugin can do. Save the details of your plugins capabilities for the Syntax section.
If you have screenshots of your plugin in action, this would be an ideal place to add them. Since dokuwiki.org does not host screenshots it is recommended that you upload your images to ImageShack by using the “Upload to ImageShack” link from within the Media Manager.
Please be judicious when adding images to your plugin page. The content area of the plugin page is limited to approximately 680 pixels in width. If you need to add an image larger than 680×300, use a thumbnail to link to the original image. Limit the size of the thumbnail to 200×200.
A simple box:
<box> the box contents </box>
Some more complex boxes
<box 80% round orange|a title> the box contents</box> <box 50% left blue>the box contents</box|a caption> <box 60% round #f99 #fc9 #fcc #f60|title>the box contents></box|caption>
If your plugin requires more information to properly install it than merely pasting the download URL into the Plugin Manager, you should document the details in this section. If your plugin has dependencies beyond the stock DokuWiki installation, such as additional plugins or specific OS software, you should list them here.
If the plugin can be installed using the Plugin Manager, it is safe to omit this section.
External requirements: This plugin requires the following additional components that must be installed separately:
Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually. The local plugin directory must have the same name as the plugin is named, otherwise the plugin won't work properly.
Use this section to provide the detailed documentation for your plugin. Unlike the Examples or Usage section, you should use this section to fully document the operation of your plugin.
If your plugin can take advantage of specialized configuration then document it here. Examples would be options in the Configuration Manager and providing CSS style tips.
downloadable blocks, development comments
preferable GitHub RSS feed or similar
Example rss feed for
Be clear where you like to see bug and feature request. In the bugtracker (e.g. Github) or here in this section.
Manage subscriptionsoption in page tools on your right hand side.
Maintain any FAQs in this section. If this section becomes too long, consider improving your documentation or moving this section to a new page.
Yes, it is.
The Discussion section should be added so as to maintain a distinction between user comments and author documentation. Discussions should ideally be deleted and turned into FAQ entries along the way. It's recommended that you subscribe to your plugin page so you can address any issues that end-users bring up.
If you prefer to maintain a discussion page off-site, such as in a forum or mailing list, indicate so in this section and provide the appropriate links or information for users to participate.