DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:sketchcanvas

This is an old revision of the document!


SketchCanvas Plugin

Compatible with DokuWiki

Hrun

plugin Write SketchCanvas documents embedded in DokuWiki.

Last updated on
2015-08-11
Repository
Source

This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.

Similar to edittable, svgedit

Tagged with editing

By Masahiro Sakuta

This plugin enables you to embed sketches in Wiki text. You can edit each sketch in an in-place GUI editor on the browser.

The sketches are formatted in a very simple format.

Installation

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.

Prerequisites

  • The client's browser must support HTML5 canvas.

If any of your Wiki viewers may have legacy browsers that don't support HTML5, the sketches won't show up for them. 1)

Examples/Usage

The sketches are included by <skcanvas> tag.

When a <skcanvas> tag is included, an edit button appears below it.

A new button is added to the toolbar in edit page for inserting new sketch. (if you have used EditTable plugin, it works much like the same way)

A simple sketch only consists of a meta element with sketch size information:

<skcanvas>
- type: meta
  size: [200, 100]
</skcanvas>

A bit more complex source:

<skcanvas>
- type: meta
  size: [200, 100]
- type: rect
  points: '35,25:137,64'
- type: text
  points: '45,45'
  text: Example
- type: arrow
  points: '14,46:30,46'
- type: arrow
  points: '142,46:174,46'
</skcanvas>

Results in a figure like this:

Syntax

The SketchCanvas syntax is a YAML document. All text between <skcanvas> and </skcanvas> must be valid YAML document.

Configuration and Settings

There is no configuration option yet.

Change Log

Roadmap

Blue areas are planned but not implemented yet. BTW, this image itself was created with SketchCanvas.

Known Bugs and Issues

  • Toolbars showing in edit page that aren't helpful

ToDo/Wish List

  • Increase number of types of primitives
1)
Probably we could make server-side renderer to show rasterized images for them, but it would require extensive development. Even if we have done it, old browsers still wouldn't be able to edit.
plugin/sketchcanvas.1439296874.txt.gz · Last modified: 2015-08-11 14:41 by msakuta