WebStyler: StylIndex: an index builder for WebStyler

There is a separate program called stylindex that you can use to build a keyword index of your the titles of your web pages. To run it, type this command:

    stylindex [option...] index-name [boiler-file]

• The option is one of:

  -D directory

  Specifies the index directory, where all files (other than .g files) associated with the index live.

  -x exclusion-file

  Specifies the name of a file of words not to be treated as keywords. The default is the file named exclusion in the index directory.

  -p

  Writes the output files as permuted (KWIC, keyword in context) indices, with all titles permuted so that the keywords are in alphabetical order and vertically aligned. The default is to build a book-style index, so that a title of the form "prefix keyword suffix" will be displayed as "keyword suffix, prefix".

  -r rotation-point

  For the -p option, this argument can be used to specify where the keywords' beginnings are aligned on the page. The rotation-point should be a number in the half-open interval [0.0,1.0), where 0.0 means place the keyword at the left edge, 0.4 means place it at a position that is 40% of the way from the left edge to the right, and so on.

• The index-name is required, and gives the short reference of a topic in your Plan file that will be used as the starting page of your index.
• The boiler-file, if given, is the name of a file in the index directory

You must have 27 lines in your Plan file: one for the index's starting page, and one for each letter of the alphabet. Here are some examples of what those lines might look like, if your index is at depth 2 in your Plan file:

** Index                         | index/index
*** Index: A                     | index/index_a
*** Index: B                     | index/index_b
      ...
*** Index: Z                     | index/index_z

The stylindex program requires that the short reference name of each letter's page be the same as that of the index's starting page, with an underbar (_) and the letter appended.

A special data file called keywords will be written into the index directory. This file is necessary for the operation of the index.cgi script, which supports searching for keywords using a form.

Last updated: 1996/10/02 00:11:02
URL: http://www.nmt.edu/tcc/projects/webstyler/stylindex.html