Indexmeister Man Page

INDEXMEISTER

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
DEPENDENCIES
SEE ALSO
AUTHOR


NAME

indexmeister − reads a LaTeX or other file and suggests terms for indexing.

SYNOPSIS

indexmeister filename.tex [ -dfx ]

DESCRIPTION

Indexmeister (Version 0.3) is designed to speed the process of indexing large documents such as dissertations and nonfiction books. It reads a file and outputs a list of suggested terms to be included in the index. This list is suitable for
semi-automatic indexing using indexmeister’s sister application imbrowse. the first pass in the indexing process.

If either
detex or pandoc is installed then indexmeister will be able to read LaTex and
plain text files. If pandoc is installed then it will also be able to read several additional formats including docx, html, and epub (see the pandoc man page for a complete list).

Indexmeister is written in Python and should run on any Unix-like environment, including Cygwin (although it has actually only been tested on Debian and Ubuntu Linux).

In the default mode indexmeister primarily looks for capitalized phrases, which captures all names of people, places, and
other proper nouns.

If the -d flag is given it will also suggest words that do not appear in the system dictionary (this requires a properly installed
aspell to work). This option is occaisionally useful to capture foreign language or scientific terms. If the -f flag is given it will attempt to detect important words
using word frequency analysis. This mode is still a ’work in progress’ but when it works it works
well.

Detex often leaves in ’junk’ text from the original
Tex code in its output, which can make its way into Indexmeister’s results. If the file
.indexmeister-exclude, containng a list of strings to filter out, is present in the user’s home folder
indexmeister will read it and use it to filter its input stream. This file should contain one string per line. Lines beginning with ’#’ are comments and will
be ignored.

OPTIONS

−d

Also suggest words that do not appear in the system dictionary (e.g. scientific terms or foreign words)

−f Also suggest words based on word frequency analysis (experimental)
−x Force the use of Detex as a back-end even if Pandoc is installed

DEPENDENCIES

Indexmeister requires that eithr pandoc or detex be installed on the path. Detex is available in most LaTex
distributions. If you are writing books in LaTex you most likely already have it installed. Aspell, which ships with most Linux and FreeBSD distributions, is required for the -d mode.

SEE ALSO

imbrowse(1), pandoc(1), detex(1)

AUTHOR

Kevin A. Straight <longhung@yahoo.com> <www.kevinastraight.com>