changeset 956:3b2205de6054

More work on the manual and CSS stylesheet.
author Matti Hamalainen <ccr@tnsp.org>
date Sun, 22 Mar 2009 07:24:07 +0000
parents 9413887348ab
children 2ba7e8c4f793
files docs/manual.css docs/manual.sgml
diffstat 2 files changed, 69 insertions(+), 17 deletions(-) [+]
line wrap: on
line diff
--- a/docs/manual.css	Sun Mar 22 06:47:28 2009 +0000
+++ b/docs/manual.css	Sun Mar 22 07:24:07 2009 +0000
@@ -14,12 +14,23 @@
         color: green;
 }
 
+a.ulink, a.ulink:visited {
+	text-decoration: underline;
+        color: red;
+}
+
 a:hover {
 	text-decoration: none;
 	background-color: #999;
 	color: white;
 }	
 
+a.ulink:hover {
+	text-decoration: none;
+	background-color: black;
+	color: yellow;
+}	
+
 
 h1, h2, h3 {
 	font-family: Arial, sans-serif;
--- a/docs/manual.sgml	Sun Mar 22 06:47:28 2009 +0000
+++ b/docs/manual.sgml	Sun Mar 22 07:24:07 2009 +0000
@@ -339,15 +339,12 @@
 <para>
 Throughout this manual, when GgrTF files are referenced in configuration
 examples etc., I have used "<emphasis>ggrtf/</emphasis>" -directory as path
-where the script files are located. You may need to substitute it
-with whatever you have installed your copy of GgrTF in.
+where the script files are located relative to your "home directory".
+You may need to substitute it with whatever you have installed your copy of GgrTF
+files in.
 </para>
 </note>
 
-<!-- ================================================ -->
-
-<section id="inst-getting"><title>Getting GgrTF</title>
-
 <para>
 There are basically two ways how to get GgrTF, release packages and
 the Subversion-repository. Releases are considered as stable snapshots,
@@ -355,10 +352,12 @@
 infrequently and at least in this phase we don't backport bugfixes to
 release versions.
 </para>
+
 <para>
 If you are unsure which version to choose, use the latest packaged release.
 </para>
 
+
 <section id="inst-releases"><title>Releases</title>
 <para>
 To get the latest stable version, head to the downloads-section of 
@@ -463,27 +462,27 @@
 and then issue "svn update" or the shorthand "svn up", as follows:
 </para>
 
-<userinput>cd ggrtf
-svn up</userinput>
+<screen>cd ggrtf
+svn up</screen>
 
 <para>
-If you have made changes to the files, Subversion tries to merge them
+If you have made changes to the files, Subversion will try to merge them
 with changes that have occured in the main repository. Sometimes the
-changes may be interfering with each other and this causes a merging
-error. You must fix these problems by hand, please refer to Subversion
+changes may be interfering with each other and cause a merging error.
+You must fix these problems by hand, please refer to Subversion
 documentation for more information and tips.
 </para>
 </section>
 
 </section>
 
-</section>
+</chapter>
 
 <!-- ================================================ -->
 
-<section id="inst-config"><title>Configuration</title>
+<chapter id="inst-config"><title>Configuration</title>
 <para>
-After getting GgrTF and installing/copying the files to appropriate
+After getting GgrTF and unpacking the files to appropriate
 directory folder, you need to setup your configuration for &tfurl;
 and possibly change some of your settings in &batmudurl;.
 </para>
@@ -497,7 +496,7 @@
 </para>
 
 
-<section id="inst-config-ggrtf"><title>TF configuration</title>
+<section id="inst-config-tf"><title>TF configuration</title>
 <para>
 First, we have to set up TF's configuration. Location of the file
 containing the startup script for TF depends on your operating
@@ -585,7 +584,12 @@
 </para>
 </section>
 
+<!--
+<section id="inst-config-ggrtf"><title>GgrTF configuration</title>
+<para>
+</para>
 </section>
+-->
 
 </chapter>
 
@@ -1198,7 +1202,7 @@
 <para>
 A simplified example configuration layout is presented below with only
 the state-saving related parts, please refer to
-<link linkend="inst-config-ggrtf">setup</link>-section of this
+<link linkend="inst-config-tf">setup</link>-section of this
 manual for a more detailed example. Pay close attention to the order
 how things are done, it is very important!
 </para>
@@ -2592,6 +2596,43 @@
 
 <!-- ================================================ -->
 
+<section id="usage-rpouch"><title>Reagent Pouch handler (gm-rpouch.tf)</title>
+<para>
+</para>
+
+<screen>
+</screen>
+
+<section>
+&sectmacros;
+</para>
+
+<table><title>Macro commands</title>
+ <tgroup cols="2" align="left">
+  <thead>
+   <row>
+    <entry>Command</entry>
+    <entry>Description</entry>
+   </row>
+  </thead>
+  <tbody>
+   <row>
+    <entry>/rpouch</entry>
+    <entry>Prints short help text.</entry>
+   </row>
+   <row>
+    <entry></entry>
+    <entry></entry>
+   </row>
+  </tbody>
+ </tgroup>
+</table>
+</section>
+
+</section>
+
+<!-- ================================================ -->
+
 <section id="usage-chann"><title>Guild: Channellers (gm-chann.tf)</title>
 <para>
 Game-elements specific to channellers guild are supported and
@@ -3084,7 +3125,7 @@
      <answer>
        <para>Automatic saving and loading is possible, please refer to
        <link linkend="usage-general-saves">state-saving</link>
-       and <link linkend="inst-config-ggrtf">setup</link> -sections of
+       and <link linkend="inst-config-tf">setup</link> -sections of
        this manual for more information. 
        </para>
      </answer>