plugin:rst
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
| plugin:rst [2015-10-07 14:58] – created chrisisbd | plugin:rst [2019-09-14 22:20] (current) – Dokuwiki to DokuWiki Aleksandr | ||
|---|---|---|---|
| Line 2: | Line 2: | ||
| ---- plugin ---- | ---- plugin ---- | ||
| - | description: | + | description: |
| - | author | + | author |
| - | email : chris@isbd.co.uk | + | email : chris@isbd.co.uk |
| type : syntax | type : syntax | ||
| lastupdate : 2015-10-07 | lastupdate : 2015-10-07 | ||
| compatible : | compatible : | ||
| - | depends | + | depends |
| conflicts | conflicts | ||
| similar | similar | ||
| - | tags : | + | tags : |
| - | downloadurl: | + | downloadurl: |
| - | bugtracker : # eg. http://github.com/ | + | bugtracker : https://bitbucket.org/ |
| - | sourcerepo : # eg. http://github.com/ | + | sourcerepo : https://chrisisbd@bitbucket.org/ |
| donationurl: | donationurl: | ||
| screenshot_img : | screenshot_img : | ||
| ---- | ---- | ||
| - | |||
| - | //:!: 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/ | ||
| ===== Installation ===== | ===== Installation ===== | ||
| - | //[First, last and only chance to warn users before installing (some has already done that before reading this)]// | + | **External requirements: |
| - | :!: **External requirements: | + | The rst plugin requires the following additional components that must be installed separately: |
| - | * [[A banana]] | + | |
| - | * [[Another banana]] | + | |
| - | Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[: | + | * Docutils - see http://docutils.sourceforge.net/ |
| - | ===== Examples/ | ||
| - | //[Most people learn by example, so this goes first]// | + | Search and install the plugin using the [[plugin: |
| - | See the plugin in action [[www.demosite.com|here]]. The sample page shows all the styles available with the plugin. | + | ===== Examples/ |
| - | A simple box: | + | The plugin accepts all the RestructuredText syntax described at http:// |
| + | two ways to use it, either with <rst> directives in an existing Dokuwiki page or by creating pages with a .rst | ||
| + | suffix. | ||
| - | <box> the box contents </ | + | ==Using directives== |
| - | Some more complex boxes | + | Just wrap the RestructuredText in the directives: |
| - | <box 80% round orange|a title> the box contents</ | + | <rst> |
| - | | + | |
| - | | + | </rst> |
| - | //[Pictures showing the rendered result will help users to understand]// | + | ==Filename with .rst suffix== |
| - | ===== Syntax ===== | + | Create a new page, if you create a link to a new page called newpage.rst within Dokuwiki the page will |
| + | actually have the filename newpage.rst.txt, | ||
| + | as RestructuredText. | ||
| + | pagename.rst.txt. | ||
| - | //[Complete syntax]// | ||
| - | Basic syntax: | ||
| - | < | ||
| - | * **action** can be one of this: | ||
| - | * // | ||
| - | * //history// --- old revisions | ||
| - | ===== Configuration and Settings ===== | ||
| - | |||
| - | //[also CSS style tips]// | ||
| - | |||
| - | ===== Development ===== | ||
| - | |||
| - | // | ||
| === Change Log === | === Change Log === | ||
| - | // | ||
| - | * **2009-01-01** | ||
| - | * Initial release | ||
| === Known Bugs and Issues === | === Known Bugs and Issues === | ||
| - | //[this section might not be needed | + | * Appears to be broken with 2018-04-22b " |
| === ToDo/Wish List === | === ToDo/Wish List === | ||
| - | |||
| - | // | ||
| ===== FAQ ===== | ===== FAQ ===== | ||
| - | // | + | |
| ===== Discussion ===== | ===== Discussion ===== | ||
| - | //Could be placed on an external page (e.g. plugin: | ||
plugin/rst.1444222724.txt.gz · Last modified: 2015-10-07 14:58 by chrisisbd