CTAN Comprehensive TeX Archive Network

Directory indexing/upmendex

README.md

upmendex — Multilingual index processor

2021.11.20 Ver1.00

TANAKA, Takuji <ttk(at)t-lab.opal.ne.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/output. Will work with up, XeLaTeX and lua.
  • Support Latin (including non-English), Greek, Cyrillic, 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.

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 GitHub2 than at CTAN5.
  • man/ :: manuals

Building upmendex

The source files are distributed at GitHub2 and work with Live svn r61096. Ref. Live and Subversion

Tested with ICU 68.2 .

Status

Stable version. No warranty.

Copyright

Lisence notice is written in COPYRIGHT. It is as same as the BSD 3-Clause License

Supported locales

In ICU collator, default "root" locale covers several lauguages: English, French, German, Italian, Portuguese and so on. Much of languages and collation options are supported by setting into "iculocale" in style files. Currently following locales are available:

Latin script

"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", "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), "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

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 (Publishing ) ASCII MEDIA WORKS (web site by DWANGO Co., Ltd.)
  2. Source/Document distribution of upmendex — multilingual index processor @ GitHub
  3. up, up ― unicode version of p, p
  4. International Components for Unicode (ICU)
  5. upmendex @ CTAN

Download the contents of this package in one zip archive (462.6k).

upmendex – Multilingual index processor

The package is a multilingual index processor with the following features:

  • Mostly compatible with makeindex and upper compatible with mendex.
  • Supports UTF-8 and works with up, XeLaTeX and Lua.
  • Supports Latin (including non-English), Greek, Cyrillic, Korean Hangul and Chinese Han (Hanzi ideographs) scripts, as well as Japanese Kana.
  • Supports Devanagari, Thai, Arabic and Hebrew scripts (experimental).
  • Supports four kinds of sort orders (Pinyin, Radical-Stroke, Stroke and Zhuyin) for Chinese Han scripts (Hanzi ideographs).
  • Applies International Components for Unicode (ICU) for sorting process.

Packageupmendex
Repositoryhttps://github.com/t-tk/upmendex-package
Version1.00 2021-11-20
Licenses3-clause BSD License
Copyright1995 ASCII Corporation
2009 ASCII MEDIA WORKS
2015–2021 TANAKA Takuji
MaintainerTakuji Tanaka
TopicsIndex
Multi-lingual
...
Guest Book Sitemap Contact Contact Author