[games/picmi] doc: Documentation updates
Antoni Bella Pérez
null at kde.org
Fri Oct 8 16:39:53 BST 2021
Git commit d42631cec48457a57cd064124430264c703a413f by Antoni Bella Pérez.
Committed on 08/10/2021 at 15:39.
Pushed by bellaperez into branch 'master'.
Documentation updates
* Update date and version numbers
* Re-indent some sections (more readable)
* Add 'Game -> Restart Game' and 'View -> Full Screen Mode' menu items
* Suitable tags
M +176 -266 doc/index.docbook
https://invent.kde.org/games/picmi/commit/d42631cec48457a57cd064124430264c703a413f
diff --git a/doc/index.docbook b/doc/index.docbook
index f0d97b2..975b9be 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -24,8 +24,8 @@
<legalnotice>&FDLNotice;</legalnotice>
-<date>2016-05-13</date>
-<releaseinfo>2.0.0 (Applications 16.04)</releaseinfo>
+<date>2021-10-08</date>
+<releaseinfo>2.0.0 (KDE Gear 21.08)</releaseinfo>
<abstract>
<para>
@@ -68,7 +68,7 @@ The object of the game is to color cells according to numbers given at the side
<title>How to Play</title>
<para>
- The player is presented with a blank board, and a list of numbers for each row and column. These numbers represent how runs are organized within any given row or column. For example, a number sequence of <quote>4 8 3</quote> would mean there are sets of four, eight, and three filled cells, in that order, with at least one blank cell between successive groups. The objective of the game is to use these hints to uncover the actual solution, and do this as quickly as possible.
+The player is presented with a blank board, and a list of numbers for each row and column. These numbers represent how runs are organized within any given row or column. For example, a number sequence of <quote>4 8 3</quote> would mean there are sets of four, eight, and three filled cells, in that order, with at least one blank cell between successive groups. The objective of the game is to use these hints to uncover the actual solution, and do this as quickly as possible.
</para>
<para>
@@ -94,11 +94,11 @@ Alternatively, the included preset puzzles can be played by selecting <guilabel>
<title>Rules</title>
<para>The number sequence in a row or column provides certain information about the count of occupied cells and their arrangement within a row or column.</para>
<itemizedlist>
-<listitem><para>A number represents the length of a connected run of occupied cells on the board. This run either has at least one empty cell on each side or is located directly on the board edge.</para></listitem>
-<listitem><para>Additionally, a number sequence shows the order of these runs within a row or column.</para></listitem>
-<listitem><para>When the <guilabel>Prevent Mistakes</guilabel> option is enabled, it is not possible to incorrectly mark a cell as occupied - instead, penalty time is added to the timer. The penalty is increased with each mistake made.</para></listitem>
-<listitem><para>If <guilabel>Prevent Mistakes</guilabel> is disabled, there is no feedback whether a cell has been marked correctly, and there is no penalty for making mistakes.</para></listitem>
-<listitem><para>The game will stop once all occupied cells have been marked correctly.</para></listitem>
+ <listitem><para>A number represents the length of a connected run of occupied cells on the board. This run either has at least one empty cell on each side or is located directly on the board edge.</para></listitem>
+ <listitem><para>Additionally, a number sequence shows the order of these runs within a row or column.</para></listitem>
+ <listitem><para>When the <guilabel>Prevent Mistakes</guilabel> option is enabled, it is not possible to incorrectly mark a cell as occupied - instead, penalty time is added to the timer. The penalty is increased with each mistake made.</para></listitem>
+ <listitem><para>If <guilabel>Prevent Mistakes</guilabel> is disabled, there is no feedback whether a cell has been marked correctly, and there is no penalty for making mistakes.</para></listitem>
+ <listitem><para>The game will stop once all occupied cells have been marked correctly.</para></listitem>
</itemizedlist>
</sect1>
@@ -111,188 +111,108 @@ Alternatively, the included preset puzzles can be played by selecting <guilabel>
<title>Menu Items</title>
<variablelist>
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
-</shortcut>
-<guimenu>Game</guimenu>
-<guimenuitem>New</guimenuitem>
-</menuchoice></term>
-<listitem>
-<para>
-Starts a new game. It creates a random board using the current difficulty level.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo>
-</shortcut>
-<guimenu>Game</guimenu>
-<guimenuitem>Load</guimenuitem>
-</menuchoice></term>
-<listitem>
-<para>
-Loads a preset puzzle. The names of puzzles are hidden until they are solved. High score lists and difficulty settings are disabled.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycap>F5</keycap>
-</shortcut>
-<guimenu>Game</guimenu>
-<guimenuitem>Restart</guimenuitem>
-</menuchoice></term>
-<listitem>
-<para>
- <!--FIXME -->
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<shortcut><keycap>P</keycap></shortcut>
-<guimenu>Game</guimenu>
-<guimenuitem>Pause</guimenuitem></menuchoice></term>
-<listitem>
-<para>
-Pauses the game time. Click on the menu item again to make the game resume. Note that the board disappears when the game is paused as it would be unfair if you could search for good moves without the time pressure.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo>
-</shortcut>
-<guimenu>Game</guimenu>
-<guimenuitem>Show High Scores</guimenuitem></menuchoice></term>
-<listitem>
-<para>
-Shows a dialog containing the High Scores for the various difficulty levels.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
-</shortcut>
-<guimenu>Game</guimenu>
-<guimenuitem>Quit</guimenuitem>
-</menuchoice></term>
-<listitem>
-<para>
-Quits the program.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo>
-</shortcut>
-<guimenu>Move</guimenu>
-<guimenuitem>Undo</guimenuitem>
-</menuchoice></term>
-<listitem>
-<para>
-Undo the previous move if one exists.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo>
-</shortcut>
-<guimenu>Move</guimenu>
-<guimenuitem>Hint</guimenuitem>
-</menuchoice></term>
-<listitem>
-<para>
-Marks a cell as occupied or empty.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<guimenu>Move</guimenu>
-<guimenuitem>Solve</guimenuitem>
-</menuchoice></term>
-<listitem>
-<para>
-Play a demo game.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo>
-</shortcut>
-<guimenu>Move</guimenu>
-<guimenuitem>Load Position</guimenuitem>
-</menuchoice></term>
-<listitem>
-<para>
-Loads the most recently saved position.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo>
-</shortcut>
-<guimenu>Move</guimenu>
-<guimenuitem>Save Position</guimenuitem>
-</menuchoice></term>
-<listitem>
-<para>
-Saves the current board position.
-</para>
-</listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<guimenu>Settings</guimenu>
-<guisubmenu>Difficulty</guisubmenu>
-</menuchoice></term>
-<listitem>
-<para>Lets you set the difficulty level from a sub-menu.</para>
-<para>There are four levels of difficulty:
-<itemizedlist>
-<listitem><para><guimenuitem>Easy</guimenuitem>: 10 rows, 10 columns, 55% of all cells are occupied, Prevent Mistakes is disabled.</para></listitem>
-<listitem><para><guimenuitem>Medium</guimenuitem>: 10 rows, 15 columns, 55% of all cells are occupied, Prevent Mistakes is disabled.</para></listitem>
-<listitem><para><guimenuitem>Hard</guimenuitem>: 15 rows, 15 columns, 55% of all cells are occupied, Prevent Mistakes is disabled.</para></listitem>
-<listitem><para><guimenuitem>Custom</guimenuitem>: Custom board dimensions and settings.</para></listitem>
-</itemizedlist>
-</para></listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<guimenu>Settings</guimenu>
-<guimenuitem>Configure &picmi;...</guimenuitem>
-</menuchoice></term>
-<listitem><para>Choose the game background image, board dimensions and settings for custom difficulty.</para></listitem>
-</varlistentry>
+ <varlistentry>
+ <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> </shortcut>
+ <guimenu>Game</guimenu>
+ <guimenuitem>New</guimenuitem></menuchoice></term>
+ <listitem><para><action>Starts a new game.</action> It creates a random board using the current difficulty level.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo> </shortcut>
+ <guimenu>Game</guimenu>
+ <guimenuitem>Load...</guimenuitem></menuchoice></term>
+ <listitem><para><action>Loads a preset puzzle.</action> The names of puzzles are hidden until they are solved. High score lists and difficulty settings are disabled.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><menuchoice><shortcut><keycap>F5</keycap></shortcut>
+ <guimenu>Game</guimenu>
+ <guimenuitem>Restart Game</guimenuitem></menuchoice></term>
+ <listitem><para><action>This will restart the current game.</action></para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><menuchoice><shortcut><keycap>P</keycap></shortcut>
+ <guimenu>Game</guimenu>
+ <guimenuitem>Pause</guimenuitem></menuchoice></term>
+ <listitem><para><action>Pauses the game time.</action> Click on the menu item again to make the game resume. Note that the board disappears when the game is paused as it would be unfair if you could search for good moves without the time pressure.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo> </shortcut>
+ <guimenu>Game</guimenu>
+ <guimenuitem>Show High Scores</guimenuitem></menuchoice></term>
+ <listitem><para><action>Shows a dialog containing the High Scores for the various difficulty levels.</action></para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo> </shortcut>
+ <guimenu>Game</guimenu>
+ <guimenuitem>Quit</guimenuitem></menuchoice></term>
+ <listitem><para><action>Quits</action> the &picmi;</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo> </shortcut>
+ <guimenu>Move</guimenu>
+ <guimenuitem>Undo</guimenuitem></menuchoice></term>
+ <listitem><para><action>Undo the previous move</action> if one exists.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo> </shortcut>
+ <guimenu>Move</guimenu>
+ <guimenuitem>Hint</guimenuitem></menuchoice></term>
+ <listitem><para><action>Marks a cell as occupied or empty.</action></para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><menuchoice><guimenu>Move</guimenu>
+ <guimenuitem>Solve</guimenuitem></menuchoice></term>
+ <listitem><para><action>Play a demo game.</action></para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo> </shortcut>
+ <guimenu>Move</guimenu>
+ <guimenuitem>Load Position</guimenuitem></menuchoice></term>
+ <listitem><para><action>Loads the most recently saved position.</action></para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> </shortcut>
+ <guimenu>Move</guimenu>
+ <guimenuitem>Save Position</guimenuitem></menuchoice></term>
+ <listitem><para><action>Saves the current board position.</action></para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo> </shortcut>
+ <guimenu>View</guimenu>
+ <guimenuitem>Full Screen Mode</guimenuitem></menuchoice></term>
+ <listitem><para><action>Toggles the graphic interface to full screen mode.</action></para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><menuchoice><guimenu>Settings</guimenu>
+ <guisubmenu>Difficulty</guisubmenu></menuchoice></term>
+ <listitem><para><action>Lets you set the difficulty level from a sub-menu.</action></para>
+ <para>There are four levels of difficulty:
+ <itemizedlist>
+ <listitem><para><guimenuitem>Easy</guimenuitem>: 10 rows, 10 columns, 55% of all cells are occupied, Prevent Mistakes is disabled.</para></listitem>
+ <listitem><para><guimenuitem>Medium</guimenuitem>: 10 rows, 15 columns, 55% of all cells are occupied, Prevent Mistakes is disabled.</para></listitem>
+ <listitem><para><guimenuitem>Hard</guimenuitem>: 15 rows, 15 columns, 55% of all cells are occupied, Prevent Mistakes is disabled.</para></listitem>
+ <listitem><para><guimenuitem>Custom</guimenuitem>: Custom board dimensions and settings.</para></listitem>
+ </itemizedlist>
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><menuchoice><guimenu>Settings</guimenu>
+ <guimenuitem>Configure &picmi;...</guimenuitem></menuchoice></term>
+ <listitem><para><action>Choose the game background image, board dimensions and settings for custom difficulty.</action></para></listitem>
+ </varlistentry>
</variablelist>
<para>
@@ -309,85 +229,75 @@ of the &kde; Fundamentals.
<para>The default shortcuts are:</para>
<table>
-<title>Shortcuts</title>
-<tgroup cols="2">
-<tbody>
-<row>
-<entry>Start a new game</entry>
-<entry>
-<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
-</entry>
-</row>
-<row>
-<entry>Load a preset game</entry>
-<entry>
-<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo>
-</entry>
-</row>
-<row>
-<entry>Pause</entry>
-<entry><keycap>P</keycap></entry>
-</row>
-<row>
-<entry>Show High Scores</entry>
-<entry>
-<keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo>
-</entry>
-</row>
-<row>
-<entry>Full Screen Mode</entry>
-<entry><keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo></entry>
-</row>
-<row>
-<entry>Quit</entry>
-<entry>
-<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
-</entry>
-</row>
-<row>
-<entry>Help</entry>
-<entry><keycap>F1</keycap></entry>
-</row>
-<row>
-<entry>What's this?</entry>
-<entry>
-<keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo>
-</entry>
-</row>
-</tbody>
-</tgroup>
+ <title>Shortcuts</title>
+ <tgroup cols="2">
+ <tbody>
+ <row>
+ <entry>Start a new game</entry>
+ <entry><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></entry>
+ </row>
+ <row>
+ <entry>Load a preset game</entry>
+ <entry><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></entry>
+ </row>
+ <row>
+ <entry>Pause</entry>
+ <entry><keycap>P</keycap></entry>
+ </row>
+ <row>
+ <entry>Show High Scores</entry>
+ <entry><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></entry>
+ </row>
+ <row>
+ <entry>Full Screen Mode</entry>
+ <entry><keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo></entry>
+ </row>
+ <row>
+ <entry>Quit</entry>
+ <entry><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></entry>
+ </row>
+ <row>
+ <entry>Help</entry>
+ <entry><keycap>F1</keycap></entry>
+ </row>
+ <row>
+ <entry>What's this?</entry>
+ <entry><keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo></entry>
+ </row>
+ </tbody>
+ </tgroup>
</table>
<table>
-<title>Keyboard controls</title>
-<tgroup cols="2">
-<tbody>
-<row>
-<entry>Move Left</entry>
-<entry><keycap>Left or H</keycap></entry>
-</row>
-<row>
-<entry>Move Right</entry>
-<entry><keycap>Right or L</keycap></entry>
-</row>
-<row>
-<entry>Move Up</entry>
-<entry><keycap>Up or K</keycap></entry>
-</row>
-<row>
-<entry>Move Down</entry>
-<entry><keycap>Down or J</keycap></entry>
-</row>
-<row>
-<entry>(Un)mark cell occupied</entry>
-<entry><keycap>X</keycap></entry>
-</row>
-<row>
-<entry>(Un)mark cell free</entry>
-<entry><keycap>Space</keycap></entry>
-</row>
-</tbody>
-</tgroup>
+ <title>Keyboard controls</title>
+ <tgroup cols="2">
+ <tbody>
+ <row>
+ <entry>Move Left</entry>
+ <entry>&Left; or <keycap>H</keycap></entry>
+ </row>
+ <row>
+ <entry>Move Right</entry>
+ <entry>&Right; or <keycap>L</keycap></entry>
+ </row>
+ <row>
+ <entry>Move Up</entry>
+ <entry>&Up; or <keycap>K</keycap></entry>
+ </row>
+ <row>
+ <entry>Move Down</entry>
+ <entry>&Down; or <keycap>J</keycap></entry>
+ </row>
+ <row>
+ <entry>(Un)mark cell occupied</entry>
+ <entry><keycap>X</keycap></entry>
+ </row>
+ <row>
+ <entry>(Un)mark cell free</entry>
+ <entry>&Space;</entry>
+ </row>
+ </tbody>
+ </tgroup>
</table>
</sect1>
More information about the kde-doc-english
mailing list