[games/ksokoban] doc: Documentation updates

[Antoni Bella Pérez]

Git commit 444732797bff401346527e66be3b2a2754559eda by Antoni Bella Pérez.
Committed on 18/08/2021 at 16:49.
Pushed by bellaperez into branch 'master'.

Documentation updates

* Update date and version numbers
* Remove final whitespaces
* Use more entities
* Suitable tags and punctuation
* Use common KDE Help menu items message

M  +35   -38   doc/index.docbook

https://invent.kde.org/games/ksokoban/commit/444732797bff401346527e66be3b2a2754559eda

diff --git a/doc/index.docbook b/doc/index.docbook
index fe1b0de..c5f1a37 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -26,13 +26,12 @@
 
 <legalnotice>&FDLNotice;</legalnotice>
 
-<date>2006-06-19</date>
-<releaseinfo>0.4.2</releaseinfo>
+<date>2021-08-19</date>
+<releaseinfo>0.5.0 (KDE Gear 21.08)</releaseinfo>
 
 <abstract>
 <para>
-&ksokoban; is a &kde; implementation of the Japanese warehouse keeper
-game <quote>sokoban</quote>.
+&ksokoban; is a implementation of the Japanese warehouse keeper game <quote>sokoban</quote>.
 </para>
 </abstract>
 
@@ -87,8 +86,7 @@ squares, which are marked with green glassy round things on the floor.
 
 <para>
 Use the cursor keys or the mouse to move about. If you move onto a gem
-using the cursor keys or the <mousebutton>middle</mousebutton> mouse
-button, and there is nothing blocking it on the opposite side, then you
+using the cursor keys or the &MMB;, and there is nothing blocking it on the opposite side, then you
 will push the gem.  It isn't possible to pull the gems, so if you push
 a gem into a corner it will be stuck there. You cannot step over the
 gems either, so you can also get trapped in a part of the maze by
@@ -114,18 +112,18 @@ can of course also restart the level from the very beginning.
 </thead>
 
 <tbody>
-<row><entry>Cursor keys </entry><entry>Move one square in a direction </entry></row>
-<row><entry><keycombo action="simul">&Ctrl;<keycap>Cursor</keycap></keycombo> keys </entry><entry>Move as far as possible in a direction without pushing any gems </entry></row>
-<row><entry><keycombo action="simul">&Shift;<keycap>Cursor</keycap></keycombo> keys </entry><entry>Move as far as possible in a direction, pushing any gem in the way </entry></row>
-<row><entry><mousebutton>Left</mousebutton> mouse button </entry><entry>Move to any place in the maze that can be reached without pushing any gems </entry></row>
-<row><entry><mousebutton>Middle</mousebutton> mouse button or <keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></entry><entry>Undo the last move </entry></row>
-<row><entry><mousebutton>Right</mousebutton> mouse button </entry><entry>Move up/down/left/right in a straight line, pushing any gem in the way </entry></row>
-<row><entry><mousebutton>Mouse wheel</mousebutton></entry><entry>Traverse the history </entry></row>
-<row><entry><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></entry><entry>Redo the last undone move </entry></row>
-<row><entry><keycap>N</keycap> </entry><entry>Go to the next level in the current level collection </entry></row>
-<row><entry><keycap>P</keycap> </entry><entry>Go to the previous level in the current level collection </entry></row>
-<row><entry>&Esc; </entry><entry>Restart the current level </entry></row>
-<row><entry><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></entry><entry>Quit the game </entry></row>
+<row><entry>Cursor keys</entry><entry>Move one square in a direction</entry></row>
+<row><entry><keycombo action="simul">&Ctrl;<keycap>Cursor</keycap></keycombo> keys</entry><entry>Move as far as possible in a direction without pushing any gems</entry></row>
+<row><entry><keycombo action="simul">&Shift;<keycap>Cursor</keycap></keycombo> keys </entry><entry>Move as far as possible in a direction, pushing any gem in the way</entry></row>
+<row><entry><mousebutton>Left</mousebutton> mouse button</entry><entry>Move to any place in the maze that can be reached without pushing any gems </entry></row>
+<row><entry><mousebutton>Middle</mousebutton> mouse button or <keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></entry><entry>Undo the last move</entry></row>
+<row><entry><mousebutton>Right</mousebutton> mouse button</entry><entry>Move up/down/left/right in a straight line, pushing any gem in the way</entry></row>
+<row><entry><mousebutton>Mouse wheel</mousebutton></entry><entry>Traverse the history</entry></row>
+<row><entry><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo> </entry><entry>Redo the last undone move</entry></row>
+<row><entry><keycap>N</keycap></entry><entry>Go to the next level in the current level collection</entry></row>
+<row><entry><keycap>P</keycap></entry><entry>Go to the previous level in the current level collection</entry></row>
+<row><entry>&Esc;</entry><entry>Restart the current level</entry></row>
+<row><entry><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></entry><entry>Quit the game</entry></row>
 </tbody>
 </tgroup>
 </informaltable>
@@ -137,11 +135,10 @@ can of course also restart the level from the very beginning.
 
 <para>
 &ksokoban; has the ability to load external sokoban levels from text
