Table of Contents
@PAGE@ Plugin
Compatible with DokuWiki
No compatibility info given!
The missing download url means that this extension cannot be installed via the Extension Manager. Please see Publishing a Plugin on dokuwiki.org. Recommended are public repository hosts like GitHub, GitLab or Bitbucket.
Extension name contains underscore, will not generate popularity points.
This template contains various hints on how to fill in data (formatted in italics). Be sure to remove the hints and unwanted sections (Eg. the Syntax/Example section for non-syntax plugins.
Installation
[First, last and only chance to warn users before installing (some has already done that before reading this)]
External requirements: This plugin requires the following additional components that must be installed separately:
Search and install the plugin using the Extension Manager. Refer to Plugins on how to install plugins manually.
Examples/Usage
[Most people learn by example, so this goes first]
See the plugin in action here. The sample page shows all the styles available with the plugin.
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>
[Pictures showing the rendered result will help users to understand]
Syntax
[Complete syntax]
Basic syntax:
{{actionlink>action|title}}
- action can be one of this:
- edit — edit/create/show
- history — old revisions
Configuration and Settings
[also CSS style tips]
Development
[downloadable blocks, development comments]
The source code of the plugin is available at GitHub: https://github.com/@USER@/dokuwiki-plugin-@PAGE@.
Changelog
[preferable GitHub RSS feed or similar]
- An error occurred while fetching this feed: https://github.com/@USER@/dokuwiki-plugin-@PAGE@/commits/master.atom
Known Bugs and Issues
[this section might not be needed in case of external bug manager, or use RSS feed]
ToDo/Wish List
[developers roadmap]
FAQ
[discussions should ideally be deleted and turned into FAQ entries along the way]