Merge Stas's patch #3.
[super-star-trek.git] / sst-doc.xml
index c5863a7e2a99db378747e3ed0eca2339782c5180..e810746fa6f08a843a6d1ea889a00346fcb06a48 100644 (file)
@@ -589,7 +589,7 @@ safely even in the midst of battle.</para>
 Mnemonic:  MOVE\r
 Shortest abbreviation:  M\r
 Full command:  MOVE MANUAL &lt;displacement&gt;\r
-               MOVE AUTOMATIC &lt;estination*gt;\r
+               MOVE AUTOMATIC &lt;destination&gt;\r
 </literallayout>\r
 \r
 <para>This command is the usual way to move from one place to another\r
@@ -635,7 +635,7 @@ scan shown earlier.</para>
 \r
 <para>&lt;para&gt;where &lt;qrow&gt; and &lt;qcol&gt; are the row and column\r
 numbers of the destination quadrant, and &lt;srow&gt; and &lt;scol&gt;\r
-are the row and column numbers of thedestination sector in that\r
+are the row and column numbers of the destination sector in that\r
 quadrant.  This command also moves your ship in a straight line path\r
 to the destination.  For moving within a quadrant, &lt;qrow&gt; and\r
 &lt;qcol&gt; may be omitted. For example, to move to sector 2 - 9 in\r
@@ -1652,22 +1652,36 @@ site</ulink>.</para>
 </para></listitem>\r
 </itemizedlist>\r
 \r
-<para>Modifications I made:</para>\r
+<para>Modifications I've made:</para>\r
 \r
 <itemizedlist>\r
 <listitem><para>\r
-I converted the flat-text SST.DOC file to XML-Docbook so it could be webbed.\r
-(That's what you're reading now.)\r
+I converted the flat-text SST.DOC file to XML-Docbook so it can be\r
+webbed. (That's what you're reading now.)\r
+</para></listitem>\r
+<listitem><para>\r
+The command-help code needed a rewrite because the flat-text form of\r
+the documentation is now generated from XML and doesn't have the\r
+easily recognizable section delimiters it used to.  I wrote a script\r
+to filter that flat-text form into an sst.doc that's easy to parse for\r
+command descriptions, and changed some logic in sst.c to match.\r
 </para></listitem>\r
 <listitem><para>\r
-I cleaned up a lot of grubby FORTRANisms in the code internals.\r
+I've cleaned up a lot of grubby FORTRANisms in the code internals --\r
+used sizeof(), replaced magic numeric constants with #defines,\r
+that sort of thing.\r
 </para></listitem>\r
 <listitem><para>\r
 I fixed a surprising number of typos in the code and documentation.\r
 </para></listitem>\r
 <listitem><para>\r
-I changed the freeze logic to emit an identifiable magic number and \r
-the thaw logic to check for it.\r
+All the game state now lives in one big structure that can be\r
+written to and read from disk as one blob.  The write gives it an\r
+an identifiable magic number and the thaw logic checks for same. \r
+</para></listitem>\r
+<listitem><para>\r
+I made the internal pager work, nd in the process got rid of a number\r
+of platform dependencies in the code.\r
 </para></listitem>\r
 </itemizedlist>\r
 \r