changeset 254:cef90429b16a

Cleanups.
author Matti Hamalainen <ccr@tnsp.org>
date Sat, 11 Feb 2006 02:10:46 +0000
parents 538e785fde00
children 1cd8c5caa457
files docs/manual.sgml
diffstat 1 files changed, 69 insertions(+), 47 deletions(-) [+]
line wrap: on
line diff
--- a/docs/manual.sgml	Sat Feb 11 01:12:44 2006 +0000
+++ b/docs/manual.sgml	Sat Feb 11 02:10:46 2006 +0000
@@ -26,7 +26,7 @@
 <!ENTITY validonoff "<emphasis>on</emphasis>, <emphasis>off</emphasis>">
 <!ENTITY argdesc "&lt;&gt; = required argument, [] = optional argument">
 
-<!ENTITY setexplanation "Variables and user-replaceable macros defined by this module are described in a table below. They have specific defaults, which you can override in your configuration if you re-set/re-define them after loading the module. Please refer to <link linkend=''>Configuration</link>-section of this manual">
+<!ENTITY setexplanation "Variables and user-replaceable macros defined by this module are described in a table below. They have specific defaults, which you can override in your configuration if you re-set/re-define them after loading the module. Please refer to <link linkend='inst-setup'>Setup</link>-section of this manual">
 <!ENTITY setexpconf "or see the example configuration for this module">
 
 ]>
@@ -104,46 +104,45 @@
 for following character classes:
 </para>
 <itemizedlist>
- <listitem><para><link linkend="">Mages</link> (<ulink url="http://www.bat.org/help/guilds.php?str=The+Brotherhood+of+Wizardry">The Brotherhood of Wizardry</ulink>)</para></listitem>
- <listitem><para><link linkend="">Channellers</link> (<ulink url="http://www.bat.org/help/guilds.php?str=The+Guild+of+Channellers">The Guild of Channellers</ulink>)</para></listitem>
- <listitem><para><link linkend="">Merchants</link> (<ulink url="http://www.bat.org/help/guilds.php?str=The+Master+Merchants">The Master Merchants</ulink>)</para></listitem>
- <listitem><para><link linkend="">Barbarians</link> (<ulink url="http://www.bat.org/help/guilds.php?str=Barbarian+Guild">Barbarian Guild</ulink>)</para></listitem>
- <listitem><para><link linkend="">LoCs</link> (<ulink url="http://www.bat.org/help/guilds.php?str=Lords+of+Chaos">Lords of Chaos</ulink>)</para></listitem>
+ <listitem><para><link linkend="usage-magical">Mages</link> (<ulink url="http://www.bat.org/help/guilds.php?str=The+Brotherhood+of+Wizardry">The Brotherhood of Wizardry</ulink>)</para></listitem>
+ <listitem><para><link linkend="usage-chann">Channellers</link> (<ulink url="http://www.bat.org/help/guilds.php?str=The+Guild+of+Channellers">The Guild of Channellers</ulink>)</para></listitem>
+ <listitem><para><link linkend="usage-merchant">Merchants</link> (<ulink url="http://www.bat.org/help/guilds.php?str=The+Master+Merchants">The Master Merchants</ulink>)</para></listitem>
+ <listitem><para><link linkend="usage-barb">Barbarians</link> (<ulink url="http://www.bat.org/help/guilds.php?str=Barbarian+Guild">Barbarian Guild</ulink>)</para></listitem>
+ <listitem><para><link linkend="usage-loc">LoCs</link> (<ulink url="http://www.bat.org/help/guilds.php?str=Lords+of+Chaos">Lords of Chaos</ulink>)</para></listitem>
 </itemizedlist>
 <para>
-Also a somewhat old module for alchemists exists, but has not been updated/tested for a while.
+Also a somewhat old module for <link linkend="usage-alch">alchemists</link> exists, but has not been updated/tested for a while.
 </para>
 
 <para>
 In non-guild related sense, GgrTF has most of the basics expected from
-such triggerset. There is a <link linkend="">prot-management and reporting
-system</link>, <link linkend="">spell- and skill-handling</link>, way to
-easily <link linkend="">run commands on each battle round</link>
-(and more), <link linkend="">pss-output mangling</link>,
-<link linkend="">spellwords to names translator</link> and more.
+such triggerset. There is a <link linkend="usage-general-prots">prot-management and reporting
+system</link>, <link linkend="usage-general-skillspell">spell- and skill-handling</link>, way to
+easily <link linkend="usage-general-commands">run commands on each battle round</link>
+(and more), <link linkend="usage-pssmangle">pss-output mangling</link>,
+<link linkend="usage-spellnames">spellwords to names translator</link> and more.
 </para>
 
 </section>
 
+<!-- ================================================ -->
 
 <section id="isggrtfforme"><title>Is GgrTF for Me?</title>
 <para>
-Impossible to tell. When I started working on GgrTF, I was just
-"scratching an itch" - and the itch continues. Summing it up
-i
-
-
-
-and I am still continuing to scratch that very
-same itch, just from different angle.
+Impossible to tell, really. When I started working on GgrTF, I was just
+"scratching an itch", an itch that no doubt still continues.
+During the two years I have been developing GgrTF, most of that
+time I've been scratching my own back, doing stuff for myself.
+Only lately, after Jeskko sneakily joined the project, I have
+been working on some features that do not directly benefit me.
 </para>
 
 <para>
