Mercurial > hg > batmud > ggrtf

changeset 1678:914961b1e2d2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update manual a bit, move gm-tf5 module stuff to statusline section and remove the old gm-tf5 section.
author Matti Hamalainen <ccr@tnsp.org>
date Wed, 27 Mar 2024 17:25:13 +0200
parents 32c6a74b989a
children c165ba2d0db0
files docs/manual.sgml
diffstat 1 files changed, 26 insertions(+), 23 deletions(-) [+]
line wrap: on
line diff
--- a/docs/manual.sgml	Wed Mar 27 17:24:10 2024 +0200
+++ b/docs/manual.sgml	Wed Mar 27 17:25:13 2024 +0200
@@ -982,13 +982,6 @@
 </para>
 
 <para>
-The basic one-row statusline of GgrTF is meant for compatibility,
-<link linkend="usage-tf5">TF5 support module</link> provides another
-version, enhanced to take advantage of newer TF5 beta features
-(TF 5.0 beta 7 or later required).
-</para>
-
-<para>
 Statusline is updated synchronously at ticks, skill- and spell
 castings and certain other events. <emphasis>This depends on
 your <link linkend="inst-config-batmud">BatMUD settings</link>
@@ -997,19 +990,42 @@
 and thus does not get parsed by GgrTF.
 </para>
 
+<para>
+<emphasis>The functionality of the statusline depends on
+your <link linkend="inst-config-batmud">BatMUD settings</link>
+being correctly set up.</emphasis> If HP/SP/EP etc. information does
+not appear, most likely your 'sc' setting is "wrong",
+and thus does not get parsed by GgrTF.
+</para>
+</note>
+
 <screenshot>
  <mediaobject>
-  <imageobject><imagedata fileref="statusbar.gif" format="GIF" /></imageobject>
-  <imageobject><imagedata fileref="statusbar.eps" format="EPS" /></imageobject>
+  <imageobject><imagedata fileref="statusbar_tf5.gif" format="GIF" /></imageobject>
+  <imageobject><imagedata fileref="statusbar_tf5.eps" format="EPS" /></imageobject>
   <textobject>
    <phrase>GgrTF statusline</phrase>
   </textobject>
   <caption>
-   <para>Example of typical basic GgrTF statusline.</para>
+   <para>Example of typical basic GgrTF statusline in TF5.</para>
   </caption>
  </mediaobject>
 </screenshot>
 
+<itemizedlist>
+ <listitem><para>
+Enhanced 2-row statusline: First line contains HP/SP/EP- and
+skill/spell/etc- information as usual. Prot status has been
+moved to the second line.
+</para></listitem>
+
+</itemizedlist>
+
+<!--
+- example configuration
+- document special variables
+-->
+
 <orderedlist>
  <listitem><para>Current hit points / hit points maximum.</para></listitem>
  <listitem><para>Current spell points / spell points maximum.</para></listitem>
@@ -2545,19 +2561,6 @@
 
 <!-- ================================================ -->
 
-<section id="usage-tf5"><title>TinyFugue 5 support (gm-tf5.tf)</title>
-<para>
-This is a special enhancement module for those who use GgrTF
-with &tfurl; version 5.0 (beta 7 and LATER). Although GgrTF should work with TF5
-without this module, you may wish to take benefit of the
-enhanced features designed for TF5 this module provides.
-</para>
-
-<note>
-<para>
-The code in this module uses features available on TF 5.0 beta 7
-and later, it will NOT work correctly in older betas!
-</para>
 <para>
 <emphasis>The functionality of the statusline depends on
 your <link linkend="inst-config-batmud">BatMUD settings</link>