plugin:sketchcanvas
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:sketchcanvas [2015-08-11 14:04] – [Examples/Usage] Add external image for example msakuta | plugin:sketchcanvas [2024-01-07 16:37] (current) – Add support for Hogfather, Igor and Jack Jackrum msakuta | ||
---|---|---|---|
Line 5: | Line 5: | ||
author | author | ||
email : | email : | ||
- | type : | + | type : |
- | lastupdate : 2015-08-11 | + | lastupdate : 2024-01-08 |
- | compatible : Hrun | + | compatible : Hrun, Detritus, Greebo, Hogfather, Igor, Jack Jackrum |
depends | depends | ||
conflicts | conflicts | ||
- | similar | + | similar |
- | tags : editing | + | tags : editing, vector, graphics, paintbrush, sketch, pencil |
- | downloadurl: | + | downloadurl: |
bugtracker : https:// | bugtracker : https:// | ||
- | sourcerepo : https:// | + | sourcerepo : https:// |
donationurl: | donationurl: | ||
- | screenshot_img : | + | screenshot_img : http:// |
---- | ---- | ||
Line 28: | Line 28: | ||
===== Installation ===== | ===== Installation ===== | ||
- | Install | + | Search and install |
+ | ==== Prerequisites ==== | ||
+ | |||
+ | * The client' | ||
+ | |||
+ | If any of your Wiki viewers may have legacy browsers that don't support HTML5, the sketches won't show up | ||
+ | for them. ((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' | ||
===== Examples/ | ===== Examples/ | ||
- | The sketches are included by < | + | The best way to see how it works is by seeing |
+ | < | ||
+ | |||
+ | The sketches are included by %%< | ||
- | When a < | + | When a %%< |
+ | and an edit button appears below it. | ||
A new button is added to the toolbar in edit page for inserting new sketch. | A new button is added to the toolbar in edit page for inserting new sketch. | ||
Line 68: | Line 79: | ||
{{http:// | {{http:// | ||
+ | ==== 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:// | ||
+ | |||
+ | ==== Edit page ==== | ||
+ | |||
+ | You don't have to remember the syntax to use the sketches. | ||
+ | There' | ||
+ | |||
+ | {{http:// | ||
+ | |||
+ | Pressing the edit button brings you to the [[plugin: | ||
+ | |||
+ | {{http:// | ||
+ | |||
+ | ==== 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:// | ||
+ | |||
+ | ==== Output to PDF ==== | ||
+ | |||
+ | This plugin works with [[plugin: | ||
+ | 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:// | ||
+ | to phplib/ subdirectory. | ||
===== Syntax ===== | ===== Syntax ===== | ||
The SketchCanvas syntax is a [[http:// | The SketchCanvas syntax is a [[http:// | ||
- | All text between < | + | All text between |
+ | Although you don't have to remember them, complete syntax definition can be found at [[plugin: | ||
===== Configuration and Settings ===== | ===== Configuration and Settings ===== | ||
Line 80: | Line 131: | ||
{{rss> | {{rss> | ||
+ | |||
+ | ====== Motivation ====== | ||
+ | |||
+ | If a Wiki system could be a knowledge base that everyone can participate, | ||
+ | it must be easy to edit **all** contents for everyone. | ||
+ | If it's not easy enough, people would end up using MS Word to write documents. | ||
+ | |||
+ | We already have [[plugin: | ||
+ | but it's still awkward to include sketches in a Wiki document. | ||
+ | |||
+ | If you had a decent vector graphics editor such as Adobe Illustrator, | ||
+ | even Excel, you can only attach rasterized image files and other people couldn' | ||
+ | edit them unless the source is separately provided. | ||
+ | So I decided to make a format for sketches that meets the requirements: | ||
+ | |||
+ | * It must be editable with the browser alone (if HTML5 compliant). | ||
+ | * The source is provided as well as the sketch image. | ||
+ | * The format is human readable and easy to compare with text diffs. | ||
+ | |||
+ | There is the [[plugin: | ||
+ | So why should I bother reinventing wheels? | ||
+ | |||
+ | SketchCanvas is very different from SVG in several aspects: | ||
+ | |||
+ | * It can be embedded in the Wiki text rather than external image file. | ||
+ | * It has very simple and easy-to-read syntax for humans. | ||
+ | * The syntax is easy to compare and produce meaningful diffs. | ||
+ | * Its functionality is intentionally very limited so that the source text cannot be too complex. | ||
+ | |||
+ | The main purpose is to sketch quick ideas/ | ||
+ | |||
+ | ====== Roadmap ====== | ||
+ | |||
+ | Blue areas are planned but not implemented yet. | ||
+ | BTW, this image itself was created with SketchCanvas. | ||
+ | |||
+ | {{http:// | ||
=== Known Bugs and Issues === | === Known Bugs and Issues === | ||
Line 88: | Line 176: | ||
* Increase number of types of primitives | * Increase number of types of primitives | ||
- | |||
- |
plugin/sketchcanvas.1439294668.txt.gz · Last modified: 2015-08-11 14:04 by msakuta