@sutton-signwriting/signmaker
Version:
Create and edit signs using Formal SignWriting in ASCII (FSW) or SignWriting in Unicode (SWU)
58 lines (57 loc) • 4.38 kB
HTML
<h1>@sutton-signwriting/signmaker</h1>
<p><a href="https://gitter.im/sutton-signwriting/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge"><img src="https://badges.gitter.im/Join%20Chat.svg" alt="Gitter"></a>
<a href="https://www.npmjs.com/package/@sutton-signwriting/signmaker"><img src="https://img.shields.io/npm/v/@sutton-signwriting/signmaker" alt="version"></a>
<a href="https://npm-stat.com/charts.html?package=@sutton-signwriting/signmaker&from=2021-12-16"><img src="https://img.shields.io/npm/dm/@sutton-signwriting/signmaker" alt="npm downloads"></a></p>
<hr>
<img alt="SignMaker Artwork" src="./signmaker.png">
<p>@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.</p>
<h2>v1.1.0</h2>
<blockquote>
<p>Author: <a href="https://SteveSlevinski.me" target="_parent">https://SteveSlevinski.me</a><br>
Channel: <a href="https://www.youtube.com/channel/UCXu4AXlG0rXFtk_5SzumDow" target="_parent">https://www.youtube.com/channel/UCXu4AXlG0rXFtk_5SzumDow</a><br>
Support: <a href="https://www.patreon.com/signwriting" target="_parent">https://www.patreon.com/signwriting</a></p>
</blockquote>
<hr>
<h2>Useful links</h2>
<ul>
<li>Public Editor: <a href="https://www.sutton-signwriting.io/signmaker/" target="_parent">https://www.sutton-signwriting.io/signmaker/</a></li>
<li>Public Demo: <a href="https://www.sutton-signwriting.io/signmaker/demo.html" target="_parent">https://www.sutton-signwriting.io/signmaker/demo.html</a></li>
<li>Source: <a href="https://github.com/sutton-signwriting/signmaker" target="_parent">https://github.com/sutton-signwriting/signmaker</a></li>
<li>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></li>
<li>Issue Tracker: <a href="https://github.com/sutton-signwriting/signmaker/issues" target="_parent">https://github.com/sutton-signwriting/signmaker/issues</a></li>
<li>Online Discussion: <a href="https://gitter.im/sutton-signwriting/community" target="_parent">https://gitter.im/sutton-signwriting/community</a></li>
</ul>
<hr>
<h2>URL Parameters</h2>
<p>SignMaker supports eight keys for URL query parameters</p>
<ul>
<li>ui - language code for user interface</li>
<li>alphabet - sign language code for symbol palette hierarchy</li>
<li>fsw - the sign value in Formal SignWriting in ASCII (FSW)</li>
<li>swu - the sign value in SignWriting in Unicode (SWU)</li>
<li>styling - the style string for image creation</li>
<li>grid - grid detail of 0,1,2</li>
<li>skin - alternate displays such as "inverse" and "colorful"</li>
<li>tab - the value for the tab to display</li>
</ul>
<p>Example: https://www.sutton-signwriting.io/signmaker/#?ui=ase&fsw=AS10011.1.019S2e704S2e748M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475&skin=colorful<br>
Top Half of Demo: https://www.sutton-signwriting.io/signmaker/demo.html</p>
<hr>
<h2>iFrame Messaging</h2>
<ol>
<li>embed SignMaker in an iFrame</li>
<li>send message to the iFrame using postMessage</li>
<li>receive message from the iFrame with an event listener for message</li>
</ol>
<p>Bottom Half of Demo: https://www.sutton-signwriting.io/signmaker/demo.html#?fsw=AS10011.1.019S2e704S2e748M525x535S2e748483x510S10011501x466S2e704510x500S10019476x475&skin=colorful</p>
<hr>
<h2>License</h2>
<p>MIT</p>
<hr>
<h2>SignWriting General Interest</h2>
<ul>
<li>SignWriting Website: https://signwriting.org/</li>
<li>Wikipedia page: https://en.wikipedia.org/wiki/SignWriting</li>
<li>Email Discussion: https://www.signwriting.org/forums/swlist/</li>
<li>Facebook Group: https://www.facebook.com/groups/SuttonSignWriting/</li>
</ul>