It's better when it's simple

User Tools

Site Tools



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

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
plugin:sketchcanvas [2015-08-11 15:47]
msakuta [Motivation] Created
plugin:sketchcanvas [2018-05-29 23:42] (current)
Klap-in [Installation]
Line 5: Line 5:
 author ​    : ​ Masahiro Sakuta author ​    : ​ Masahiro Sakuta
 email      :  ​ email      :  ​
-type       :  +type       : ​syntax, action 
-lastupdate : 2015-08-11 +lastupdate : 2015-09-12 
-compatible : Hrun+compatible : Hrun, Detritus
 depends ​   :  depends ​   : 
 conflicts ​ :  conflicts ​ : 
 similar ​   : edittable, svgedit similar ​   : edittable, svgedit
-tags       : editing+tags       : editing, vector, graphics, paintbrush, sketch, pencil
-downloadurl:​ https://​​msakuta/​SketchCanvas/​archive/​​ https://​​msakuta/​SketchCanvas/​archive/​
 bugtracker : https://​​msakuta/​SketchCanvas/​issues bugtracker : https://​​msakuta/​SketchCanvas/​issues
 sourcerepo : https://​​msakuta/​SketchCanvas/​tree/​dokuwiki sourcerepo : https://​​msakuta/​SketchCanvas/​tree/​dokuwiki
Line 28: Line 28:
 ===== Installation ===== ===== Installation =====
-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.+Search and install ​the plugin using the [[plugin:extension|Extension ​Manager]]. Refer to [[:​Plugins]] on how to install plugins manually.
 ==== Prerequisites ==== ==== Prerequisites ====
Line 39: Line 39:
 ===== Examples/​Usage ===== ===== Examples/​Usage =====
-The sketches are included ​by <​skcanvas>​ tag.+The best way to see how it works is by seeing 
 +[[http://​​doku.php?​id=start|this live demo site]].
-When a <​skcanvas>​ tag is included, a sketch is rendered in place of the tag like an image link+The sketches are included by %%<​skcanvas>​%% tag. 
 +When a %%<​skcanvas>​%% tag is included, a sketch is rendered in place of the tag like an image link
 and an edit button appears below it. and an edit button appears below it.
Line 76: Line 79:
 {{http://​​SketchCanvas/​media/​Example.png}} {{http://​​SketchCanvas/​media/​Example.png}}
 +==== Paths ====
 +Path tool is a versatile tool for sketching complex lines.
 +  * Path can be collection of line segments or curved splines.
 +  * Path can have arrowheads on one or both ends.
 +Below is actually rendered sketches converted to an image. (Source omitted)
 +==== Edit page ====
 +You don't have to remember the syntax to use the sketches.
 +There'​s an edit button below each sketch.
 +Pressing the edit button brings you to the [[plugin:​sketchcanvas:​editor]] page.
 +==== New Sketch ====
 +When you want to add a new sketch into a document, press new sketch button
 +in the toolbar in edit mode.
 +You can also edit existing sketch in the edit page by selecting a whole
 +%%< skcanvas >%% tag in the wikitext and pressing the button.
 +==== Output to PDF ====
 +This plugin works with [[plugin:​dw2pdf]] plugin to produce PDF with embedded
 +SketchCanvas documents.
 +To enable this feature with text elements in the canvas, you need to download
 +and place a font file named NotoSansCJKjp-Regular.otf from
 +to phplib/ subdirectory.
 ===== Syntax ===== ===== Syntax =====
 The SketchCanvas syntax is a [[http://​​|YAML]] document. The SketchCanvas syntax is a [[http://​​|YAML]] document.
-All text between <​skcanvas>​ and </​skcanvas>​ must be valid YAML document.+All text between ​%%<​skcanvas>​%% and %%</​skcanvas>​%% must be valid YAML document.
 +Although you don't have to remember them, complete syntax definition can be found at [[plugin:​sketchcanvas:​syntax]].
 ===== Configuration and Settings ===== ===== Configuration and Settings =====
plugin/sketchcanvas.1439300861.txt.gz · Last modified: 2015-08-11 15:47 (external edit)