Skip to content

Commit af68d62

Browse files
committed
docs: how to use editor and contribute maps
1 parent 7c15f7e commit af68d62

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,42 @@
22

33
This is a global repository to hold community curated maps to convert from ASCII to Unicode.
44

5+
## How to use this
6+
7+
The maps inside [maps directory](https://github.com/libindic/unicode-conversion-maps/tree/main/maps) are used in various utilities like [Payyans](https://libindic.org/Payyans), [Freaknz](https://gitlab.com/kannanvm/freaknz-qt/), [Chekkans](http://asdofindia.github.io/chekkans-web/), etc. These maps are all community maintained. In the near future, this repository will be used to supply maps to all of these projects and more.
8+
9+
### Editor
10+
11+
If you like to edit maps, you can use the [editor](https://libindic.github.io/unicode-conversion-maps/editor/). In editor, you have to choose the font file and map file. Once loaded, these are opened in the tables at the bottom.
12+
13+
![](https://i.imgur.com/FUo37cL.png)
14+
15+
Each glyph and its mapping are loaded in the following format:
16+
17+
```
18+
--------------
19+
| A B |
20+
| C D |
21+
| E |
22+
-------------
23+
```
24+
25+
Explanation of these:
26+
27+
* A - the unicode decimal point.
28+
* B - extended ASCII character that forms the left hand side of the maps
29+
* C - the glyph in the font at that code point (if it exists)
30+
* D - The input box where the currently mapped character is loaded (should be same as C). If B and C are the same, this can be omitted.
31+
* E - The Unicode codepoint of D.
32+
33+
After changing the mapping (by editing D) for all glyphs, you can copy the mapping from the textarea in the top right of the page.
34+
35+
### Using map
36+
37+
You can contribute the map to the community by either editing an existing map or by [creating a new map ](https://github.com/libindic/unicode-conversion-maps/new/main/maps).
38+
39+
If you want to directly use these maps, you can paste them in [chekkans-web](http://asdofindia.github.io/chekkans-web/) at the bottom and use it directly.
40+
541
## History
642

743
* [Payyans](https://github.com/libindic/payyans) is the origin of a lot of map files.

0 commit comments

Comments
 (0)