mendex-doc from CTAN

git-svn-id: svn://tug.org/texlive/trunk@50268 c570f23f-e606-0410-a88d-b1316a301751

10 files changed, 166 insertions, 68 deletions

diff --git a/Master/texmf-dist/doc/support/mendex-doc/LICENSE b/Master/texmf-dist/doc/support/mendex-doc/LICENSE
new file mode 100644
index 00000000000..7392f6e8454
--- /dev/null
+++ b/Master/texmf-dist/doc/support/mendex-doc/LICENSE
@@ -0,0 +1,28 @@
+Copyright (C) 2010 ASCII MEDIA WORKS.
+Copyright (C) 2016-2019 Japanese TeX Development Community
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its contributors
+  may be used to endorse or promote products derived from this software
+  without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/Master/texmf-dist/doc/support/mendex-doc/README.md b/Master/texmf-dist/doc/support/mendex-doc/README.md
new file mode 100644
index 00000000000..d60c1120853
--- /dev/null
+++ b/Master/texmf-dist/doc/support/mendex-doc/README.md
@@ -0,0 +1,50 @@
+mendex  --- Index processor
+===========================
+
+The program `mendex` is a general purpose hierarchical index generator.
+It is almost compatible with `makeindex`, and additional features
+for Japanese (handling readings of kanji words etc.) are also available.
+
+### Features
+
+See manual [mendex.1](./mendex.1) in roff format.
+
+### History
+
+`mendex` is originally developed by ASCII Corporation and
+ASCII Media Works, Inc.
+
+The source codes are currently maintained in TeX Live and GitHub repositories.
+Following features are added by Japanese TeX Development Community:
+
+* option `-U`: Set input/output character encoding to UTF-8.
+* option `-I enc`: Set internal character encoding to `enc`.
+* option `--help`: Show summary of options.
+* option `--`: Arguments after `--` are not taken as options.
+
+
+About mendex-doc package
+------------------------
+
+The `mendex-doc` package provides documentation for `mendex`.
+Source code of the program is not included in it.
+
+### Repository
+
+The bundle is maintained on GitHub:
+https://github.com/texjporg/tex-jp-build  (sources), and
+https://github.com/texjporg/mendex-doc  (documents).
+
+If you have any issues, please let us know from the above page or
+by e-mail <issue@texjp.org>.
+
+### License
+
+The package may be distributed and/or modified under the terms of
+the 3-clause BSD license (see [LICENSE](./LICENSE)).
+
+### Release Date
+
+2019-03-03
+
+Japanese TeX Development Community
diff --git a/Master/texmf-dist/doc/support/mendex-doc/mendex.pdf b/Master/texmf-dist/doc/support/mendex-doc/mendex.pdf
new file mode 100644
index 00000000000..c38a4515e87
--- /dev/null
+++ b/Master/texmf-dist/doc/support/mendex-doc/mendex.pdf
diff --git a/Master/texmf-dist/doc/support/mendex/mendex.tex b/Master/texmf-dist/doc/support/mendex-doc/mendex.tex
index c64fe7040bc..c0ec752d8d0 100644
--- a/Master/texmf-dist/doc/support/mendex/mendex.tex
+++ b/Master/texmf-dist/doc/support/mendex-doc/mendex.tex
@@ -12,6 +12,8 @@
 \usepackage{enumitem}
 \usepackage{shortvrb}
 \usepackage{newverbs}
+\usepackage[dvipdfmx,colorlinks=false]{hyperref}
+\usepackage{pxjahyper}
 
 % リスト設定
 \setlist[description]{font=\normalfont, style=nextline}
@@ -47,6 +49,9 @@
 作成することができます．
 \end{abstract}
 
+\tableofcontents
+\clearpage
+
 \section{使用法}
 
 はじめに\SoftName{mendex}の使用法を示します．
@@ -65,7 +70,7 @@
 |[|\Meta{idx0} \Meta{idx1} \Meta{idx2} |...]|
 \end{syntax}
 
-\section{オプション}
+\subsection{オプション}
 
 \SoftName{mendex}で利用可能なオプションは以下の通りです．
 
@@ -108,7 +113,7 @@
 \FileExtension{ind}としたもの，入力ファイルが標準入力のみであれば標準出力に出力します．
 
 \item[|-t| \Meta{log}]
