Differences

This shows you the differences between two versions of the page.

--- plugin:wavedrom [2018-07-12 18:03] – created wusixin
+++ plugin:wavedrom [2020-09-02 16:43] (current) – compatibility ezeller
@@ Line 2: / Line 2: @@
 ---- plugin ----
-description:
+description: Draw wavedrom diagrams based on wavedrom.js
-author     : wusixin
+author     : Raymond Wu
 email      : wusixin@gmail.com
-type       :
+type       : syntax
-lastupdate : 2018-07-12
+lastupdate : 2018-07-01
-compatible :
+compatible : !Hogfather
 depends    :
 conflicts  :
-similar    :
+similar    : diagram, Ditaa, Graphviz
-tags       :
+tags       : wavedrom, diagram
-downloadurl: # eg. http://github.com/wusixin/dokuwiki-plugin-wavedrom/zipball/master
+downloadurl: https://github.com/wusixin/dokuwiki-plugin-wavedrom/archive/master.zip
-bugtracker : # eg. http://github.com/wusixin/dokuwiki-plugin-wavedrom/issues
+bugtracker : https://github.com/wusixin/dokuwiki-plugin-wavedrom/issues
-sourcerepo : # eg. http://github.com/wusixin/dokuwiki-plugin-wavedrom/
+sourcerepo : https://github.com/wusixin/dokuwiki-plugin-wavedrom/
 donationurl:
-screenshot_img :
+screenshot_img : https://raw.githubusercontent.com/wusixin/dokuwiki-plugin-wavedrom/master/screnshotwavedrom.png
 ----
-//:!: 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)]//
+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
-:!: **External requirements:** This 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 [[:Plugins]] on how to install plugins manually.
 ===== Examples/Usage =====
-//[Most people learn by example, so this goes first]//
+<code>
+<wavedrom>
+{ "signal" : [
+  { "name": "clk",         "wave": "p.....|..." },
+  { "name": "Data",        "wave": "x.345x|=.x", "data": ["head", "body", "tail", "data"] },
+  { "name": "Request",     "wave": "0.1..0|1.0" },
+  {},
+  { "name": "Acknowledge", "wave": "1.....|01." }
+]}
+</wavedrom>
+</code>
-See the plugin in action [[www.demosite.com|here]]. The sample page shows all the styles available with the plugin.
+The output is as snapshot above.
-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:
-<code>{{actionlink>action|title}}</code>
-  * **action** can be one of this:
-    * //edit//    --- edit/create/show
-    * //history// --- old revisions
-===== Configuration and Settings =====
+  <wavedrom>...</wavedrom>
-//[also CSS style tips]//
+  * **%%...%%** wavedrom flowchart definition, which should follow grammar in wavedrom.com.
-===== Development =====
+===== Configuration and Settings =====
-//[downloadable blocks, development comments]//
 === Change Log ===
-//[preferable GitHub RSS feed or similar]//
+  * **2018-07-01**
-  * **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//