Update of /cvsroot/mhonarc/mhonarc/MHonArc/doc
In directory subversions:/tmp/cvs-serv17139
Modified Files:
commontasks.html install.html mhonarc.html
Log Message:
* Updated installation documentation to include information on how
to extract other distribution formats and to provide some more
explanatory material. Added note that installation program will
pre-check for required modules used by MHonArc.
+ Added a "Customized Page Layout" introduction under "Common Tasks".
Index: commontasks.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/commontasks.html,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -r1.13 -r1.14
*** commontasks.html 5 Mar 2002 08:16:32 -0000 1.13
--- commontasks.html 27 May 2002 20:07:10 -0000 1.14
***************
*** 36,39 ****
--- 36,40 ----
<li><small><a href="#manualrmm">Manual Removal</a></small>
</ul>
+ <li><a href="#layout">Customizing Page Layout</a>
</ul>
<!--X-TOC-End-->
***************
*** 232,235 ****
--- 233,308 ----
</p>
+
+ <!-- *************************************************************** -->
+ <hr>
+ <h2><a name="layout">Customizing Page Layout</a></h2>
+
+ <p>One of the most powerful features of MHonArc is the ability to
+ customize the layout of pages generated by MHonArc. Here, we give
+ a quick introduction on how customization can be done. For more
+ information, see the <cite><a href="layout.html">Page Layout</a></cite>
+ section.
+ </p>
+
+ <p>In this introduction, the task we will be performing is to
+ add a footer at the bottom of each page in the archive to
+ contain the following markup:
+ </p>
+ <pre>
+ <hr>
+ Please visit <a href="http://www.mhonarc.org">www.mhonarc.org</a>.
+ </pre>
+
+ <p>To modify page layout, we will need to create a
+ <a href="resources/rcfile.html">resource file</a> and give it a
+ filename "<tt>myresource.mrc</tt>". The name we give the file is
+ completely arbitrary. There is nothing special about the name
+ "<tt>myresource.mrc</tt>".
+ </p>
+
+ <p>Within <tt>myresource.mrc</tt>,
+ we add the following to tell MHonArc to include our footer at the
+ bottom of each page:
+ </p>
+ <blockquote><pre>
+ <!-- Define a custom resource variable representing our link. -->
+ <b><a href="resources/definevar.html"><DefineVar></a></b>
+ MY-FOOTER-LINK
+ <hr>
+ Please visit <a href="http://www.mhonarc.org">www.mhonarc.org</a>.
+ <b></DefineVar></b>
+
+ <!-- Modify appropriate resources to print our link at the bottom
+ of MHonArc generated pages. Notice how the custom resource
+ variable defined above can be used to include our link. -->
+
+ <!-- Main index pages -->
+ <b><a href="resources/idxpgend.html"><IdxPgEnd></a></b>
+ $MY-FOOTER-LINK$
+ </body>
+ </html>
+ <b></IdxPgEnd></b>
+
+ <!-- Thread index pages -->
+ <b><a href="resources/tidxpgend.html"><TIdxPgEnd></a></b>
+ $MY-FOOTER-LINK$
+ </body>
+ </html>
+ <b></TIdxPgEnd></b>
+
+ <!-- Message pages -->
+ <b><a href="resources/msgpgend.html"><MsgPgEnd></a></b>
+ $MY-FOOTER-LINK$
+ </body>
+ </html>
+ <b></MsgPgEnd></b>
+ </pre></blockquote>
+
+ <p>Now, when we invoke <tt>mhonarc</tt>, we tell it about our resource
+ file so our footer will show up:
+ </p>
+ <pre>
+ shell> <b>mhonarc <a href="resources/rcfile.html">-rcfile</a> myresource.mrc</b> ...
+ </pre>
<!-- *************************************************************** -->
Index: install.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/install.html,v
retrieving revision 1.16
retrieving revision 1.17
diff -C2 -r1.16 -r1.17
*** install.html 24 Dec 2001 14:38:07 -0000 1.16
--- install.html 27 May 2002 20:07:10 -0000 1.17
***************
*** 27,31 ****
<td><p>Make sure to read the
<a href="relnotes.html">release notes</a> before installing MHonArc,
! especially if you are upgrading from a previous release.
</p>
</td>
--- 27,34 ----
<td><p>Make sure to read the
<a href="relnotes.html">release notes</a> before installing MHonArc,
! especially if you are upgrading from a previous release. If you
! are reading the text version of this installation document, a text
! version of the release notes is contained in the file <tt>RELNOTES</tt>
! contained within the root of the MHonArc distribution.
</p>
</td>
***************
*** 69,81 ****
</li>
<li><p><b>Getopt::Long</b> and <b>Time::Local</b> modules are installed.
! These modules are part of the standard Perl distribution. The
! following command can be used to verify that the modules
! are installed on your system:
! </p>
! <pre>
! shell> <b>perl -MGetopt::Long -MTime::Local -e ';'</b>
! </pre>
! <p>If you get any error messages, you either have an incomplete
! installation of Perl, or Perl is misconfigured.
</p>
</li>
--- 72,76 ----
</li>
<li><p><b>Getopt::Long</b> and <b>Time::Local</b> modules are installed.
! These modules are part of the standard Perl distribution.
</p>
</li>
***************
*** 100,103 ****
--- 95,108 ----
</ul>
+ <table border=0 cellpadding=4>
+ <tr valign=top>
+ <td><strong>NOTE</strong></td>
+ <td><p>The MHonArc installation program will check that required modules
+ are available before installing MHonArc on your system.
+ </p>
+ </td>
+ </tr>
+ </table>
+
<!-- *************************************************************** -->
<hr>
***************
*** 115,122 ****
</p>
! <p>MHonArc is distributed in either a tar/gzip file or a zip file. The
! tar/gzip file will have a name like <tt>MHonArc<var>X.X.X</var>.tar.gz</tt>,
! and the zip file have a name like <tt>MHonArc<var>X.X.X</var>.zip</tt>;
! where <tt><var>X.X.X</var></tt> represents the version number.
</p>
<p>Alternate distribution formats for MHonArc may be available, like
--- 120,134 ----
</p>
! <p>MHonArc is distributed in the following formats:
! </p>
! <ul>
! <li><b>tar-bz2</b>: <tt>MHonArc<var>X.X.X</var>.tar.bz2</tt>
! </li>
! <li><b>tar-gzip</b>: <tt>MHonArc<var>X.X.X</var>.tar.gz</tt>
! </li>
! <li><b>zip</b>: <tt>MHonArc<var>X.X.X</var>.zip</tt>
! </li>
! </ul>
! <p>where <tt><var>X.X.X</var></tt> represents the version number.
</p>
<p>Alternate distribution formats for MHonArc may be available, like
***************
*** 130,151 ****
<p>After downloading MHonArc, it is best to move the file to a
! temporary location for extraction. To extract a tar/gzip distribution,
! use the following command:
! </p>
! <pre>
! shell> <b>gzip -dc MHonArc<var>X.X.X</var>.tar.gz | tar xvf -</b>
! </pre>
! <p>To extract the zip distribution, you can use a program like WinZip,
! or any other program that supports zip archives. When extracting, make
! sure to preserve the directory structure.
</p>
! <table border=0 cellpadding=4>
! <tr valign=top>
! <td><strong>NOTE</strong></td>
! <td><p>WinZip does support tar/gzip files.
! </p>
! </td>
! </tr>
! </table>
<p>After extraction, the subdirectory <tt>MHonArc<var>X.X.X</var></tt> will
have been created containing all the files comprising MHonArc.
--- 142,169 ----
<p>After downloading MHonArc, it is best to move the file to a
! temporary location for extraction. To extract the distribution
! under Unix-like systems, use one of the following commands based upon the
! distribution format you downloaded:
! </p>
! <dl>
! <dt><b>tar-bz2</b></dt>
! <dd><pre>
! shell> <b>bzip2 -dc MHonArc<var>X.X.X</var>.tar.bz2 | tar xvf -</b></pre>
! <dt><b>tar-gzip</b></dt>
! <dd><pre>
! shell> <b>gzip -dc MHonArc<var>X.X.X</var>.tar.gz | tar xvf -</b></pre>
! </dd>
! <dt><b>zip</b></dt>
! <dd><pre>
! shell> <b>unzip MHonArc<var>X.X.X</var>.zip</b></pre>
! </dd>
! </dl>
!
! <p>For Win32 systems, you can use a program like <em>WinZip</em> to
! extract the tar-gzip or zip formats. If using
! <em><a href="http://www.cygwin.com/";>Cygwin</a></em>, you can use
! the Unix-based extraction methods.
</p>
!
<p>After extraction, the subdirectory <tt>MHonArc<var>X.X.X</var></tt> will
have been created containing all the files comprising MHonArc.
***************
*** 154,159 ****
<tr valign=top>
<td><strong>IMPORTANT</strong></td>
! <td><p>Please read the file RELNOTES included in the MHonArc
! distribution before continuing for any news about compatibility
with previous versions and/or important usage information.
</p>
--- 172,177 ----
<tr valign=top>
<td><strong>IMPORTANT</strong></td>
! <td><p>Please read the <a href="relnotes.html">release notes</a>
! before continuing for any news about compatibility
with previous versions and/or important usage information.
</p>
***************
*** 210,213 ****
--- 228,232 ----
-manpath <path> : Directory path to manpages
-nobin : Do not install programs
+ -nodep : Skip module dependency check
-nodoc : Do not install documentation
-nolib : Do not install library files
***************
*** 237,241 ****
shell> <b>perl install.me -prefix $HOME</b>
</pre>
! <br>
<h3><a name="installmenotes"><tt>install.me</tt> Notes</a></h3>
<ul>
--- 256,260 ----
shell> <b>perl install.me -prefix $HOME</b>
</pre>
!
<h3><a name="installmenotes"><tt>install.me</tt> Notes</a></h3>
<ul>
***************
*** 305,309 ****
<td><strong>NOTE</strong></td>
<td><p><b><tt>install.me</tt></b> is actually called "behind the scenes"
! to install the files.
</p>
</td>
--- 324,328 ----
<td><strong>NOTE</strong></td>
<td><p><b><tt>install.me</tt></b> is actually called "behind the scenes"
! in batch mode to install the files.
</p>
</td>
***************
*** 342,345 ****
--- 361,366 ----
resource (<b><tt>.mrc</tt></b>) files.
</p>
+ <p>This method of associating the icon to MHonArc resource files
+ is known to work with Win9x systems.
</li>
</ul>
***************
*** 486,490 ****
<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.mhonarc.org/~ehood/";
>Earl Hood</a>, <a href="mailto:mhonarc(_at_)mhonarc(_dot_)org"
>mhonarc(_at_)mhonarc(_dot_)org</a><br>
--- 507,511 ----
<img align="top" src="monicon.png" alt="">
<a href="http://www.mhonarc.org/";><strong>MHonArc</strong></a><br>
! Copyright © 1997-2002, <a href="http://www.mhonarc.org/~ehood/";
>Earl Hood</a>, <a href="mailto:mhonarc(_at_)mhonarc(_dot_)org"
>mhonarc(_at_)mhonarc(_dot_)org</a><br>
Index: mhonarc.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/mhonarc.html,v
retrieving revision 1.19
retrieving revision 1.20
diff -C2 -r1.19 -r1.20
*** mhonarc.html 8 May 2002 01:37:35 -0000 1.19
--- mhonarc.html 27 May 2002 20:07:10 -0000 1.20
***************
*** 64,67 ****
--- 64,68 ----
<li><a name="chg-idx-order" href="commontasks.html#chg-idx-order">Changing Index Listing Order</a></li>
<li><a name="rmm" href="commontasks.html#rmm">Removing Messages</a></li>
+ <li><a name="layout" href="commontasks.html#layout">Customizing Page Layout</a></li>
</ul>
</ul>
---------------------------------------------------------------------
To sign-off this list, send email to majordomo(_at_)mhonarc(_dot_)org with the
message text UNSUBSCRIBE MHONARC-DEV