Skip to content

Commit 3980ad3

Browse files
committed
readme updates
1 parent 706e606 commit 3980ad3

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,19 +47,28 @@ and then helpers:
4747
- Root key `etymology` and translation key `etymology` merged into single
4848
translatable field `etymlogy` under `translations`
4949
- Key `author_verbatim_source` renamed `author_source`
50-
- New key `glyph_ids` which refers to all glyphs in Linku that may represent
50+
- Key `coined_year` renamed `creation_date`, and can be accurate to the day if
51+
known
52+
53+
- New keys `image` and `svg` which link to an image of the word's primary sitelen pona
54+
- New key `glyph_ids` which refers to all glyphs above Sandbox that may represent
5155
this word
5256
- New key `primary_glyph_id` which refers to the glyph in Linku most used to write
5357
this word, such as `akesi-2` for `akesi`
58+
- New key `parent_id` which is the ID of a synonymous word, generally from the
59+
lesser to the more popular word; may optionally be used to merge or hide
60+
entries
5461

5562
- Referential fields such as `see_also` can no longer refer to sandbox data
5663

5764
### /v2/glyphs and /v2/sandbox/glyphs
5865

5966
- Key `word` refers to the latin script word this glyph writes
6067
- Key `word_id` refers to a corresponding word in Linku by its id, which is
61-
often the same as `word` anyway
68+
often (but not always) the same as `word`
6269
- Key `usage_category` functions as in `/v1/words` and `/v2/words`
70+
- Though there are a handful of overrides, from sandbox to obscure or vice
71+
versa, depending on the parent word
6372
- Key `primary` indicates whether a glyph is primarily used to write its word;
6473
must match that word's `primary_glyph_id` field
6574
- Key `deprecated` indicates whether a glyph is considered deprecated by its creator
@@ -74,7 +83,7 @@ and then helpers:
7483
data from Linku taken from `words/`, `luka_pona/`, `fonts/`, `languages/`, and `glyphs/` for `v2`.
7584
- `sandbox` is now nested as `sandbox/words` and `sandbox/glyphs`
7685
- `languages` is now split among all languages rather than having a single file,
77-
for parity with other types
86+
for parity with other types
7887

7988
### Types
8089

0 commit comments

Comments
 (0)