Index building

You will need to identify a directory or directories where you plan to store your SGML or XML source file, your index file (approximately 75% of the size of your bibliographic information), your "region" files, and other information such as data dictionaries. We recommend you use the following structure:

* Store SGML or XML files in <tt>/{DLXSROOT}/obj/{s}/{sample}/</tt> where <tt>{DLXSROOT}</tt> is the "tree" where you install all DLXS components, <tt>{s}</tt> is the first letter of the name of the collection you are indexing, and <tt>{sample}</tt> is the collection ID of the collection you are indexing. For example, if your collection id is "nyt" and your DLXSROOT is "/l1", you will place the <tt>nyt.xml</tt> file in <tt>/l1/obj/n/nyt/</tt>, e.g., <tt>/l1/obj/n/nyt/nyt.xml</tt>. See [[Directory Conventions: Complete Version]] for more information.

* Store index, region, data dictionary, and init files in <tt>/{DLXSROOT}/idx/{s}/{sample}/</tt>, e.g., <tt>/l1/idx/n/nyt/nyt.idx</tt>. See the [[Working with XPAT|XPAT documentation]] for more on these types of files.

The instructions below assume a sample collection named "nyt" and a DLXSROOT of "/l1", as in the above examples. Please replace these sample names with your local filenames.

# Ensure that your SGML is fully validated or normalized, or that your XML is fully validated. Use a validating parser such as [http://www.jclark.com/sp/nsgmls.htm nsgmls] to accomplish this. '''NB: Building indexes without validation can cause problems such as unreliable results; data that will not validate should not be put online.'''

# Ensure that your data is Unicode (see [../unicode.html DLXS Unicode Data Preparation and Online Presentation Issues]).

# Assuming XML, put the file <tt>nyt.xml</tt> in <tt>/l1/obj/n/nyt/nyt.xml</tt>

# Copy the sample data dictionary file ([[bib-sample.dd]]) to <tt>/l1/idx/n/nyt/</tt> and rename as <tt>nyt.dd</tt>

# Edit the <tt>nyt.dd</tt> file to replace

## <tt>b/bib-sample/bib-sample.xml</tt> with <tt>n/nyt/nyt.xml</tt>

## <tt>b/bib-sample/bib-sample.idx</tt> with <tt>n/nyt/nyt.idx</tt>

## and <tt>b/bib-sample/bib-sample.init</tt> with <tt>n/nyt/nyt.init</tt>

# Copy the sample init file ([[bib-sample.init]]) to <tt>/l1/idx/n/nyt/</tt> and rename as <tt>nyt.init</tt>

# Index your collection using the following command, replacing the value <tt>10m</tt> with an appropriate amount of memory. Please see [../../xpat/index.html XPAT documentation] to determine how much memory to allocate.<br /> <tt>xpatbldu -m 10m -D /l1/idx/n/nyt/nyt.dd</tt>

# Create your region files by issuing the following command.<br /> <tt>multirgn -f -D /l1/idx/n/nyt.dd -t bib-regions.tags</tt><br /> The file [[bib-regions.tags]] can be located in any directory and can be deleted after the regions have been indexed. DLPS keeps a copy of this file in <tt>/l1/obj/lib/sgml/bib-regions.tags</tt>

You have now built indexes and region files for your collection. You can test that things are properly indexed by issuing the command<br />

<tt>xpatu /l1/idx/n/nyt/nyt.dd</tt><br />

and then searching a common word (e.g., "<tt>the</tt>") and<br />

<tt>region A</tt>

Strategically, it is good to test this from a directory other than the one you indexed in, to ensure that relative or absolute paths are resolving appropriately.