-ファイルをログファイルと見なします．指定がない場合は最初の入力ファイルの拡張子を
+ファイル\Meta{log}をログファイルと見なします．指定がない場合は最初の入力ファイルの拡張子を
 \FileExtension{ilg}としたもの，入力ファイルが標準入力のみであれば標準エラー出力のみに
 出力されます．
 
@@ -119,30 +124,31 @@
 指定の仕方も可能です．
 
 \item[|-E|]
-エンコーディングをEUC-JPに指定します．入力ファイル，出力ファイルともEUC-JPとして扱います．
+入出力文字エンコーディングをEUC-JPに指定します．入力ファイル，出力ファイルともEUC-JPとして扱います．
 
 \item[|-J|]
-エンコーディングをJIS (ISO-2022-JP)に指定します．入力ファイル，出力ファイルともJISとして扱います．
+入出力文字エンコーディングをJIS (ISO-2022-JP)に指定します．入力ファイル，出力ファイルともJISとして扱います．
 
 \item[|-S|]
-エンコーディングをShift\_JISに指定します．入力ファイル，出力ファイルともShift\_JISとして扱います．
+入出力文字エンコーディングをShift\_JISに指定します．入力ファイル，出力ファイルともShift\_JISとして扱います．
 
 \item[|-U|]
-エンコーディングをUTF-8に指定します．入力ファイル，出力ファイルともUTF-8として扱います．
+入出力文字エンコーディングをUTF-8に指定します．入力ファイル，出力ファイルともUTF-8として扱います．
 
 \item[|-I| \Meta{enc}]
-内部バッファのエンコーディングを\Meta{enc}に指定します．\Meta{enc}には |euc|（EUC-JP）
+内部バッファの文字エンコーディングを\Meta{enc}に指定します．\Meta{enc}には |euc|（EUC-JP）
 または |utf8|（UTF-8）が指定可能です．このオプションが指定されていない場合のデフォルト
-値は |euc| ですが，オプション |-U| が明示的に指定されている場合は |utf8| となります．
+値は |utf8| です\footnote{v2.6fまでは「デフォルト値が |euc| で，オプション |-U| が
+明示的に指定されている場合は |utf8| となる」という仕様でしたが，v3.0で変更しました．}．
 
 \item[|--help|]
-オプションの要約を表示します。
+オプションの要約を表示します．
 
 \item[|--|]
 以降はオプション文字列と解釈しません．
 \end{description}
 
-\section{スタイルファイル}
+\subsection{スタイルファイル}
 
 スタイルファイルは\SoftName{makeindex}のものと上位互換です．
 形式は ``\jMeta{スタイルパラメータ} \jMeta{引数}'' のリストで構成されます．
@@ -150,7 +156,7 @@
 
 以下にスタイルパラメータとそのデフォルト値の一覧を示します．
 
-\paragraph{入力ファイルスタイルパラメタ}
+\paragraph{入力ファイルスタイルパラメータ}
 
 \begin{description}[leftmargin=3.5cm]
 \item[|keyword|] \ParamString*|\\indexentry|
@@ -191,7 +197,7 @@
 一般的な文字に対するエスケープキャラクタ．
 \end{description}
 
-\paragraph{出力ファイルスタイルパラメタ}
+\paragraph{出力ファイルスタイルパラメータ}
 
 \begin{description}[leftmargin=3.5cm]
 \item[|preamble|] \ParamString*|\\begin{theindex}\n|
@@ -276,7 +282,8 @@
 |suffix_mp| より優先される．文字列が定義されている場合にのみ有効．
 
 \item[|suffix\string_mp|] \ParamString*||
-ページ番号が3ページ連続する場合に，|delim_r| と3ページ目の番号の代わりに付加する文字列．
+ページ番号が3ページまたはそれ以上連続する場合に，|delim_r| と末尾のページ番号の代わりに
+付加する文字列．
 文字列が定義されている場合にのみ有効．
 
 \item[|encap\string_prefix|] \ParamString*|\\|
@@ -310,7 +317,7 @@
 \item[|symbol\string_flag|] \ParamNum|1|
 数字・記号の頭文字の出力フラグ．|0|のとき出力しない（\SoftName{mendex}専用）．
 
