mirrors/keyboard-layout-editor
1
Fork 0
mirror of https://github.com/ijprest/keyboard-layout-editor.git synced 2026-04-27 09:30:44 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated Serialized Data Format (markdown)

Ian Prest 2013-10-09 19:29:45 -07:00
parent 3ab22631eb
commit 2c3fc28ae7
1 changed files with 9 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
Serialized-Data-Format.md

@ -1,3 +1,12 @@
The serialized data format used by the editor is a "simplified" JSON derivitive:
* The format is standard JSON, but to reduce the visual clutter and make it more readable, we relax the typical JSON rules by allowing key names to be specified without quotation marks.
The data itself is an array of _rows_ of keycaps:
* The first row starts with coordinate _y = 0_.
* Each subsequent row increments the _y_ coordinate by 1.
* Note that for readability the 'Raw Data' tab in the editor omits the leading and trailing square brackets.
Each row is an array of keycaps:
* Each row starts with coordinate _x = 0_.
* A JSON string specifies the label(s) on the next keycap.
* After each keycap, the current _x_ coordinate is incremented by the previous cap's width.