[OpenSPARC-T2-DV] / tools / perl-5.8.0 / doc / MHonArc / resources / otherindexes.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
<html>
<head>
<title>MHonArc Resources: OTHERINDEXES</title>
</head>
<body>
<!--x-rc-nav-->
<table border=0><tr valign="top">
<td align="left" width="50%">[Prev:&nbsp;<a href="notetext.html">NOTETEXT</a>]</td><td><nobr>[<a href="../resources.html#otherindexes">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="outdir.html">OUTDIR</a>]</td></tr></table>
<!--/x-rc-nav-->
<hr>
<h1>OTHERINDEXES</h1>

<!-- *************************************************************** -->
<hr>
<h2>Syntax</h2>

<dl>

<dt><strong>Envariable</strong></dt>
<dd><p>
<code>M2H_OTHERINDEXES=</code><var>rcfile1</var><code>:</code><var
>rcfile2</var><code>:</code><var>...</var><code>:</code><var
>rcfileN</var>
</p>
</dd>

<dt><strong>Element</strong></dt>
<dd><p>
<code>&lt;OTHERINDEXES&gt;<br></code>
<var>rcfile1</var><code>:</code><var>rcfile2</var><code>:</code><var
>...</var><br>
<var>rcfilei</var><code>:</code><var>...</var><code>:</code><var
>rcfileN</var><br>
<code>&lt;/OTHERINDEXES&gt;<br></code>
</p>
</dd>

<dt><strong>Command-line Option</strong></dt>
<dd><p>
<code>-otherindexes </code><var>rcfile1</var><code>:</code><var
>rcfile2</var><code>:</code><var>...</var><code>:</code><var
>rcfileN</var>
</p>
</dd>

</dl>

<!-- *************************************************************** -->
<hr>
<h2>Description</h2>

<p>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
<code>OTHERINDEXES</code> element.
</p>

<table border=0 cellpadding=4>
<tr valign=top>
<td><strong>CAUTION</strong></td>
<td><P>It is very important that each resource file specified
defines the
<a href="main.html">MAIN</a> or
<a href="thread.html">THREAD</a> resource to determine the
type of index to create.  Also, the
<A HREF="idxfname.html">IDXFNAME</A> or 
<A HREF="tidxfname.html">TIDXFNAME</A> resource
(and <A HREF="idxprefix.html">IDXPREFIX</a> or
<A HREF="tidxprefix.html">TIDXPREFIX</a> resource if
<A HREF="multipg.html">MULTIPG</a> is active)
must be defined
to prevent overwriting of the default index pages.
</P>
</td>
</tr>
</table>

<table border=0 cellpadding=4>
<tr valign=top>
<td><strong><font color=red>WARNING</font></strong></td>
<td><p>Make sure OTHERINDEXES does <strong>NOT</strong>
list the file OTHERINDEXES
is defined in.  This will cause an infinite loop.
</td>
</tr>
</table>

<table border=0 cellpadding=4>
<tr valign=top>
<td><strong><font color=red>WARNING</font></strong></td>
<td><p>OTHERINDEXES resource file should <strong>NOT</strong>
define the OTHERINDEXES resource.  Unpredictable results may
occur, possibly infinite recursion.
</td>
</tr>
</table>

<P>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.  </P>

<p>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:
</p>
<ol>
<li>Current working directory.</li>
<li>Same directory that the first resource file was read as
specified by the RCFILE resource.</li>
<li>User's home directory.</li>
<li>Archive directory.</li>
<li>Perl's <tt>@INC</tt> library search page.</li>
</ol>

<table border=0 cellpadding=4>
<tr valign=top>
<td><strong>NOTE</strong></td>
<td><P>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.  </P>
</td>
</tr>
</table>

<table border=0 cellpadding=4>
<tr valign=top>
<td><strong>NOTE</strong></td>
<td><P>Archive navigational resources, like
<a href="listbegin.html">LISTBEGIN</a>,
<a href="thead.html">THEAD</a>,
<a href="toplinks.html">TOPLINKS</a>, and
<a href="botlinks.html">BOTLINKS</a>,
are <strong>NOT</strong> 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.
</td>
</tr>
</table>

<!-- *************************************************************** -->
<hr>
<h2>Default Setting</h2>

<p>Nil
</p>

<!-- *************************************************************** -->
<hr>
<h2>Resource Variables</h2>

<p>N/A
</p>

<!-- *************************************************************** -->
<hr>
<h2>Examples</h2>

<p>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:
</p>

<pre>
<b>&lt;OtherIndexes&gt;</b>
reversedateidx.mrc
subjectidx.mrc
<b>&lt;/OtherIndexes&gt;</b>
</pre>

<!-- *************************************************************** -->
<hr>
<h2>Version</h2>

<p>1.2
</p>

<!-- *************************************************************** -->
<hr>
<h2>See Also</h2>

<p>
<A HREF="idxfname.html">IDXFNAME</A>,
<A HREF="idxprefix.html">IDXPREFIX</a>,
<A HREF="multipg.html">MULTIPG</a>,
<A HREF="tidxfname.html">TIDXFNAME</A>,
<A HREF="tidxprefix.html">TIDXPREFIX</a>,
<a href="main.html">MAIN</a>,
<a href="thread.html">THREAD</a>
</p>

<!-- *************************************************************** -->
<hr>
<!--x-rc-nav-->
<table border=0><tr valign="top">
<td align="left" width="50%">[Prev:&nbsp;<a href="notetext.html">NOTETEXT</a>]</td><td><nobr>[<a href="../resources.html#otherindexes">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="outdir.html">OUTDIR</a>]</td></tr></table>
<!--/x-rc-nav-->
<hr>
<address>
$Date: 2002/07/27 05:13:11 $ <br>
<img align="top" src="../monicon.png" alt="">
<a href="http://www.mhonarc.org/"><strong>MHonArc</strong></a><br>
Copyright &#169; 1997-2001, <a href="http://www.earlhood.com/">Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org">mhonarc@mhonarc.org</a><br>
</address>

</body>
</html>
Commit	Line	Data
86530b38 AT	1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
	2	<html>
	3	<head>
	4	<title>MHonArc Resources: OTHERINDEXES</title>
	5	</head>
	6	<body>
	7	<!--x-rc-nav-->
	8	<table border=0><tr valign="top">
	9	<td align="left" width="50%">[Prev: <a href="notetext.html">NOTETEXT</a>]</td><td><nobr>[<a href="../resources.html#otherindexes">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="outdir.html">OUTDIR</a>]</td></tr></table>
	10	<!--/x-rc-nav-->
	11	<hr>
	12	<h1>OTHERINDEXES</h1>
	13
	14	<!-- *************************************************************** -->
	15	<hr>
	16	<h2>Syntax</h2>
	17
	18	<dl>
	19
	20	<dt><strong>Envariable</strong></dt>
	21	<dd><p>
	22	<code>M2H_OTHERINDEXES=</code><var>rcfile1</var><code>:</code><var
	23	>rcfile2</var><code>:</code><var>...</var><code>:</code><var
	24	>rcfileN</var>
	25	</p>
	26	</dd>
	27
	28	<dt><strong>Element</strong></dt>
	29	<dd><p>
	30	<code><OTHERINDEXES><br></code>
	31	<var>rcfile1</var><code>:</code><var>rcfile2</var><code>:</code><var
	32	>...</var><br>
	33	<var>rcfilei</var><code>:</code><var>...</var><code>:</code><var
	34	>rcfileN</var><br>
	35	<code></OTHERINDEXES><br></code>
	36	</p>
	37	</dd>
	38
	39	<dt><strong>Command-line Option</strong></dt>
	40	<dd><p>
	41	<code>-otherindexes </code><var>rcfile1</var><code>:</code><var
	42	>rcfile2</var><code>:</code><var>...</var><code>:</code><var
	43	>rcfileN</var>
	44	</p>
	45	</dd>
	46
	47	</dl>
	48
	49	<!-- *************************************************************** -->
	50	<hr>
	51	<h2>Description</h2>
	52
	53	<p>OTHERINDEXES defines a list of resource files that
	54	define other index pages
	55	to generate when creating, or updating, an archive. When setting
	56	the OTHERINDEXES resource, the filenames are separated by colons
	57	(or semicolons under MSDOS/Windows). Line-breaks can be used
	58	to separate filenames if setting OTHERINDEXES via the
	59	<code>OTHERINDEXES</code> element.
	60	</p>
	61
	62	<table border=0 cellpadding=4>
	63	<tr valign=top>
	64	<td><strong>CAUTION</strong></td>
