Menu
CTAN
Comprehensive TeX Archive Network
Cover Upload Browse Search

Direc­tory tex-archive/support/intex

InTeX for LaTeX

About

InTeX is a pack­age that adds func­tion­al­ity to LaTeX that eases type­set­ting and in­dex­ing of phrases, acronyms, and proper names in a con­sis­tent man­ner through­out doc­u­ments of ar­bi­trary length.

mkintex(1) is a pre­pro­ces­sor that in­ter­prets in­dex en­tries spec­i­fied in .itx files and gen­er­ates ap­pro­pri­ate en­tries for LaTeX and makeindex(1).

In­stal­la­tion

From source:

$ git clone https://github.com/mtr/intex.git
$ cd intex
$ automake --add-missing
$ autoconf
$ configure
$ make

Create a deb pack­age:

$ make deb

In­stall deb pack­age:

$ dpkg --install dist/intex_1.8.0-1_all.deb

Or, you may also in­stall di­rectly from source:

$ make install  # might need a sudo

For furhter in­for­ma­tion about how to in­stall this pack­age, please con­sult the file INSTALL, lo­cated in the top di­rec­tory of the pack­age.

Usage

The mkintex(1) com­mand takes the fol­low­ing op­tions:

   --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 <file>, --ito-file=<file>
          output  the  new  internal InTeX information to <file> (default:
          none)
   -o <file>, --index-file=<file>
          output the new indexing information to <file> (default: none)
   -a <file>, --acrodef-output=<file>
          output acronym definitions to <file> (default: none)
   -p <file>, --persondef-output=<file>
          output (person) name definitions to <file> (default: none)

Ex­am­ples

Let us as­sume that you have al­ready writ­ten a latex(1) doc­u­ment, named <document_name>.tex, that uses the InTeX(5) pack­age. Fur­ther­more, we as­sume that you have de­fined a set of con­cepts, acronyms, and proper nouns for in­dex­ing in a file named <document_name>.itx. Then, to run this pro­gram the stan­dard way, first pro­cess the doc­u­ment with latex(1) (or pdflatex(1)) by is­su­ing the com­mand

latex <document_name>

This will pro­cess the doc­u­ment once and gen­er­ate both a DVI file (<document_name>.dvi)—or a PDF file (<document_name>.pdf)—and an aux­il­iary file (<document_name>.aux).

Next, run the mkintex(1) pro­gram

mkintex <document_name> --index-file=<document_name>.rix

that will use as in­put both <document_name>.aux and <document_name>.itx to pro­duce two new out­put files. The first file is <document_name>.ito, which will be used by latex(1) in fol­low­ing com­pi­la­tions of <document_name>.tex, and <document_name>.rix, which will be used by makeindex(1) to pro­duce a proper in­dex for LaTeX to type­set:

makeindex -o intex.rid intex.rix

After that, we have to run latex(1) again to gen­er­ate a ver­sion of the doc­u­ment with the de­fined con­cepts, acronyms, and proper names prop­erly type­set and in­dexed:

latex <document_name>

Please note that in the ex­am­ples above, <document_name> is the name of the main LaTeX doc­u­ment, with­out the .tex end­ing.

For more in­for­ma­tion and ex­am­ples of how to use the InTeX(5) LaTeX(1) pack­age, please see the file la­tex/in­tex.pdf.

You may also con­sult the mkintex(1) man page.

Li­cens­ing

For in­for­ma­tion about this pack­age's li­cense, please see the file COPYING in the top di­rec­tory of the pack­age.

– Martin Thorsen Ranang, 2013-03-12

Direc­to­ries

Name Notes
bin
dist
doc
latex
lib
src

Files

Name Size Date Notes
AUTHORS 59 2013-03-12 09:49
COPYING 35147 2013-03-12 09:49
ChangeLog 16316 2013-03-12 10:20
INSTALL 9416 2013-03-12 09:49
MANIFEST 424 2013-03-12 12:00
MANIFEST.in 187 2013-03-12 09:49
Makefile 23978 2013-03-12 12:00
Makefile.am 1231 2013-03-12 09:49
Makefile.in 23613 2013-03-12 11:59
NEWS 0 2013-03-12 09:49
3691 2013-03-12 11:01 ==> /sup­port/in­tex/README.md
README.md 3691 2013-03-12 11:01
RELEASE 2 2013-03-12 10:22
TODO 2048 2013-03-12 09:49
aclocal.m4 30879 2013-03-12 09:49
config.log 6633 2013-03-12 12:00
config.status 26469 2013-03-12 12:00
configure 107527 2013-03-12 10:22
configure.ac 450 2013-03-12 09:49
install_latest_release.sh 162 2013-03-12 09:49
pack_next_release.sh 131 2013-03-12 09:49
release.sh 132 2013-03-12 09:49
rewritten.itx 2873 2013-03-12 09:49
setup.cfg 235 2013-03-12 12:00
setup.cfg.in 233 2013-03-12 09:49
setup.py 2186 2013-03-12 12:00
setup.py.in 2228 2013-03-12 09:49
template.itx 230 2013-03-12 09:49
test.itx 6107 2013-03-12 09:49

Down­load the con­tents of this pack­age in one zip archive (3.7M).

in­tex – Sup­port type­set­ting and in­dex­ing words and phrases

The pack­age adds func­tion­al­ity to LaTeX to ease type­set­ting and in­dex­ing of phrases, acronyms, and proper names in a con­sis­tent man­ner through­out doc­u­ments of ar­bi­trary length.

The pack­age pro­vides a pro­ces­sor mk­in­tex, that pro­cesses an in­ter­me­di­ate .itx file, gen­er­at­ing ap­pro­pri­ate en­tries for both LaTeX and makein­dex.

Pack­age De­tailsin­tex
Ver­sion1.8.0
Li­censeGNU Gen­eral Public Li­cense, ver­sion 3
Copy­right2007 Martin Thorsen Ranang
Main­tainerMartin Thorsen Ranange
Topics pro­cess and/or gen­er­ate in­dex ma­te­rial
Guest Book Sitemap Contact