DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:rst

This is an old revision of the document!


rst Plugin

Compatible with DokuWiki

No compatibility info given!

plugin Allows use of RestructuredText in Dokuwiki

Last updated on
2015-10-07
Provides
Syntax
Repository
Source
Requires
docutils

This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.

Similar to markdown, markdownextra

:!: 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:

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.

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]

Change Log

[preferable GitHub RSS feed or similar]

  • 2009-01-01
    • Initial release

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]

Discussion

Could be placed on an external page (e.g. plugin:pluginname:discussion) to have a distinction between user comments and author docs

plugin/rst.1444224191.txt.gz · Last modified: 2015-10-07 15:23 by chrisisbd

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki