<!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML//EN">
<TITLE>MHonArc FAQ: Index Pages
</TITLE></HEAD>
<!--X-NavButtons-Start-->
[
<a href=
"archives.html">Prev
</a>][
<a href=
"msgpgs.html">Next
</a>][
<a href=
"faq.html">TOC
</a>][
<a href=
"http://www.mhonarc.org/">Home
</a>]
<!-- ===================================================================== -->
<H2><a name=
"indexpages">Index Pages
</a></H2>
<li><a href=
"#idxtypes">What are all the different index types?
</a></li>
<li><a href=
"#additional">Can I have additional indexes beyond the default main and thread index?
</a></li>
<li><a href=
"#multipage">Can I have multi-page indexes?
</a></li>
<li><a href=
"#authorsort">Can I sort messages by author?
</a></li>
<li><a href=
"#otherindexes">How does the OTHERINDEXES resource work?
</a></li>
<li><a href=
"#attachments">Can I include links to message attachments on index pages?
</a></li>
<!-- ??????????????????????????????????????????????????????????????? -->
<tr valign=top
><td><img src=
"monicon.png" align=
"bottom" alt=
""></td><td>
<h3><b><a name=
"idxtypes">What are all the different index types?
</a></b></h3>
<p>MHonArc catagorizes indexes into to types:
<b>main
</b> and
<b>thread
</b>.
<b>Main
</b> covers indexes
listing messages by the following criteria:
<p>When the documentation refers to
<b>main
</b> index,
it refers to the index listing messages by author, date, or
subject. Therefore, all resources. and resource variables, that
refer to the main index apply to either an author, date, or
subject index. The type of main index is controled by
the SORT, SUBSORT, AUTHSORT resources.
<p>By default, MHonArc creates a date index
Author index support is available only in v2.0 and later.
<!-- ??????????????????????????????????????????????????????????????? -->
<tr valign=top
><td><img src=
"monicon.png" align=
"bottom" alt=
""></td><td>
<h3><b><a name=
"additional">Can I have additional indexes beyond the default main and thread index?
</a></b></h3>
<P>Yes. In version
1.2 (or later), a resource was added called
<strong>OTHERINDEXES
</strong>. With this resource, you are able to
define an arbitrary number of indexes you desire. The additional
indexes may be in any format you desire and that is supported
by MHonArc. Refer to the documentation for the usage of
<strong>OTHERINDEXES
</strong> (also see
"<a href="#otherindexes
">How does the OTHERINDEXES resource work?</a>").
<dt><strong>NOTE
</strong></dt>
<dd><p>MHonArc will
<strong>NOT
</strong> automatically
create links to any indexes created via the OTHERINDEXES resource.
You will need to modify the relevant index and messages resources
to contain the additional links. See the LISTBEGIN and
<!-- ??????????????????????????????????????????????????????????????? -->
<tr valign=top
><td><img src=
"monicon.png" align=
"bottom" alt=
""></td><td>
<h3><b><a name=
"multipage">Can I have multi-page indexes?
</a></b></h3>
<p>Yes, in v2.0 or later. Setting the MULTIPG and IDXSIZE will cause
indexes to to be listed across multiple pages with IDXSIZE determine
the number of messages listed per page.
<!-- ??????????????????????????????????????????????????????????????? -->
<tr valign=top
><td><img src=
"monicon.png" align=
"bottom" alt=
""></td><td>
<h3><b><a name=
"authorsort">Can I sort messages by author?
</a></b></h3>
<P>Yes, with v2.0 and later.
<!-- ??????????????????????????????????????????????????????????????? -->
<tr valign=top
><td><img src=
"monicon.png" align=
"bottom" alt=
""></td><td>
<h3><b><a name=
"otherindexes">How does the OTHERINDEXES resource work?
</a></b></h3>
<p>I am going to describe a basic example on how OTHERINDEXES can be used.
<p>First, lets have the top resource file (call it
"top.mrc") that
defines the formatting of the default
2 indexes (a main and
<pre>*** snip
"top.mrc" ***
<p>I may have a bunch of layout stuff, but that is not important
<p>The above tells MHonArc to create a date and thread index.
I am explicit with the settings to avoid potential unknown settings
from a default resource file (ie. It is always good to be explicit,
especially when we get to otherindexes).
<p>Now, I would like to also create subject and author indexes.
In
"top.mrc" I would add the following:
<pre>*** snip
"top.mrc" ***
<p>The filenames listed are arbitrary, but it is useful if they
imply their purpose. Since absolute pathnames were not used,
the files will be looked for in the current working directory,
or in the archive directory. Since the current working directory
may not be appropriate, it is usually best to put the files in
<p>The following now shows the important settings for each file:
<pre>*** snip
"subject.mrc" ***
*** snip
"subject.mrc" ***
<pre>*** snip
"author.mrc" ***
*** snip
"author.mrc" ***
<p>Again, notice how I am being explicit. MHonArc does not reset
resources when reading the otherindexes resource files. with one
<em>exception
</em>: THREAD is shut-off. To avoid overriding the default
index files, I must explicitly redefine IDXFNAME (amd IDXPREFIX
if MULTIPG is active). If I want different layouts for my
other indexes, I must explicitly define those, or they will
use what was ever set in top.mrc (or the applicable default resource setting(s)
when no explicit setting provided).
<p><strong>NOTE
</strong>:
Otherindexes resource file only defines a *single* index type: main
or thread. If you specify the THREAD, a thread index will be
created and all MAIN related resources are ignored. I.e. THREAD
<p><strong>WARNING
</strong>:
Do
<b>NOT
</b> define OTHERINDEXES in your otherindexes resource files.
Also, make sure there is no self references. If you do not heed
these warnings, you will cause an infinite loop, and/or
<p>Make sure OTHERINDEXES resource files are present for all
updates to an archive. Mhonarc only stores settings for the
default indexes, so the resource files are needed each time
<p>What I left out in this example is the redefinition of the navigational
based resources. Since I am adding more indexes, I would have to
redefine resources like TOPLINK, BOTLINKS, LISTBEGIN, THEAD, etc, so
there will be links to the other indexes.
<!-- ??????????????????????????????????????????????????????????????? -->
<tr valign=top
><td><img src=
"monicon.png" align=
"bottom" alt=
""></td><td>
<h3><b><a name=
"attachments">Can I include links to message attachments on index pages?
</a></b></h3>
<p>Not directly, but a (dirty) work-around maybe possible.
mhexternal.pl filter to write to a file (name based off the message
number) with some HTML markup that creates the HTML attachment list
(mhexternal.pl knows about content-types and other stuff, so it can
make a useful list). Note, since mhexternal.pl works on a single part
at a time, it needs to create the list via append operations to the
file. The implementation is similiar to how mhexternal.pl supports
placing attachments into a subdirectory. Make sure that mhexternal.pl
returns the file as part of the return value so it is automatically
deleted if the message is removed from the archive.
<p>Then, you define the LITEMPLATE resource to use a server-side include
to include the file as part of the message listing. I did say
it was dirty, but it should work.
<!-- ===================================================================== -->
<!--X-NavButtons-Start-->
[
<a href=
"archives.html">Prev
</a>][
<a href=
"msgpgs.html">Next
</a>][
<a href=
"faq.html">TOC
</a>][
<a href=
"http://www.mhonarc.org/">Home
</a>]
$Date:
2001/
12/
24 14:
38:
39 $
<br><img align=
"top" src=
"monicon.png" alt=
"">
<a href=
"http://www.mhonarc.org/"
><strong>MHonArc
</strong></a><br>
Copyright
© 1997-
1999,
<a href=
"http://www.earlhood.com/">Earl Hood
</a>,
<a href=
"mailto:mhonarc@mhonarc.org"
>mhonarc@mhonarc.org
</a><br>
projects / OpenSPARC-T2-DV / blob