Imbrowse Man Page

IMBROWSE

NAME
SYNOPSIS
DESCRIPTION
SEE ALSO
AUTHOR


NAME

imbrowse − semi−automatic indexing utility for LaTex projects

SYNOPSIS

imbrowse [ filename ]

DESCRIPTION

Imbrowse (Version 0.3) is an application for systematic semi-automatic indexing of large LaTex documents, especially those which are broken into many different files. After loading a list of terms to be indexed in a text file it lets the user browse all occurrences of those terms in every .tex file in the current directory and insert Latex index tags.

Invocation
Their are two options for invoking imbrowse: 1) Invoking with no command line arguments starts with a simple menu offering the choice of using indexmeister to scan a LaTex file and suggest terms for indexing. If you choose the master top level file in your document then indexmeister will follow "include" statements and read all files in the document. 2) Invoking with the name of a file containing index terms (either produced manually or with indexmeister) as the first argument takes the user directly to browsing mode.

Browsing Mode
Imbrowse
works on one item at a time from the list of terms to be indexed. The following options are present on the main menu:

s – Show occurrences. Brings up a brief listing showing the first several occurrences of the term in context.

c – Change the entry to be used in the index for this term.

d – Delete this term from the list.

k – Skip to the next term on the list.

b – Back. Go back to a previous term on the list.

i – Begin indexing all occurences of this term. For each occurrence the surrounding lines original are given as well as the proposed changes with the index tag inserted. Press ’a’ to accept the changes, ’c’ to change the index entry text, or ’k’ to skip (not index) this occurrence of the term.

q – Quit the program but save changes made to the list of index terms. Terms which have already been indexed and terms which have been deleted will be removed from the list. This is the option to use if you need to leave and pick up later where you left off.

a – Abort the program. The list of terms will be unchanged but any index tags which have been inserted into .tex files will remain. However, the original files are always saved as file.tex.bu in the current directory.

Basic Instructions for Indexing Books in Latex
While imbrowse will work with a variety of LaTex packages and indexing back-ends, users will find it most useful when using the makeindex utility with the LaTex Memoir document class. This combination allows for multiple indexes, three sub-levels of index, and some control over index formatting. Please see the documentation for Memoir and makeindex for more complete details; the following instructions are only a limited quick-start guide:

1) Declare your document class as "memoir".

2) In the document preamble, place the tag "makeindex".

3) At the point where you want the index to print (generally the back of the book) place the tag "printindex".

4) When the book is complete, spellchecked, and at least 90% copy-edited run indexmeister on the top-level file to produce a list of index terms. Edit this file with a text editor to add any additional terms that you think should be included. Note: Letter case matters; if you want both capitalized and lowercase versions of a phrase to be indexed, they both need to be in the list.

5) Run imbrowse on the list of index terms to insert the tags. You can use the ’!’ excape character to enter sub-levels of indexing. For instance, the index entry "Roman Divorce Law" creates a single top level entry, but the index entry "Law!Roman!Divorce" creates a sub-sub-entry "Divorce" under the sub-entry "Roman" under the top-level index entry "Law".

6) If you have any "see also" entries, edit your top-level .Tex file and enter them manually. For instance, you might want to manually add "index{Family Law|see{Law!Roman!Divorce}}".

7) Run latex or pdflatex on your top-level file. A "raw" index file, ending in ".idx" will be created automatically.

8) Run the ".idx" file through makeindex to create a final index input file, ending in an ".ind" extension.

9) Run latex or pdflatex one last time to build the final book, with index.

SEE ALSO

indexmeister(1), makeindex(1), pdflatex(1)

AUTHOR

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