summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/upmendex/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/upmendex/README.md')
-rw-r--r--Master/texmf-dist/doc/upmendex/README.md75
1 files changed, 51 insertions, 24 deletions
diff --git a/Master/texmf-dist/doc/upmendex/README.md b/Master/texmf-dist/doc/upmendex/README.md
index 4c55ed7a458..89d0c0e4dea 100644
--- a/Master/texmf-dist/doc/upmendex/README.md
+++ b/Master/texmf-dist/doc/upmendex/README.md
@@ -1,7 +1,7 @@
upmendex --- Multilingual index processor
==========================================
-2019.02.17 Ver0.52
+2021.11.20 Ver1.00
TANAKA, Takuji
<ttk(at)t-lab.opal.ne.jp>
@@ -17,8 +17,11 @@ upmendex is a multilingual index processor with following features:
support UTF-8 encoding for input/output.
Will work with upLaTeX, XeLaTeX and luaLaTeX.
* Support Latin (including non-English), Greek, Cyrillic,
- Korean Hangul and Han (Hanzi ideographs) scripts
+ Korean Hangul and Chinese Han (Hanzi ideographs) scripts
as well as Japanese Kana.
+ * Support Devanagari, Thai, Arabic and Hebrew scripts (experimental).
+ * Support four kinds of sort orders (Pinyin, Radical-Stroke,
+ Stroke and Zhuyin) for Chinese Han scripts (Hanzi ideographs).
* Apply International Components for Unicode (ICU)[4]
for sorting process.
@@ -27,43 +30,53 @@ upmendex is a multilingual index processor with following features:
* source/ :: sources
* doc/ :: documents
* doc/samples/ :: samples for test.
- More samples are distributed at Ref. [2].
+ * doc/samples/alphabet :: samples for languages and collation options.
+ * doc/samples/option :: samples for ICU attributes/rules options etc.
+ More samples are distributed at GitHub[2] than at CTAN[5].
* man/ :: manuals
### Building upmendex
-The source files are distributed at GitHub[2] and work with TeX Live svn r50040.
+The source files are distributed at GitHub[2] and work with TeX Live svn r61096.
Ref. [TeX Live and Subversion](http://www.tug.org/texlive/svn/)
-Tested with ICU 63.1 .
+Tested with ICU 68.2 .
### Status
-Beta version.
+Stable version.
No warranty.
### Copyright
Lisence notice is written in [COPYRIGHT](./COPYRIGHT).
It is as same as [the BSD 3-Clause License](https://opensource.org/licenses/BSD-3-Clause)
-### Supported locale
+### Supported locales
In ICU collator, default "root" locale covers several lauguages:
-English, French, Germany, Italian and so on.
-Follows are available for setting into "icu_locale".
+English, French, German, Italian, Portuguese and so on.
+Much of languages and collation options are supported by
+setting into "icu_locale" in style files.
+Currently following locales are available:
#### Latin script
- "az" (Azerbaijani), "ca" (Catalan), "cs", "cs@collation=search" (Czech),
- "da" (Danish), "de@collation=phonebook" (German), "eo" (Espelanto),
- "es", "es@collation=traditional", "es@collation=search" (Spanish),
- "fi" (Finnish), "gl" (Galician),
- "hr", "hr@collation=search" (Croatian), "hu" (Hungarian),
- "lt" (Lithuanian), "nb", "nn", "no" (Norwegian),
+ "az", "az@collation=search" (Azerbaijani), "ca@collation=search" (Catalan),
+ "cs", "cs@collation=search" (Czech), "da", "da@collation=search" (Danish),
+ "de@collation=phonebook", "de@collation=search", "de-AT@collation=phonebook" (German),
+ "eo" (Espelanto), "es", "es@collation=traditional", "es@collation=search" (Spanish),
+ "fi", "fi@collation=search", "fi@collation=traditional" (Finnish),
+ "fr-CA" (French), "gl", "gl@collation=search" (Galician),
+ "hr", "hr@collation=search" (Croatian), "hu" (Hungarian), "lt" (Lithuanian),
+ "nb", "nb@collation=search", "nn", "nn@collation=search", "no" (Norwegian),
"pl" (Polish), "ro" (Romanian), "sk", "sk@collation=search" (Slovak),
- "sl" (Slovenian), "sq" (Albanian),
- "sr-Latn", "sr-Latn@collation=search" (Serbian), "sv" (Swedish),
- "tr" (Turkish), "vi" (Vietnamese)
+ "sl" (Slovenian), "sq" (Albanian), "sr-Latn", "sr-Latn@collation=search" (Serbian),
+ "sv", "sv@collation=search", "sv@collation=standard" (Swedish),
+ "tr" (Turkish), "vi", "vi@collation=traditional" (Vietnamese)
+
+##### Supported by default "root" collator. Do not need to set locale
+ "ca" (Catalan), "de" (German), "en" (English), "fr" (French), "id" (Indonesian),
+ "it" (Italian), "jv" (Javanese), "ms" (Malay), "nl" (Dutch), "pt" (Portuguese)
#### Cyrillic script
- "be" (Belarusian), "bg" (Bulgarian), "ru" (Russian),
- "sr" (Serbian), "uk" (Ukraine)
+ "be" (Belarusian), "bg" (Bulgarian), "kk" (Kazakh), "ky" (Kyrgyz),
+ "mk" (Macedonian), "ru" (Russian), "sr" (Serbian), "uk" (Ukraine)
#### Greek script
"el" (Greek)
@@ -71,12 +84,26 @@ Follows are available for setting into "icu_locale".
#### CJK (Han script (Hanzi), Hangul, Kana)
"ja", "ja@collation=unihan" (Japanese),
"ko", "ko@collation=search", "ko@collation=unihan" (Korean),
- "zh", "zh@collation=unihan", "zh@collation=stroke", "zh@collation=zhuyin" (Chinese)
+ "zh" [Pinyin Sort Order], "zh@collation=unihan" [Radical-Stroke Sort Order],
+ "zh@collation=stroke" [Stroke Sort Order], "zh@collation=zhuyin" [Zhuyin Sort Order] (Chinese)
+
+#### Devanagari (experimental)
+ "hi" (Hindi), "mr" (Marathi), "ne" (Nepali)
+
+#### Thai script (experimental)
+ "th" (Thai)
+
+#### Arabic (experimental)
+ "ar", "ar@collation=compat" (Arabic), "fa" (Persian), "ps" (Pashto), "ur" (Urdu)
+
+#### Hebrew (experimental)
+ "he", "he@collation=search" (Hebrew), "yi" (Yiddish)
### References
-1. [ASCII Nihongo TeX (Publishing TeX)](http://ascii.asciimw.jp/pb/ptex/)
- ASCII MEDIA WORKS (dead link)
+1. [ASCII Nihongo TeX (Publishing TeX)](https://asciidwango.github.io/ptex/)
+ ASCII MEDIA WORKS (web site by DWANGO Co., Ltd.)
2. [Source/Document distribution of upmendex --- multilingual index processor @ GitHub](https://github.com/t-tk/upmendex-package)
3. [upTeX, upLaTeX ― unicode version of pTeX, pLaTeX](http://www.t-lab.opal.ne.jp/tex/uptex_en.html)
-4. [International Components for Unicode (ICU)](http://site.icu-project.org/)
+4. [International Components for Unicode (ICU)](https://icu.unicode.org/)
+5. [upmendex @ CTAN](https://ctan.org/pkg/upmendex/)