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 revisionPrevious revision
Next revision
Previous revision
plugin:sketchcanvas [2015-08-11 15:47] – [Motivation] Created msakutaplugin:sketchcanvas [2024-01-07 16:37] (current) – Add support for Hogfather, Igor and Jack Jackrum msakuta
Line 5: Line 5:
 author     :  Masahiro Sakuta author     :  Masahiro Sakuta
 email      :   email      :  
-type       :  +type       : syntax, action 
-lastupdate : 2015-08-11 +lastupdate : 2024-01-08 
-compatible : Hrun+compatible : Hrun, Detritus, Greebo, Hogfather, Igor, Jack Jackrum
 depends    :  depends    : 
 conflicts  conflicts 
 similar    : edittable, svgedit similar    : edittable, svgedit
-tags       : editing+tags       : editing, vector, graphics, paintbrush, sketch, pencil
  
-downloadurl: https://github.com/msakuta/SketchCanvas/archive/DW-v0.1.0.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 <skcanvastag.+The best way to see how it works is by seeing 
 +<del>this live demo site</del> Demo site is dead!
  
-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://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 ====
 +
 +You don't have to remember the syntax to use the sketches.
 +There's an edit button below each sketch.
 +
 +{{http://msakuta.github.io/SketchCanvas/media/EditButton.png}}
 +
 +Pressing the edit button brings you to the [[plugin:sketchcanvas:editor]] page.
 +
 +{{http://msakuta.github.io/SketchCanvas/media/EditButtonAfter.png}}
 +
 +==== 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.
 +
 +{{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]].
 ===== Configuration and Settings ===== ===== Configuration and Settings =====
  
plugin/sketchcanvas.1439300861.txt.gz · Last modified: 2015-08-11 15:47 (external edit)

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki