Update of /cvsroot/mhonarc/mharc/doc
In directory subversions:/tmp/cvs-serv31805/doc
Modified Files:
docstyles.css index.html install.html
Log Message:
Documentation updates and improvements.
Index: docstyles.css
===================================================================
RCS file: /cvsroot/mhonarc/mharc/doc/docstyles.css,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** docstyles.css 24 Sep 2002 06:39:46 -0000 1.2
--- docstyles.css 28 Sep 2002 05:06:31 -0000 1.3
***************
*** 19,22 ****
--- 19,27 ----
padding: 0.25em;
}
+ tt.icode {
+ background: #EEEEEE;
+ padding-left: 0.25em;
+ padding-right: 0.25em;
+ }
pre.shell {
background: #337733;
Index: index.html
===================================================================
RCS file: /cvsroot/mhonarc/mharc/doc/index.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** index.html 24 Sep 2002 06:39:46 -0000 1.4
--- index.html 28 Sep 2002 05:06:31 -0000 1.5
***************
*** 23,27 ****
<li><small><a href="#">CVS Access</a></small>
</ul>
- <li><a href="#install">Installation</a>
<li><a href="#examples">Examples</a>
<li><a href="#support">Support</a>
--- 23,26 ----
***************
*** 43,58 ****
managing web-based searchable mail archives.
</p>
- <p>A typical problem with setting up web-based mail archives
- is trying dealing with the configuration of the various tools available
- to get the type of archives desired. For example, MHonArc does not
- provide any built-in searching, so you have to configure a search engine
- and then customize MHonArc's page layout to include the search form
- within archive pages.
- </p>
! <p>Generally, many administrators have created their own set of
scripts to integrate various tools together for their mail archives.
Well, mharc exists to eliminate this replication of work by providing
! a set of scripts that integrate popular free software tools inorder
to provide a robust and usable set of mail archives. mharc provides
the following: </p>
--- 42,56 ----
managing web-based searchable mail archives.
</p>
! <p>A typical problem with setting up web-based mail archives is
! trying dealing with the configuration of the various tools available.
! For example, MHonArc does not provide any built-in searching, so you
! have to configure a search engine and then customize MHonArc's page
! layout to include the search form within archive pages. </p>
!
! <p>Many administrators have created their own set of
scripts to integrate various tools together for their mail archives.
Well, mharc exists to eliminate this replication of work by providing
! a set of scripts that integrate popular free software tools in order
to provide a robust and usable set of mail archives. mharc provides
the following: </p>
***************
*** 61,65 ****
(via <a href="http://www.procmail.org/";>Procmail</a>).
</li>
! <li>Support for defining multiple archives for multiple lists.
</li>
<li>Archives broken up by monthly or yearly time periods.
--- 59,63 ----
(via <a href="http://www.procmail.org/";>Procmail</a>).
</li>
! <li>Support for multiple archives for multiple lists.
</li>
<li>Archives broken up by monthly or yearly time periods.
***************
*** 68,72 ****
(via <a href="http://www.namazu.org/";>Namazu</a>).
</li>
! <li>Raw mail archives to search as a backup for the HTML archives.
</li>
<li>Page layout customization
--- 66,70 ----
(via <a href="http://www.namazu.org/";>Namazu</a>).
</li>
! <li>Raw mail archives to serve as a backup for the HTML archives.
</li>
<li>Page layout customization
***************
*** 79,88 ****
</ul>
! <p>mharc configuration is driven by easily editable configuration
! files. There is no need to become a master with Procmail recipes or
learn how to invoke and configure a search engine. Also, the default
page layout of the mail archives provides nicely formatted pages
that improve readability; easy, but powerful, archive navigation;
! and a stylesheet to control the visual appearance of pages, eliminating the
need to define numerous MHonArc resources (but you still can if you
really want to). </p>
--- 77,86 ----
</ul>
! <p>mharc configuration is driven by simple editable configuration
! files. You do not need to become a master with Procmail recipes or
learn how to invoke and configure a search engine. Also, the default
page layout of the mail archives provides nicely formatted pages
that improve readability; easy, but powerful, archive navigation;
! and a stylesheet to control the visual appearance of pages; eliminating the
need to define numerous MHonArc resources (but you still can if you
really want to). </p>
***************
*** 118,129 ****
<!-- ====================================================================== -->
<hr>
- <h2><img src="images/mharc-icon.png" align="top" alt=""> <a name="install">Installation</a></h2>
-
- <p>See the <a href="install.html">Installation</a> document for
- installation instructions.
- </p>
-
- <!-- ====================================================================== -->
- <hr>
<h2><img src="images/mharc-icon.png" align="top" alt=""> <a name="examples">Examples</a></h2>
--- 116,119 ----
***************
*** 146,150 ****
</li>
<li><a href="tools.html"><strong>Tool Docs</strong></a>:
! Manpages of the various scripts and modules comprising mharc.
</li>
<li><a href="../VERSION"><strong>Version</strong></a>: mharc version
--- 136,140 ----
</li>
<li><a href="tools.html"><strong>Tool Docs</strong></a>:
! Manpages of the scripts and modules comprising mharc.
</li>
<li><a href="../VERSION"><strong>Version</strong></a>: mharc version
***************
*** 152,156 ****
</li>
<li><a href="../NEWS"><strong>Revision History</strong></a>: Change
! summaries of the various releases of mharc.
</li>
<li><a href="../TODO"><strong>TODO List</strong></a>: List of items that
--- 142,146 ----
</li>
<li><a href="../NEWS"><strong>Revision History</strong></a>: Change
! summaries and release notes of mharc releases.
</li>
<li><a href="../TODO"><strong>TODO List</strong></a>: List of items that
Index: install.html
===================================================================
RCS file: /cvsroot/mhonarc/mharc/doc/install.html,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** install.html 24 Sep 2002 06:39:46 -0000 1.4
--- install.html 28 Sep 2002 05:06:31 -0000 1.5
***************
*** 10,16 ****
<p>This document describes how to install and configure mharc on
! your system. It is <strong>highly recommended</strong> to read
! this document in its entirety before performing any of the
! installation steps. </p>
<p><strong>Table of Contents</strong></p>
--- 10,24 ----
<p>This document describes how to install and configure mharc on
[...1158 lines suppressed...]
<!-- ====================================================================== -->
***************
*** 810,816 ****
<ul>
! <li><p>The archive search forms rely on some Javascript to pass
around the Namazu index name since the <tt>namazu.cgi</tt> program currently
! does not provide any namazu template variable for the index name.
Hopefully, this limitation of namazu will be removed in the future
so the use of Javascript can be removed.
--- 831,837 ----
<ul>
! <li><p>The archive search forms rely on Javascript to pass
around the Namazu index name since the <tt>namazu.cgi</tt> program currently
! does not provide a namazu template variable for the index name.
Hopefully, this limitation of namazu will be removed in the future
so the use of Javascript can be removed.
---------------------------------------------------------------------
To sign-off this list, send email to majordomo(_at_)mhonarc(_dot_)org with the
message text UNSUBSCRIBE MHONARC-DEV