[Prev: NOTETEXT][Resources][TOC][Next: OUTDIR]

OTHERINDEXES

Syntax

Envariable

M2H_OTHERINDEXES=rcfile1:rcfile2:...:rcfileN

Element

<OTHERINDEXES>
 rcfile1:rcfile2:...
rcfilei:...:rcfileN
</OTHERINDEXES>

Command-line Option

-otherindexes rcfile1:rcfile2:...:rcfileN

Description

OTHERINDEXES defines a list of resource files that define other index pages to generate when creating, or updating, an archive. When setting the OTHERINDEXES resource, the filenames are separated by colons (or semicolons under MSDOS/Windows). Line-breaks can be used to separate filenames if setting OTHERINDEXES via the OTHERINDEXES element.

CAUTION

It is very important that each resource file specified defines the MAIN or THREAD resource to determine the type of index to create. Also, the IDXFNAME or TIDXFNAME resource (and IDXPREFIX or TIDXPREFIX resource if MULTIPG is active) must be defined to prevent overwriting of the default index pages.

WARNING

Make sure OTHERINDEXES does NOT list the file OTHERINDEXES is defined in. This will cause an infinite loop.

WARNING

OTHERINDEXES resource file should NOT define the OTHERINDEXES resource. Unpredictable results may occur, possibly infinite recursion.

MHonArc will only store the name of the resource files listed in the database. Therefore, for any subsequent updates of the archive, the extra index resource files must exist inorder to generate the extra index pages.

All filenames are treated relative to the current working directory or the archive directory, except for absolute pathnames. The following shows the search order MHonArc uses to find resource files listed in OTHERINDEXES:

  1. Current working directory.
  2. Same directory that the first resource file was read as specified by the RCFILE resource.
  3. User's home directory.
  4. Archive directory.
  5. Perl's @INC library search page.
NOTE

When creating resource files for extra indexes, make sure to explicitly set all resources desired since some resource settings may no longer be set to the defaults due to database settings or from a previously read resource file. Ie. MHonArc does not reset to the default settings before reading the other resource files.

NOTE

Archive navigational resources, like LISTBEGIN, THEAD, TOPLINKS, and BOTLINKS, are NOT automatically modified to include navigational links related to the other indexes created (even if using the default settings). Therefore, you will have to explicily define these resources if you want navigational links for the other indexes.

Default Setting

Nil

Resource Variables

N/A

Examples

Since MHonArc only creates two indexes by default (the main/date index and the thread index), you can use OTHERINDEXES to define other index formats for navigating your archive. A possible setting for OTHERINDEXES may look like this: 

<OtherIndexes>
reversedateidx.mrc
subjectidx.mrc
</OtherIndexes>

Version

1.2

See Also

IDXFNAME, IDXPREFIX, MULTIPG, TIDXFNAME, TIDXPREFIX, MAIN, THREAD

[Prev: NOTETEXT][Resources][TOC][Next: OUTDIR]
$Date: 2003/10/06 22:04:19 $
MHonArc
Copyright © 1997-2001, Earl Hood, mhonarc@mhonarc.org