Browse Source

Add documentation for double cap conf; update TODO.

scossu 1 year ago
parent
commit
d57108d30d
2 changed files with 31 additions and 8 deletions
  1. 9 8
      TODO.md
  2. 22 0
      doc/config.md

+ 9 - 8
TODO.md

@@ -5,10 +5,11 @@ discussion, etc.); *X* = not implementing.
 
 - *D* Basic table loading & parsing
 - *D* Table inheritance
-- *W* Multiple recursive inheritance
+- *D* Multiple recursive inheritance
   - *D* Inherit map
   - *D* Inherit ignore
-  - *B* Inherit hooks
+  - *D* Inherit double cap configuration
+  - *X* Inherit hooks
 - *D* Ignore list (R2S)
 - *D* Basic transliteration in both directions
 - *D* Basic REST API
@@ -18,13 +19,13 @@ discussion, etc.); *X* = not implementing.
 - *D* Word boundaries
   - *D* Define word boundary characters per config
   - *D* Mark end-of-word and beginning-of-word characters
-- *B* Optimize token lookup
+- *D* Optimize token lookup
   - *D* Break loop early based on alphabetical order
-  - *B* Ignore word break characters
-  - *W* Capitalization
-    - *P* Separate capitalization function
-    - *B* Capitalize ligated letters (e.g. Cyrillic T͡͡S)
-    - *D* Option for capitalizing first word, all words, none, unchanged
+  - *X* Ignore word break characters
+- *D* Capitalization
+  - *X* Separate capitalization function
+  - *D* Capitalize ligated letters (e.g. Cyrillic T͡͡S)
+  - *D* Option for capitalizing first word, all words, unchanged
 - *D* API documentation
 - *D* Config file documentation
 - *D* Hooks documentation

+ 22 - 0
doc/config.md

@@ -218,6 +218,28 @@ an error if a S2R transliteration is attempted on this language.
 This section may have the `hooks` and `map` sections, that behave exactly as
 described for `roman_to_script`. The `ignore` section is… ignored.
 
+#### `script_to_roman.double_cap`
+
+Type: list
+
+This is only a valid subsection of S2R. It is inherited from a parent and adds
+items to it.
+
+Each item in the list indicates a group of letters that, when encountered at
+the beginning of a word and slated for capitalization, are capitalized
+together, rather than only the first letter. This is the case in several
+ligated letter groups.
+
+Each rule must indicate the letters together as a group, romanized, and all
+lowercase. E.g. to capitalize "z︠h︡", that string must be entered verbatim. In
+that case, it is capitalized as "Z︠H︡", otherwise as "Z︠h︡".
+
+#### `script_to_roman.no_double_cap`
+
+Type: list
+
+This is only a valid subsection of S2R. It removes double capitalization rules
+from the inherited list.
 
 ##  Index file