InTeX for LaTeX =============== About ----- InTeX is a package that adds functionality to LaTeX that eases typesetting and indexing of phrases, acronyms, and proper names in a consistent manner throughout documents of arbitrary length. `mkintex(1)` is a preprocessor that interprets index entries specified in `.itx` files and generates appropriate entries for LaTeX and `makeindex(1)`. Installation ------------ From source: $ git clone https://github.com/mtr/intex.git $ cd intex $ automake --add-missing $ autoconf $ configure $ make Create a deb package: $ make deb Install deb package: $ dpkg --install dist/intex_1.8.0-1_all.deb Or, you may also install directly from source: $ make install # might need a sudo For furhter information about how to install this package, please consult the file INSTALL, located in the top directory of the package. Usage ----- The `mkintex(1)` command takes the following options: --version show program's version number and exit -h, --help show this help message and exit -D, --debug whether or not to output debug information -V, --verbose whether or not to output verbose information -I, --only-build-index only build the internal model of the index -O , --ito-file= output the new internal InTeX information to (default: none) -o , --index-file= output the new indexing information to (default: none) -a , --acrodef-output= output acronym definitions to (default: none) -p , --persondef-output= output (person) name definitions to (default: none) Examples -------- Let us assume that you have already written a `latex(1)` document, named `.tex`, that uses the `InTeX(5)` package. Furthermore, we assume that you have defined a set of concepts, acronyms, and proper nouns for indexing in a file named `.itx`. Then, to run this program the standard way, first process the document with `latex(1)` (or `pdflatex(1)`) by issuing the command latex This will process the document once and generate both a DVI file (`.dvi`)---or a PDF file (`.pdf`)---and an auxiliary file (`.aux`). Next, run the `mkintex(1)` program mkintex --index-file=.rix that will use as input both `.aux` and `.itx` to produce two new output files. The first file is `.ito`, which will be used by `latex(1)` in following compilations of `.tex`, and `.rix`, which will be used by `makeindex(1)` to produce a proper index for LaTeX to typeset: makeindex -o intex.rid intex.rix After that, we have to run `latex(1)` again to generate a version of the document with the defined concepts, acronyms, and proper names properly typeset and indexed: latex Please note that in the examples above, `` is the name of the main LaTeX document, without the `.tex` ending. For more information and examples of how to use the `InTeX(5)` `LaTeX(1)` package, please see the file [latex/intex.pdf](https://github.com/mtr/intex/blob/master/latex/intex.pdf?raw=true). You may also consult the `mkintex(1)` man page. Licensing --------- For information about this package's license, please see the file COPYING in the top directory of the package. -- Martin Thorsen Ranang, 2013-03-12