65	<td><P>It is very important that each resource file specified
66	defines the
67	<a href="main.html">MAIN</a> or
68	<a href="thread.html">THREAD</a> resource to determine the
69	type of index to create. Also, the
70	<A HREF="idxfname.html">IDXFNAME</A> or
71	<A HREF="tidxfname.html">TIDXFNAME</A> resource
72	(and <A HREF="idxprefix.html">IDXPREFIX</a> or
73	<A HREF="tidxprefix.html">TIDXPREFIX</a> resource if
74	<A HREF="multipg.html">MULTIPG</a> is active)
75	must be defined
76	to prevent overwriting of the default index pages.
77	</P>
78	</td>
79	</tr>
80	</table>
81
82	<table border=0 cellpadding=4>
83	<tr valign=top>
84	<td><strong><font color=red>WARNING</font></strong></td>
85	<td><p>Make sure OTHERINDEXES does <strong>NOT</strong>
86	list the file OTHERINDEXES
87	is defined in. This will cause an infinite loop.
88	</td>
89	</tr>
90	</table>
91
92	<table border=0 cellpadding=4>
93	<tr valign=top>
94	<td><strong><font color=red>WARNING</font></strong></td>
95	<td><p>OTHERINDEXES resource file should <strong>NOT</strong>
96	define the OTHERINDEXES resource. Unpredictable results may
97	occur, possibly infinite recursion.
98	</td>
99	</tr>
100	</table>
101
102	<P>MHonArc will only store the name of the resource files
103	listed in the database. Therefore, for any subsequent updates of the
104	archive, the extra index resource files must exist inorder to generate
105	the extra index pages. </P>
106
107	<p>All filenames are treated relative to the current working
108	directory or the archive directory, except for absolute
109	pathnames. The following shows the search order MHonArc uses
110	to find resource files listed in OTHERINDEXES:
111	</p>
112	<ol>
113	<li>Current working directory.</li>
114	<li>Same directory that the first resource file was read as
115	specified by the RCFILE resource.</li>
116	<li>User's home directory.</li>
117	<li>Archive directory.</li>
118	<li>Perl's <tt>@INC</tt> library search page.</li>
119	</ol>
120
121	<table border=0 cellpadding=4>
122	<tr valign=top>
123	<td><strong>NOTE</strong></td>
124	<td><P>When creating resource files for extra indexes, make sure to
125	explicitly set all resources desired since some resource settings may
126	no longer be set to the defaults due to database settings or from
127	a previously read resource file. Ie. MHonArc does not reset
128	to the default settings before reading the other resource files. </P>
129	</td>
130	</tr>
131	</table>
132
133	<table border=0 cellpadding=4>
134	<tr valign=top>
135	<td><strong>NOTE</strong></td>
136	<td><P>Archive navigational resources, like
137	<a href="listbegin.html">LISTBEGIN</a>,
138	<a href="thead.html">THEAD</a>,
139	<a href="toplinks.html">TOPLINKS</a>, and
140	<a href="botlinks.html">BOTLINKS</a>,
141	are <strong>NOT</strong> automatically modified to include
142	navigational links related to the other indexes created (even
143	if using the default settings). Therefore, you will have
144	to explicily define these resources if you want navigational
145	links for the other indexes.
146	</td>
147	</tr>
148	</table>
149
150	<!-- *************************************************************** -->
151	<hr>
152	<h2>Default Setting</h2>
153
154	<p>Nil
155	</p>
156
157	<!-- *************************************************************** -->
158	<hr>
159	<h2>Resource Variables</h2>
160
161	<p>N/A
162	</p>
163
164	<!-- *************************************************************** -->
165	<hr>
166	<h2>Examples</h2>
167
168	<p>Since MHonArc only creates two indexes by default
169	(the main/date index and the thread index), you can use OTHERINDEXES
170	to define other index formats for navigating your archive. A
171	possible setting for OTHERINDEXES may look like this:
172	</p>
173
174	<pre>
175	<b><OtherIndexes></b>
176	reversedateidx.mrc
177	subjectidx.mrc
178	<b></OtherIndexes></b>
179	</pre>
180
181	<!-- *************************************************************** -->
182	<hr>
183	<h2>Version</h2>
184
185	<p>1.2
186	</p>
187
188	<!-- *************************************************************** -->
189	<hr>
190	<h2>See Also</h2>
191
192	<p>
193	<A HREF="idxfname.html">IDXFNAME</A>,
194	<A HREF="idxprefix.html">IDXPREFIX</a>,
195	<A HREF="multipg.html">MULTIPG</a>,
196	<A HREF="tidxfname.html">TIDXFNAME</A>,
197	<A HREF="tidxprefix.html">TIDXPREFIX</a>,
198	<a href="main.html">MAIN</a>,
199	<a href="thread.html">THREAD</a>
200	</p>
201
202	<!-- *************************************************************** -->
203	<hr>
204	<!--x-rc-nav-->
205	<table border=0><tr valign="top">
206	<td align="left" width="50%">[Prev: <a href="notetext.html">NOTETEXT</a>]</td><td><nobr>[<a href="../resources.html#otherindexes">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="outdir.html">OUTDIR</a>]</td></tr></table>
207	<!--/x-rc-nav-->
208	<hr>
209	<address>
210	$Date: 2002/07/27 05:13:11 $ <br>
211	<img align="top" src="../monicon.png" alt="">
212	<a href="http://www.mhonarc.org/"><strong>MHonArc</strong></a><br>
213	Copyright © 1997-2001, <a href="http://www.earlhood.com/">Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org">mhonarc@mhonarc.org</a><br>
214	</address>
215
216	</body>
217	</html>