DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:sketchcanvas

Differences

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-17 18:52]
msakuta [SketchCanvas Plugin] version update
plugin:sketchcanvas [2018-05-29 23:42] (current)
Klap-in [Installation]
Line 6: Line 6:
 email      :  ​ email      :  ​
 type       : syntax, action type       : syntax, action
-lastupdate : 2015-08-17 +lastupdate : 2015-09-12 
-compatible : Hrun+compatible : Hrun, Detritus
 depends ​   :  depends ​   : 
 conflicts ​ :  conflicts ​ : 
Line 13: Line 13:
 tags       : editing, vector, graphics, paintbrush, sketch, pencil tags       : editing, vector, graphics, paintbrush, sketch, pencil
  
-downloadurl:​ https://​github.com/​msakuta/​SketchCanvas/​archive/​DW-v0.1.1.zip+downloadurl:​ https://​github.com/​msakuta/​SketchCanvas/​archive/​dokuwiki.zip
 bugtracker : https://​github.com/​msakuta/​SketchCanvas/​issues bugtracker : https://​github.com/​msakuta/​SketchCanvas/​issues
 sourcerepo : https://​github.com/​msakuta/​SketchCanvas/​tree/​dokuwiki sourcerepo : https://​github.com/​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://​dokuwiki-type90.rhcloud.com/​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 75: Line 78:
  
 {{http://​msakuta.github.io/​SketchCanvas/​media/​Example.png}} {{http://​msakuta.github.io/​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)
 +
 +{{http://​imageshack.com/​a/​img540/​1420/​Ecx317.png}}
  
 ==== Edit page ==== ==== Edit page ====
Line 83: Line 97:
 {{http://​msakuta.github.io/​SketchCanvas/​media/​EditButton.png}} {{http://​msakuta.github.io/​SketchCanvas/​media/​EditButton.png}}
  
-Pressing the edit button brings you to the edit page.+Pressing the edit button brings you to the [[plugin:​sketchcanvas:​editor]] ​page.
  
 {{http://​msakuta.github.io/​SketchCanvas/​media/​EditButtonAfter.png}} {{http://​msakuta.github.io/​SketchCanvas/​media/​EditButtonAfter.png}}
Line 92: Line 106:
 in the toolbar in edit mode. in the toolbar in edit mode.
 You can also edit existing sketch in the edit page by selecting a whole You can also edit existing sketch in the edit page by selecting a whole
-< skcanvas > tag in the wikitext and pressing the button.+%%< skcanvas >%% tag in the wikitext and pressing the button.
  
 {{http://​msakuta.github.io/​SketchCanvas/​media/​NewSketch.png}} {{http://​msakuta.github.io/​SketchCanvas/​media/​NewSketch.png}}
 +
 +==== 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
 +https://​noto-website.storage.googleapis.com/​pkgs/​NotoSansCJKJP-hinted.zip
 +to phplib/ subdirectory.
 ===== Syntax ===== ===== Syntax =====
  
 The SketchCanvas syntax is a [[http://​yaml.org/​|YAML]] document. The SketchCanvas syntax is a [[http://​yaml.org/​|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]]. Although you don't have to remember them, complete syntax definition can be found at [[plugin:​sketchcanvas:​syntax]].
plugin/sketchcanvas.1439830379.txt.gz · Last modified: 2015-08-17 18:52 by msakuta