-\item[|letter\string_heaad|] \ParamNum|1|
+\item[|letter\string_head|] \ParamNum|1|
 日本語の頭文字の出力のフラグ．|1|のときカタカナ，|2|のときひらがなで出力する
 （\SoftName{mendex}専用）．
 
@@ -323,10 +330,36 @@
 （\SoftName{mendex}専用）．
 \end{description}
 
+\subsection{参考：\SoftName{makeindex}との比較}
+\SoftName{mendex}は基本的に\SoftName{makeindex}と互換ですが，以下の点で異なります．
+
+\begin{itemize}
+\item \SoftName{makeindex}には索引項目の分類として「記号」，「アルファベット」の
+  他に，数字のみの項目として「数字」という分類がありますが，
+  \SoftName{mendex}では数字は「記号」に含まれます．
+  また，\SoftName{makeindex}に存在するスタイルパラメータのうち，
+  |numhead_positive|と|numhead_negative|は認識されません．
+
+\item 数字・記号→欧文→和文の順にこだわらない索引の作成が可能です
+  （|character_order|パラメータを追加）．他に\SoftName{mendex}で追加された
+  スタイルパラメータには，|symbol|，|symbol_flag|，|letter_head|，|priority|があります．
+
+\item \SoftName{makeindex}の項目の並び順は，頭文字は
+  「記号」「数字」「アルファベット」に分けて並べられますが，2文字目以降は単純に
+  ASCIIコード順となり，記号よりアルファベットが先になる場合もあります．
+  \SoftName{mendex}の英数字の並びは，2文字目以降も
+  「記号」「数字」「アルファベット」の分類が考慮されます．
+
+\item \SoftName{makeindex}には |-g| オプションでドイツ語辞書順
+  （記号→アルファベット小文字→アルファベット大文字→数字）で並べるようにできますが，
+  \SoftName{mendex}ではサポートしていません．代わりに，|-g| オプションは
+  日本語の頭文字の区切りを切り換えるオプションになっています．
+\end{itemize}
+
 \section{日本語の扱いについて}
 
 \SoftName{mendex}は日本語の索引をできるだけ楽に扱えるようになっています．
-\SoftName{makeindex}では日本語の索引が正しく辞書順にソートするためにはひらがなまたは
+\SoftName{makeindex}では日本語の索引が正しく辞書順にソートするためには，ひらがなまたは
 カタカナに揃え，拗音，撥音，濁点を除いた読みを付けなければなりませんでした
 （自動的に揃えるバージョンもある）． \SoftName{mendex}ではカナについてはすべて自動的に
 揃え，また漢字については辞書ファイルを設定することにより各索引語ごとに読みを付ける作業を
@@ -404,11 +437,17 @@ indファイル & index sort
 常に参照する辞書ファイル．
 \end{description}
 
-\section{詳細について}
-その他，詳細については\SoftName{makeindex}に準拠．
-
 \section{既知の問題}
 複数のページ記法を使用する場合，ページ順に索引リストファイル（\FileExtension{idx}）を
 与えないとページ番号を誤認することがあります．
 
