1# Flowcharts Plugin for DokuWiki 2 3 4Add flowcharts and diagrams to Dokuwiki with an intuitive syntax 5 6The diagrams and flowcharts are generated with https://mermaidjs.github.io/. 7 8**With the current version of the plugin it is crucial to remove the following lines from the Dokuwiki file conf/entities.conf** 9 10 11``` 12<-> ↔ 13-> → 14<- ← 15--- — 16-- – 17``` 18 19Otherwise, Dokuwiki will render -> to → and then the diagrams are not rendered correctly since, e.g. → is the wrong syntax and we need -> etc. (For more information, see https://www.dokuwiki.org/entities and also https://github.com/splitbrain/dokuwiki/blob/master/conf/entities.conf.) 20 21# Syntax 22 23``` 24<flow> 25graph TD; 26 A-->B; 27 A-->C; 28 B-->D; 29 C-->D; 30</flow> 31``` 32 33will be rendered to 34 35![example diagram](examplediagram.png) 36 37A nice feature is that each element of a diagram can be made clickable by using 38 39``` 40<flow> 41graph TD; 42 A-->B; 43 A-->C; 44 B-->D; 45 C-->D; 46click A "SOMEPAGE" 47</flow> 48``` 49Clicking on `A` will take you to http://yoururl.com/SOMEPAGE. 50 51For further details on the syntax, see https://mermaidjs.github.io/. Diagrams can be built in realtime using https://mermaidjs.github.io/mermaid-live-editor/. 52 53If you install this plugin manually, make sure it is installed in 54lib/plugins/mermaidflowcharts/ - if the folder is called different it 55will not work! 56 57Please refer to http://www.dokuwiki.org/plugins for additional info 58on how to install plugins in DokuWiki. 59 60---- 61Plugin by Jakob Schwichtenberg http://jakobschwichtenberg.com 62 63This program is free software; you can redistribute it and/or modify 64it under the terms of the GNU General Public License as published by 65the Free Software Foundation; version 2 of the License 66 67This program is distributed in the hope that it will be useful, 68but WITHOUT ANY WARRANTY; without even the implied warranty of 69MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 70GNU General Public License for more details. 71 72See the LICENSING file for details 73