diff options
author | Takuji Tanaka <KXD02663@nifty.ne.jp> | 2016-06-25 06:05:34 +0000 |
---|---|---|
committer | Takuji Tanaka <KXD02663@nifty.ne.jp> | 2016-06-25 06:05:34 +0000 |
commit | ed2b54f5b66c81f8607ddb231b0e164e3b6cf235 (patch) | |
tree | 13cd66e4dae2de8096b5b8e473c98116bd2fc74e /Master/texmf-dist/doc/upmendex/README.md | |
parent | 01a28c54f13404396191b54b4b235e1e317e9385 (diff) |
upmendex 0.51, add README.md, least samples
git-svn-id: svn://tug.org/texlive/trunk@41536 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/upmendex/README.md')
-rw-r--r-- | Master/texmf-dist/doc/upmendex/README.md | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/upmendex/README.md b/Master/texmf-dist/doc/upmendex/README.md new file mode 100644 index 00000000000..3bedfef5737 --- /dev/null +++ b/Master/texmf-dist/doc/upmendex/README.md @@ -0,0 +1,79 @@ +upmendex --- Multilingual index processor +========================================== + +2016.06.19 Ver0.51 + +TANAKA, Takuji ttk(at)t-lab(dot)opal(dot)ne(dot)jp + + +### 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/outout. + Will work with upLaTeX, XeLaTeX and luaLaTeX. + * Support Latin (including non-English), Greek, Cyrillic, + Korean Hangul and Han (Hanzi ideographs) scripts + as well as Japanese Kana. + * Apply International Components for Unicode (ICU) + for sorting process. + +### Contents + * README.md :: This file + * source/ :: sources + * doc/ :: documents + * doc/samples/ :: samples for test. + More samples are distributed at Ref. [2]. + +### Building upmendex +The sources work with TeXLive svn r41496. +Ref. [TeXLive and Subversion](http://www.tug.org/texlive/svn/) + +Tested with ICU 57.1 . + +### Status +Beta version. +No warranty. + +### Copyright +Lisence notice is written in COPYRIGHT . +It is as same as [the BSD 3-Clause License](https://opensource.org/licenses/BSD-3-Clause) + +### Supported locale +In ICU collator, default "root" locale covers several lauguages: +English, French, Germany, Italian and so on. +Follows are available for setting into "icu_locale". + +#### 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), + "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) + +#### Cyrillic script + "be" (Belarusian), "bg" (Bulgarian), "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", "zh@collation=unihan", "zh@collation=stroke", "zh@collation=zhuyin" (Chinese) + +### References +1. [ASCII Nihongo TeX (Publishing TeX)](http://ascii.asciimw.jp/pb/ptex/) + ASCII MEDIA WORKS +2. [upTeX, upLaTeX ― unicode version of pTeX, pLaTeX](http://www.t-lab.opal.ne.jp/tex/uptex_en.html) +3. [International Components for Unicode (ICU)](http://site.icu-project.org/) + |