-All in all, GgrTF MIGHT be something for you, especially if you like
-things the way I like them. But on the other hand GgrTF might not be
-for you, and there are several alternatives out there for those who
-do not find it satisfactory. Here I have tried to list some pros and
-cons of using GgrTF.
+All in all, GgrTF <emphasis>might</emphasis> be something for you,
+especially if you like things the way I like them. But on the other
+hand GgrTF might not be for you, and there are several alternatives
+out there for those who do not find it satisfactory. Below I have
+tried to list some pros and cons of using GgrTF.
 </para>
 <itemizedlist>
  <listitem><para>Pros:</para>
@@ -151,14 +150,14 @@
    <listitem><para>Good general quality of code. As somebody put it,
 "you do not instantly get a headache from just looking at the code."</para></listitem>
    <listitem><para>Modularity, easily extendable for most part.</para></listitem>
-   <listitem><para></para></listitem>
-   <listitem><para></para></listitem>
+   <listitem><para>Updated regularly, most bugs get fixed in upstream.</para></listitem>
+   <listitem><para>Some user-level documentation exists.</para></listitem>
   </itemizedlist>
  </listitem>
 
  <listitem><para>Cons:</para>
   <itemizedlist>
-   <listitem><para>Only few guilds are specifically supported.</para></listitem>
+   <listitem><para>Only small number of &batmud;'s guilds are specifically supported.</para></listitem>
    <listitem><para></para></listitem>
    <listitem><para></para></listitem>
    <listitem><para></para></listitem>
@@ -168,6 +167,7 @@
 </itemizedlist>
 </section>
 
+<!-- ================================================ -->
 
 <!--
 <section id="ggrtfhistory"><title>History of GgrTF</title>
@@ -182,6 +182,7 @@
 </section>
 -->
 
+<!-- ================================================ -->
 
 <section id="license"><title>GgrTF License</title>
 <para>
@@ -192,11 +193,13 @@
 <para>
 Complete text of the GNU GPL v2 is included with the code in a file
 called COPYING.txt, and is also available
-<ulink url="http://www.gnu.org/licenses/lgpl.html">here</ulink>.
+<ulink url="http://www.gnu.org/licenses/gpl.html">here</ulink>.
 </para>
 </section>
 
+<!-- ================================================ -->
 
+<!--
 <section id="faq"><title>Frequently Asked Questions (FAQ)</title>
 <qandaset>
   <qandaentry>
@@ -210,35 +213,36 @@
   </qandaentry>
  </qandaset>
 </section>
-
+-->
 
 </chapter>
 
 <!-- *************************************************************** -->
 
 <chapter id="installation"><title>Installation</title>
-
-<section id="downloading"><title>Downloading GgrTF</title>
 <para>
-Fdospakjfpodskfposakf fidsajfoidjf oifjdoi fjodifj oidjfo ijdfoaisjdfoi djfosaijfdo ijfdoijf.
 </para>
 
-<section id="releases"><title>Releases</title>
+<!-- ================================================ -->
+
+<section id="inst-getting"><title>Getting GgrTF</title>
 <para>
-Dsojaoifdj ofwjqofijwdfojvocz oivjwovj vijo rovi ogirj ovjo jaovjroqj oirjgoqierj ogeroöqijvoe.
+</para>
+
+<section id="inst-releases"><title>Releases</title>
+<para>
 </para>
 </section>
 
-<section id="subversion"><title>Subversion-repository</title>
+<section id="inst-subversion"><title>Subversion-repository</title>
 <para>
-Äokgörokg opifjh po gpoker po 2005 okfpsak. Ofpwoqp öfkaöo höoekqöo ke ke pogkwoqpvkw epaov, fkwpoqkfp
-pofksapv pv ke opvkrapevokarpeo pvokrp.
 </para>
 </section>
 </section>
 
+<!-- ================================================ -->
 
-<section id="setup"><title>Setup</title>
+<section id="inst-setup"><title>Setup</title>
 <para>
 </para>
 </section>
@@ -247,20 +251,33 @@
 
 <!-- *************************************************************** -->
 
-<chapter id="usage-usage"><title>Usage and modules</title>
-
-<!-- ================================================ -->
+<chapter id="usage-intro"><title>Usage and modules</title>
 
-<section id="usage-intro"><title>Introduction</title>
 <para>
+
 </para>
-</section>
 
 <!-- ================================================ -->
 
 <section id="usage-general"><title>General (ggrtf.tf)</title>
 <para>
 </para>
+
+<section id="usage-general-commands"><title>Commands</title>
+<para>
+</para>
+</section>
+
+<section id="usage-general-prots"><title>Prot management</title>
+<para>
+</para>
+</section>
+
+<section id="usage-general-skillspell"><title>Skill and spell handling</title>
+<para>
+</para>
+</section>
+
 </section>
 
 <!-- ================================================ -->
@@ -575,9 +592,8 @@
 <section id="usage-barb"><title>Guild: Barbarian (ggrtf-barb.tf)</title>
 <section><title>Description</title>
 <para>
-This module contains, in addition to basic skill fail/fumble
-handling, translator for barbarian reputation bar and handler for
-looting and burning command.
+Functionality: Translator for barbarian reputation bar, reputation
+difference calculator and handler for automated looting and burning.
 </para>
 </section>
 
@@ -689,6 +705,12 @@
 
 <!-- ================================================ -->
 
+<section id="usage-loc"><title>Guild: Lords of Chaos (ggrtf-loc.tf)</title>
+<para>
+</para>
+</section>
+
+
 </chapter>
 
 <!-- *************************************************************** -->