upmendex --- Multilingual index processor ========================================== 2021.08.08 Ver0.58 TANAKA, Takuji ### About upmendex upmendex is a multilingual index processor with following features: * Mostly compatible with makeindex and upper compatible with mendex, based on mendex version 2.6f by ASCII media works. * Unicode for internal process and support UTF-8 encoding for input/output. Will work with upLaTeX, XeLaTeX and luaLaTeX. * Support Latin (including non-English), Greek, Cyrillic, Korean Hangul and Chinese Han (Hanzi ideographs) scripts as well as Japanese Kana. * Support Devanagari and Thai 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. ### Contents * README.md :: This file * source/ :: sources * doc/ :: documents * doc/samples/ :: samples for test. * 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 r60191. Ref. [TeX Live and Subversion](http://www.tug.org/texlive/svn/) Tested with ICU 68.2 . ### Status Beta 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 locales In ICU collator, default "root" locale covers several lauguages: English, French, Germany, 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", "az@collation=search" (Azerbaijani), "ca", "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", "sv@collation=search", "sv@collation=standard" (Swedish), "tr" (Turkish), "vi", "vi@collation=traditional" (Vietnamese) #### Cyrillic script "be" (Belarusian), "bg" (Bulgarian), "kk" (Kazakh), "ky" (Kyrgyz), "mk" (Macedonian), "ru" (Russian), "sr" (Serbian), "uk" (Ukraine) #### Greek script "el" (Greek) #### CJK (Han script (Hanzi), Hangul, Kana) "ja", "ja@collation=unihan" (Japanese), "ko", "ko@collation=search", "ko@collation=unihan" (Korean), "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) ### References 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/) 5. [upmendex @ CTAN](https://ctan.org/pkg/upmendex/)