Documentation polishing.

[super-star-trek.git] / doc / sst-doc.xml

diff --git a/doc/sst-doc.xml b/doc/sst-doc.xml
index 185b67e0b02284765235d7205119af1b50871983..1455e10e2a49861e82469ed456907c3d6c04ab21 100644 (file)
--- a/doc/sst-doc.xml
+++ b/doc/sst-doc.xml
@@ -2,7 +2,7 @@
 <!DOCTYPE book PUBLIC 
     "-//OASIS//DTD DocBook XML V4.1.2//EN" 
     "docbook/docbookxx.dtd"[
-<!ENTITY sst-site      "http://sst.berlios.de/">
+<!ENTITY sst-site      "http://catb.org/~esr/super-star-trek/">
 <!ENTITY retro         "http://catb.org/~esr/retro/">
 ]>
 <book>
@@ -961,9 +961,9 @@ calculate travel times and energy usage.</para>
 <sect1><title>Photon Torpedoes</title>
 
 <literallayout>
-Mnemonic:  PHOTONS
-Shortest abbreviation:  PHO
-Full commands:  PHOTONS &lt;NUMBER&gt; &lt;TARG1&gt; &lt;TARG2&gt; &lt;TARG3&gt;
+Mnemonic:  TORPEDO
+Shortest abbreviation:  TO
+Full commands:  TORPEDO &lt;NUMBER&gt; &lt;TARG1&gt; &lt;TARG2&gt; &lt;TARG3&gt;
 </literallayout>
 
 <para>Photon torpedoes are projectile weapons&mdash;you either hit what you aim
@@ -1584,7 +1584,7 @@ orientation</quote>.</para>
  P         PHASERS &lt;TOTAL AMOUNT&gt;                 phasers and computer
            PHASERS AUTOMATIC &lt;TOTAL AMOUNT&gt;       phasers, computer, sr sensors
            PHASERS MANUAL &lt;AMT1&gt; &lt;AMT2&gt; ...       phasers
- PHO       PHOTONS &lt;NUMBER&gt; &lt;TARGETS&gt;             torpedo tubes 
+ TOR       TORPEDO &lt;NUMBER&gt; &lt;TARGETS&gt;             torpedo tubes 
  PL        PLANETS                                (none)
  PR        PROBE &lt;ARMED&gt; &lt;MANUAL&gt; &lt;DISPLACEMENT&gt;  probe launcher, radio 
            PROBE &lt;ARMED&gt; AUTOMATIC &lt;DESTINATION&gt;  launcher, radio, computer
@@ -1633,10 +1633,8 @@ Impulse engines require 20 units to warm up, plus 100 units per
 <para>The original Star Trek seems to have been written by Mike
 Mayfield at the beginning of the 1970s.  His first version was in
 BASIC for a Sigma 7 in 1971; in 1972 he rewrote it in Hewlett Packard
-BASIC. The source is <ulink
-url="&sst-site;www/historic/mayfield.basic">available</ulink> on the
-SST2K website. In January 1975 it became part of the DECUS library
-under the name <ulink
+BASIC. The source is included in the SST2K repository.  In January
+1975 it became part of the DECUS library under the name <ulink
 url='http://www.trailing-edge.com/~shoppa/decus/110174.html'>SPACWR</ulink>.</para>
 
 <para>While some people claim to have recollections of playing Trek
@@ -1662,9 +1660,8 @@ Hicks dated 5 April 1973. This does not appear to have been derived
 from Ahl's SPACWR. The header says "GENERAL IDEA STOLEN FROM
 PENN. U.", and the game has several features not present in SPACEWR:
 notably, the Death Ray, ramming, and the Klingon summons to surrender.
-And, of course, it predates Ahl's book.  The source is <ulink
-url="&sst-site;www/historic/UT-Trek.basic">available</ulink> on the
-SST2K website.</para>
+And, of course, it predates Ahl's book.  The source is included in the
+SST2K repository.</para>
 
 <para>Dave Matuszek, Paul Reynolds et. al. at UT Austin played the
 Hicks version on a CDC6600, but disliked the long load time and
@@ -1826,8 +1823,8 @@ is alive.</para>
 <para>Planets are auto-scanned when you enter the quadrant.</para>
 </listitem>
 <listitem>
-<para>Mining or using crystals in presense of enemy now yields an attack.
-There are other minor adjustments to what yields an attack
+<para>Mining or using crystals in the presence of the enemy now yields
+an attack.  There are other minor adjustments to what yields an attack
 and what does not.</para>
 </listitem>
 <listitem>
@@ -1843,7 +1840,7 @@ better anyway.</para>
 </listitem>
 </itemizedlist>
 
-<para>My changes got merged into SST2K in 2005, and I work on it now.</para>
+<para>My changes got merged into SST2K in 2005.</para>
 
 </sect1>
 <sect1><title>Eric Raymond's story</title>
@@ -1886,7 +1883,7 @@ command descriptions, and changed some logic in sst.c to match.
 <listitem><para>
 I've cleaned up a lot of grubby FORTRANisms in the code internals &mdash;
 used sizeof(), replaced magic numeric constants with #defines,
-that sort of thing.
+that sort of thing.  Later I translated the code from C to Python.
 </para></listitem>
 <listitem><para>
 I fixed a surprising number of typos in the code and documentation.
@@ -2059,6 +2056,9 @@ this time.</para></listitem>
 
 <listitem><para>9 October 2006 &mdash; Translation to
 Python.</para></listitem>
+
+<listitem><para>22 February 2017 &mdash; Color added.</para></listitem>
+
 </itemizedlist>
 
 <para>One as-yet unanswered question is when the code changed from