~zge/kaomoji

ref: 5b5611cf3f3bdb2f91af7cd7e80a79a950f50b9f kaomoji/README.md -rw-r--r-- 1.7 KiB
5b5611cf — Philip K added link to public inbox 1 year, 3 months ago
                                                                                
08ee3984 Philip K
adc84a92 Philip K
08ee3984 Philip K
5b5611cf Philip K
08ee3984 Philip K
adc84a92 Philip K
08ee3984 Philip K
5b5611cf Philip K
08ee3984 Philip K
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
`insert-kaomoji.el`
==================

This packages collects and categorises eastern emoticons, called
"kaomojis", as to make it easy to insert them into text within Emacs.

All the kaomojis are stored in a secondary file, which should be placed
in the same directory as `insert-kaomoji.el`. The file format itself is
described below.

How to use
----------

Using [MELPA] and `use-package`, a minimal setup might look something like
this:

	(use-package insert-kaomoji
	  :bind ("C-x 8 k" . insert-kaomoji))

`KAOMOJIS` format
-----------------

The `KAOMOJIS` file has to use a slightly peculiar format, since usual
delimiters such as newlines, tabs, commas, etc. all can appear in a
emoticon. For that reason, the format instead uses special [ASCII
control characters][ascii delim], code 29 to 31.

These designate:

- **29 (group separator):** A category of emoticons ("Happy", "Sad",
  etc.)
- **30 (record separator):** Divide a category into labels (first part)
  and content (latter part). Only one record separator is allowed per
  group.
- **31 (unit separator):** Within the labels part, it separates
  synonyms, and in the content the single emoticons. Note that all
  synonyms are stripped of surrounding white spaces, _allowing_ new
  categories to start on new lines.

Bug reports and patches should be sent to my [public inbox].


Copying
-------

`bang.el` is distributed under the [CC0 1.0 Universal (CC0 1.0) Public
Domain Dedication][cc0] license.

[MELPA]: https://melpa.org/#/insert-kaomiji
[ascii delim]: https://en.wikipedia.org/wiki/Delimiter#ASCII_delimited_text
[public inbox]: https://lists.sr.ht/~zge/public-inbox
[cc0]: https://creativecommons.org/publicdomain/zero/1.0/deed