-files.  You can load levels using the menu entry
-<menuchoice><guimenu>Game</guimenu> <guimenuitem>Load
-Levels...</guimenuitem> </menuchoice>, or by specifying the level file
-&URL; as a command line argument when starting &ksokoban; from a
-shell.
+files.  You can load levels using the <menuchoice><guimenu>Game</guimenu>
+<guimenuitem>Load Levels...</guimenuitem></menuchoice> menu item, or by
+specifying the level file &URL; as a command line argument when starting
+&ksokoban; from a shell.
 </para>
 
 <para>
@@ -163,7 +160,7 @@ contain text between the levels.
 <row><entry><literal>.</literal></entry><entry>Goal square</entry></row>
 <row><entry><literal>$</literal></entry><entry>Object on an empty square</entry></row>
 <row><entry><literal>*</literal></entry><entry>Object on a goal square</entry></row>
-<row><entry><literal>@</literal></entry><entry>Start position on an empty square</entry></row>
+<row><entry><literal>@</literal></entry><entry>Start position on an empty square </entry></row>
 <row><entry><literal>+</literal></entry><entry>Start position on a goal square</entry></row>
 </tbody>
 </tgroup>
@@ -248,7 +245,7 @@ more information.</para>
 <guisubmenu>Level Collection</guisubmenu>
 </menuchoice></term>
 <listitem>
-<para><action>Change to a different set of levels.</action> &ksokoban;
+<para><action>A submenu to switch to a different set of levels.</action> &ksokoban;
 comes with several level sets, and you can load more that you can find
 on the internet.</para>
 </listitem>
@@ -261,7 +258,7 @@ on the internet.</para>
 <guimenuitem>Undo</guimenuitem>
 </menuchoice></term>
 <listitem>
-<para><action>Undo the last move</action></para>
+<para><action>Undo the last move.</action></para>
 </listitem>
 </varlistentry>
 
@@ -272,8 +269,7 @@ on the internet.</para>
 <guimenuitem>Redo</guimenuitem>
 </menuchoice></term>
 <listitem>
-<para><action>Redo the last move you undid with the menu item
-above.</action></para>
+<para><action>Redo the last move you undid with the menu item above.</action></para>
 </listitem>
 </varlistentry>
 
@@ -294,7 +290,7 @@ above.</action></para>
 <title>The Animation Menu</title>
 
 <para>
-The <guimenu>Animation</guimenu> Menu allows you to specify the speed that movement replay animations are shown at.
+This menu offers menu items with check boxes that allow you to specify the speed to which the movement replay animations are shown at.
 </para>
 
 <variablelist>
@@ -304,7 +300,7 @@ The <guimenu>Animation</guimenu> Menu allows you to specify the speed that movem
 <guisubmenu>Slow</guisubmenu>
 </menuchoice></term>
 <listitem>
-<para><action>Show replay animations at a slow pace</action>.</para>
+<para><action>Show replay animations at a slow pace.</action></para>
 </listitem>
 </varlistentry>
 
@@ -324,7 +320,7 @@ The <guimenu>Animation</guimenu> Menu allows you to specify the speed that movem
 <guisubmenu>Fast</guisubmenu>
 </menuchoice></term>
 <listitem>
-<para><action>Show replay animations at the fastest pace</action>.</para>
+<para><action>Show replay animations at the fastest pace.</action></para>
 </listitem>
 </varlistentry>
 
@@ -334,7 +330,7 @@ The <guimenu>Animation</guimenu> Menu allows you to specify the speed that movem
 <guisubmenu>Off</guisubmenu>
 </menuchoice></term>
 <listitem>
-<para><action>Do not animate replay animations</action>.</para>
+<para><action>Do not animate replay animations.</action></para>
 </listitem>
 </varlistentry>
 </variablelist>
@@ -356,8 +352,8 @@ The <guimenu>Animation</guimenu> Menu allows you to specify the speed that movem
 particular state.</action> You might use this to save yourself
 repeating the same initial steps in a level.</para>
 <para>You can have up to ten bookmarks at a time, and access them via the
-hotkey <keycombo action="simul">&Ctrl;<keycap><replaceable>X</replaceable></keycap></keycombo>,
-where <replaceable>X</replaceable> is any digit between 0 and 9.</para>
+<keycombo action="simul">&Ctrl;<keycap><replaceable>X</replaceable></keycap></keycombo>
+shortcut, where <replaceable>X</replaceable> is any digit between 0 and 9.</para>
 </listitem>
 </varlistentry>
 
@@ -367,8 +363,7 @@ where <replaceable>X</replaceable> is any digit between 0 and 9.</para>
 <guisubmenu>Go to Bookmark</guisubmenu>
 </menuchoice></term>
 <listitem>
-<para><action>Jump to a state you have previously saved as a
-bookmark</action>.</para>
+<para><action>Jump to a state you have previously saved as a bookmark.</action></para>
 </listitem>
 </varlistentry>
 </variablelist>
@@ -378,7 +373,9 @@ bookmark</action>.</para>
 <sect1 id="help-menu">
 <title>The Help Menu</title>
 
-&help.menu.documentation;
+<para>
+&ksokoban; has the common &kde; <guimenu>Help</guimenu> menu item, for more information read the section about the <ulink url="help:/fundamentals/menus.html#menus-help">Help Menu</ulink> of the &kde; Fundamentals.
+</para>
 
 </sect1>
 </chapter>
@@ -412,6 +409,6 @@ Skinner <email>sasquatch at bentonrea.com</email>. See
 &underGPL;
 </chapter>
 
-&documentation.index; 
+&documentation.index;
 </book>