[games/picmi] doc: More documentation updates

Antoni Bella Pérez null at kde.org
Sat Oct 9 11:25:51 BST 2021


Git commit ee9b359490ecb238a481df2ab9f60c42db03384f by Antoni Bella Pérez.
Committed on 09/10/2021 at 10:24.
Pushed by bellaperez into branch 'master'.

More documentation updates

* keywords: Capitalize app name
* Punctuation and GUI sync

M  +11   -12   doc/index.docbook

https://invent.kde.org/games/picmi/commit/ee9b359490ecb238a481df2ab9f60c42db03384f

diff --git a/doc/index.docbook b/doc/index.docbook
index 975b9be..3ae7ce4 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -37,7 +37,7 @@
 <keyword>kdegames</keyword>
 <keyword>game</keyword>
 <keyword>puzzle game</keyword>
-<keyword>picmi</keyword>
+<keyword>Picmi</keyword>
 </keywordset>
 </bookinfo>
 
@@ -60,7 +60,7 @@
 </screenshot>
 
 <para>
-The object of the game is to color cells according to numbers given at the side of the board.
+The goal of the game is to color cells according to numbers given at the side of the board.
 </para>
 </chapter>
 
@@ -81,8 +81,7 @@ The current placement of boxes and crosses (referred to as 'states' from now on)
 
 <para>
 &picmi; includes two game modes.
-Random puzzles (generated by selecting <guilabel>New</guilabel> from the menu) are generated according to the selected difficulty settings.
-Alternatively, the included preset puzzles can be played by selecting <guilabel>Load</guilabel>.
+Random puzzles (generated by selecting the <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut> <guimenu>Game</guimenu> <guimenuitem>New</guimenuitem></menuchoice> menu item) are generated according to the selected difficulty settings. Alternatively, the included preset puzzles can be played by selecting the <menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></shortcut> <guimenu>Game</guimenu> <guimenuitem>Load...</guimenuitem></menuchoice> menu item.
 </para>
 
 </chapter>
@@ -96,8 +95,8 @@ Alternatively, the included preset puzzles can be played by selecting <guilabel>
 <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>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> option 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>
@@ -142,7 +141,7 @@ Alternatively, the included preset puzzles can be played by selecting <guilabel>
   <varlistentry>
     <term><menuchoice><shortcut><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo> </shortcut>
     <guimenu>Game</guimenu>
-    <guimenuitem>Show High Scores</guimenuitem></menuchoice></term>
+    <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>
 
@@ -150,7 +149,7 @@ Alternatively, the included preset puzzles can be played by selecting <guilabel>
     <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>
+    <listitem><para><action>Quits</action> the &picmi;.</para></listitem>
   </varlistentry>
 
   <varlistentry>
@@ -200,9 +199,9 @@ Alternatively, the included preset puzzles can be played by selecting <guilabel>
     <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>Easy</guimenuitem>: 10 rows, 10 columns, 55% of all cells are occupied, <guilabel>Prevent mistakes:</guilabel> option is disabled.</para></listitem>
+        <listitem><para><guimenuitem>Medium</guimenuitem>: 10 rows, 15 columns, 55% of all cells are occupied, <guilabel>Prevent mistakes:</guilabel> option is disabled.</para></listitem>
+        <listitem><para><guimenuitem>Hard</guimenuitem>: 15 rows, 15 columns, 55% of all cells are occupied, <guilabel>Prevent mistakes:</guilabel> option is disabled.</para></listitem>
         <listitem><para><guimenuitem>Custom</guimenuitem>: Custom board dimensions and settings.</para></listitem>
       </itemizedlist>
     </para></listitem>
@@ -261,7 +260,7 @@ of the &kde; Fundamentals.
         <entry><keycap>F1</keycap></entry>
       </row>
       <row>
-        <entry>What's this?</entry>
+        <entry>What's this? help</entry>
         <entry><keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo></entry>
       </row>
     </tbody>


More information about the kde-doc-english mailing list