changeset 546:2991678d1a9a

Issue reporting issues added. Information about bugtracker, etc.
author Matti Hamalainen <ccr@tnsp.org>
date Mon, 30 Oct 2006 02:51:13 +0000
parents 7e7cd1558d75
children 705805fb8a41
files docs/manual.sgml
diffstat 1 files changed, 88 insertions(+), 23 deletions(-) [+]
line wrap: on
line diff
--- a/docs/manual.sgml	Mon Oct 30 01:17:55 2006 +0000
+++ b/docs/manual.sgml	Mon Oct 30 02:51:13 2006 +0000
@@ -14,6 +14,7 @@
 <!ENTITY batmudurl "<ulink url='http://www.bat.org/'>BatMUD</ulink>">
 <!ENTITY pupuneturl "<ulink url='http://www.pupunen.net/'>Pupunen.net</ulink>">
 <!ENTITY gnupgurl "<ulink url='http://www.gnupg.org/'>GnuPG</ulink>">
+<!ENTITY trackerurl "<ulink url='http://svn.pupunen.net/mantis/'>bugtracker</ulink>">
 
 <!ENTITY exampletfrc "<section><title>Example configuration</title>">
 <!ENTITY validval "Valid values:">
@@ -2017,6 +2018,15 @@
 
 <section id="usage-pplacer"><title>Party Placer (ggrtf-pplacer.tf)</title>
 <para>
+This module provides functionality for saving and restoring
+party formation (places). Two simple to use macros can be
+issued to save and restore.
+</para>
+
+<para>
+<emphasis>NOTICE! This module requires
+<link linkend="usage-pssmangle">PSS-mangler</link> module to be loaded!
+</emphasis>
 </para>
 
 <section>
@@ -2033,12 +2043,16 @@
   </thead>
   <tbody>
    <row>
-    <entry></entry>
-    <entry></entry>
+    <entry>/ppsave</entry>
+    <entry>Save current party formation. Positions of party members
+    in current formation are stored.
+    </entry>
    </row>
    <row>
-    <entry></entry>
-    <entry></entry>
+    <entry>/ppreset</entry>
+    <entry>Resets or restores the party formation to the one saved
+    previously. Restoring occurs fully automatically.
+    </entry>
    </row>
   </tbody>
  </tgroup>
@@ -2664,17 +2678,48 @@
 </literallayout>
 </blockquote>
 
-<para>
-Although the above quote describes the situation quite well, it is not
-completely truthful. You are free to report bugs and make suggestions
-for improving GgrTF, but do not expect anyone to react instantly, or
-sometimes, at all. And if you bother me (Ggr) via tells too much, you'll
-probably just get in my ignore-list.
-</para>
-
-<para>
-
-</para>
+<itemizedlist>
+ <listitem><para>Report bugs and feature-requests via our
+&trackerurl;. A checklist for reporting bugs:</para>
+  <itemizedlist>
+   <listitem><para>Take your time to think before writing, and
+submitting your bug report. Good rule of thumb is to include
+every piece of information that you think might be relevant,
+but no more than that!
+</para></listitem>
+
+  <listitem><para>
+</para></listitem>
+
+  <listitem><para>
+</para></listitem>
+
+  </itemizedlist>
+ </listitem>
+ 
+ <listitem><para>We do not provide support for usage, please refer
+to the user's manual and only in case the issue is not documented,
+you might be eligible to ask about it.
+</para></listitem>
+
+ <listitem><para>Neither we provide technical support for extending
+GgrTF, nor documentation of the internals. You'll have to figure out
+the workings yourself.
+</para></listitem>
+
+ <listitem><para>Be ready to be contacted by developers, in case
+help and/or more information is required with debugging your issue(s).
+</para></listitem>
+
+ <listitem><para>Remember not to bother the developers via tells
+too much, we want to play the game too, instead of just answering
+your questions and resolving problems.
+</para></listitem>
+
+<!--
+ <listitem><para></para></listitem>
+-->
+</itemizedlist>
 
 <section id="issues"><title>Known issues</title>
 <itemizedlist>
@@ -2689,12 +2734,9 @@
  <listitem><para>The alchemist module has not been tested since 0.4.x,
 it be incompatible with current system.</para></listitem>
 
- <listitem><para>Prots cast by Runemages are not yet supported properly.
-This is being worked on.</para></listitem>
-
  <listitem><para>Hitstats (/hstats) has some problems.</para></listitem>
 
- <listitem><para>There may still be some unnoticed incompabilities with TF5.</para></listitem>
+ <listitem><para>There may still remain some incompabilities with TF5.</para></listitem>
 
 <!--
  <listitem><para></para></listitem>
@@ -2727,13 +2769,13 @@
 
   <qandaentry>
      <question>
-       <para>How to get rid of the battle round flag?</para>
+       <para>How to get rid of the battle round flag/marker?</para>
      </question>
      <answer>
        <para>
-The round flag is required for GgrTF's internal functionality,
-but you can gag it with following piece of code (add it to your
-.tfrc or similar):
+The round marker (long line of asterisks "*") is required for GgrTF's
+internal functionality, but you can gag it with following piece of
+code (add it to your .tfrc or similar):
 </para>
 <screen>
 /test prlist_insert("event_battle_round", "myroundgag")
@@ -2775,6 +2817,28 @@
 
   <qandaentry>
      <question>
+       <para>A spell/prot cast by others at me registers in prot-reporting,
+       but does not work when I cast it on myself!</para>
+     </question>
+     <answer>
+       <para>
+       This is most likely a bug, please report the issue on GgrTF's
+       &trackerurl;. Remember to include the lines you get when you
+       cast the spell on yourself (aka the "prot goes up"-line).
+       </para>
+       <para>
+       Also see the next question below.
+       </para>
+     </answer>
+  </qandaentry>
+
+  <qandaentry>
+<!--
+     <question>
+       <para>Some prots do not register / are not noticed by GgrTF</para>
+     </question>
+-->
+     <question>
        <para>Sometimes the <link linkend="usage-spellnames">
        spellword translator</link> does not work, what gives?</para>
      </question>
@@ -2791,6 +2855,7 @@
        </para>
      </answer>
   </qandaentry>
+
 <!--
   <qandaentry>
      <question>