UNPKG

3.98 kBMarkdownView Raw
1# @sutton-signwriting/signmaker
2
3[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/sutton-signwriting/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
4[![version](https://img.shields.io/npm/v/@sutton-signwriting/signmaker)](https://www.npmjs.com/package/@sutton-signwriting/signmaker)
5[![npm downloads](https://img.shields.io/npm/dm/@sutton-signwriting/signmaker)](https://npm-stat.com/charts.html?package=@sutton-signwriting/signmaker&from=2021-12-16)
6- - -
7
8<img alt="SignMaker Artwork" src="./signmaker.png">
9
10@sutton-signwriting/signmaker is an online editor that can be <a href="https://www.sutton-signwriting.io/signmaker/" target="_parent">accessed directly</a>, <a href="https://www.sutton-signwriting.io/signmaker/demo.html" target="_parent">embedded in an iFrame</a>, and <a href="https://github.com/sutton-signwriting/signmaker/archive/refs/heads/main.zip" target="_parent">downloaded</a>. It uses both Formal SignWriting in ASCII (FSW) and SignWriting in Unicode (SWU) character sets, along with the associated style string. See <a href="https://tools.ietf.org/id/draft-slevinski-formal-signwriting-08.html" target="_parent">draft-slevinski-formal-signwriting</a> for detailed specification.
11
12## v1.1.0
13
14> Author: <a href="https://SteveSlevinski.me" target="_parent">https://SteveSlevinski.me</a>
15> Channel: <a href="https://www.youtube.com/channel/UCXu4AXlG0rXFtk_5SzumDow" target="_parent">https://www.youtube.com/channel/UCXu4AXlG0rXFtk_5SzumDow</a>
16> Support: <a href="https://www.patreon.com/signwriting" target="_parent">https://www.patreon.com/signwriting</a>
17
18---
19
20## Useful links
21
22- Public Editor: <a href="https://www.sutton-signwriting.io/signmaker/" target="_parent">https://www.sutton-signwriting.io/signmaker/</a>
23- Public Demo: <a href="https://www.sutton-signwriting.io/signmaker/demo.html" target="_parent">https://www.sutton-signwriting.io/signmaker/demo.html</a>
24- Source: <a href="https://github.com/sutton-signwriting/signmaker" target="_parent">https://github.com/sutton-signwriting/signmaker</a>
25- Download: <a href="https://github.com/sutton-signwriting/signmaker/archive/refs/heads/main.zip" target="_parent">https://github.com/sutton-signwriting/signmaker/archive/refs/heads/main.zip</a>
26- Issue Tracker: <a href="https://github.com/sutton-signwriting/signmaker/issues" target="_parent">https://github.com/sutton-signwriting/signmaker/issues</a>
27- Online Discussion: <a href="https://gitter.im/sutton-signwriting/community" target="_parent">https://gitter.im/sutton-signwriting/community</a>
28
29---
30
31## URL Parameters
32SignMaker supports eight keys for URL query parameters
33
34* ui - language code for user interface
35* alphabet - sign language code for symbol palette hierarchy
36* fsw - the sign value in Formal SignWriting in ASCII (FSW)
37* swu - the sign value in SignWriting in Unicode (SWU)
38* styling - the style string for image creation
39* grid - grid detail of 0,1,2
40* skin - alternate displays such as "inverse" and "colorful"
41* tab - the value for the tab to display
42
43Example: https://www.sutton-signwriting.io/signmaker/#?ui=ase&fsw=AS10011.1.019S2e704S2e748M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475&skin=colorful
44Top Half of Demo: https://www.sutton-signwriting.io/signmaker/demo.html
45
46---
47
48## iFrame Messaging
491) embed SignMaker in an iFrame
502) send message to the iFrame using postMessage
513) receive message from the iFrame with an event listener for message
52
53Bottom Half of Demo: https://www.sutton-signwriting.io/signmaker/demo.html#?fsw=AS10011.1.019S2e704S2e748M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475&skin=colorful
54
55- - -
56
57## License
58MIT
59
60- - -
61
62## SignWriting General Interest
63- SignWriting Website: https://signwriting.org/
64- Wikipedia page: https://en.wikipedia.org/wiki/SignWriting
65- Email Discussion: https://www.signwriting.org/forums/swlist/
66- Facebook Group: https://www.facebook.com/groups/SuttonSignWriting/