+% また，\SoftName{makeindex}に比べると実行速度が遅くなっています．
+
+\section{バグ報告先・開発元}
+現在，\SoftName{mendex}は日本語\TeX 開発コミュニティによりメンテナンスされています．
+\begin{itemize}
+  \item \url{https://github.com/texjporg/tex-jp-build} （本体のソースコード）
+  \item \url{https://github.com/texjporg/mendex-doc} （この文書を含むドキュメント類）
+\end{itemize}
+
 \end{document}
diff --git a/Master/texmf-dist/doc/support/mendex/LICENSE b/Master/texmf-dist/doc/support/mendex/LICENSE
deleted file mode 100644
index 90f23f1633d..00000000000
--- a/Master/texmf-dist/doc/support/mendex/LICENSE
+++ /dev/null
@@ -1,26 +0,0 @@
-Copyright (C) 2010 ASCII MEDIA WORKS.
-Copyright (C) 2016 Japanese TeX Development Community
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-
-1. Redistributions of source code must retain the above copyright
-   notice, this list of conditions and the following disclaimer.
-2. Redistributions in binary form must reproduce the above copyright
-   notice, this list of conditions and the following disclaimer in the
-   documentation and/or other materials provided with the distribution.
-3. Neither the name of the author may be used to endorse or promote products
-   derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
-IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
-OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
-INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
-NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
-THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/Master/texmf-dist/doc/support/mendex/README.md b/Master/texmf-dist/doc/support/mendex/README.md
deleted file mode 100644
index c92e642beb6..00000000000
--- a/Master/texmf-dist/doc/support/mendex/README.md
+++ /dev/null
@@ -1,23 +0,0 @@
-# mendex-doc
-
-This package provides documentation for Mendex (Japanese index
-processor). Source code of the program is not included; it can
-be obtained from TeX Live subversion repository.
-
-## Repository
-
-The bundle is maintained on GitHub:
-https://github.com/texjporg/mendex-doc
-
-If you have issues, please let us know from the above page.
-
-## License
-
-The package may be distributed and/or modified under the terms of
-the 3-clause BSD license (see [LICENSE](./LICENSE)).
-
-## Release Date
-
-2016-12-19
-
-Japanese TeX Development Community
diff --git a/Master/texmf-dist/doc/support/mendex/mendex.pdf b/Master/texmf-dist/doc/support/mendex/mendex.pdf
deleted file mode 100644
index b8ac9659762..00000000000
--- a/Master/texmf-dist/doc/support/mendex/mendex.pdf
+++ /dev/null
diff --git a/Master/texmf-dist/source/latex/mendex-doc/Makefile b/Master/texmf-dist/source/latex/mendex-doc/Makefile
new file mode 100644
index 00000000000..205ea0ea323
--- /dev/null
+++ b/Master/texmf-dist/source/latex/mendex-doc/Makefile
@@ -0,0 +1,29 @@
+DOCTARGET = mendex
+PDFTARGET = $(addsuffix .pdf,$(DOCTARGET))
+DVITARGET = $(addsuffix .dvi,$(DOCTARGET))
+KANJI = -kanji=utf8
+FONTMAP = -f ipaex.map -f ptex-ipaex.map
+TEXMF = $(shell kpsewhich -var-value=TEXMFHOME)
+
+default: $(DVITARGET)
+all: $(PDFTARGET)
+
+.SUFFIXES: .tex .dvi .pdf
+.tex.dvi:
+	platex $(KANJI) $<
+	platex $(KANJI) $<
+	platex $(KANJI) $<
+	rm -f *.aux *.log *.toc
+.dvi.pdf:
+	dvipdfmx $(FONTMAP) $<
+
+.PHONY: install clean
+install:
+	mkdir -p ${TEXMF}/doc/support/mendex
+	cp ./LICENSE ${TEXMF}/doc/support/mendex/
+	cp ./README* ${TEXMF}/doc/support/mendex/
+	cp ./Makefile ${TEXMF}/doc/support/mendex/
+	cp ./*.tex ${TEXMF}/doc/support/mendex/
+	cp ./*.pdf ${TEXMF}/doc/support/mendex/
+clean:
+	rm -f $(DVITARGET) $(PDFTARGET)
diff --git a/Master/tlpkg/libexec/ctan2tds b/Master/tlpkg/libexec/ctan2tds
index 4c34c87b4a2..bceec56f506 100755
--- a/Master/tlpkg/libexec/ctan2tds
+++ b/Master/tlpkg/libexec/ctan2tds
@@ -2192,6 +2192,7 @@ $standardtex
  'mathdots',            'generic',
  'mcf2graph',		'metapost',
  'memdesign',           'fonts',
+ 'mendex-doc',		'support',
  'metafont-beginners',  'fonts',
  'metatex',             'plain',
  'metauml',             'metapost',
diff --git a/Master/tlpkg/tlpsrc/mendex-doc.tlpsrc b/Master/tlpkg/tlpsrc/mendex-doc.tlpsrc
index 9b84733b845..8b137891791 100644
--- a/Master/tlpkg/tlpsrc/mendex-doc.tlpsrc
+++ b/Master/tlpkg/tlpsrc/mendex-doc.tlpsrc
@@ -1 +1 @@
-docpattern d texmf-dist/doc/support/mendex
+