GNOME.org
 

[gnome-games] sudoku: Added additional documentation

commit 7ac98b5819131649a0bbd473c38ca6715d38cf0b
Author: Chris Beiser <ctbeiser gmail com>
Date:   Sun Nov 27 14:19:32 2011 -0500

    sudoku: Added additional documentation
    
    Wrote documentation for the pages Basics, Keyboard Shortcuts, Toolbar, Notes. Added additional documentation derived from the manual to Intro, rules. Permission has been gotten from the author to license the manual under CC-BY-SA 3.0. Other pages have been edited to change references to 'squares' to 'cells' for clarity.

 gnome-sudoku/help/C/basics.page             |   53 +++++++++++++++--
 gnome-sudoku/help/C/gnome-sudoku.xml        |   18 +++---
 gnome-sudoku/help/C/hints.page              |    8 +-
 gnome-sudoku/help/C/intro.page              |   11 +--
 gnome-sudoku/help/C/keyboard-shortcuts.page |   83 +++++++++++++++++++++++++-
 gnome-sudoku/help/C/notes.page              |   21 +++++--
 gnome-sudoku/help/C/rules.page              |    7 +-
 gnome-sudoku/help/C/statistics.page         |    6 +-
 gnome-sudoku/help/C/toolbar.page            |    6 +-
 9 files changed, 167 insertions(+), 46 deletions(-)
---
diff --git a/gnome-sudoku/help/C/basics.page b/gnome-sudoku/help/C/basics.page
index fee4994..197e7d1 100644
--- a/gnome-sudoku/help/C/basics.page
+++ b/gnome-sudoku/help/C/basics.page
@@ -7,25 +7,64 @@
     
     <revision pkgversion="3.4" version="0.1" date="2011-11-06" status="stub"/>
     <credit type="author">
-      <name>Tiffany Antopolski</name>
-      <email>tiffany antopolski gmail com</email>
+      <name>Chris Beiser</name>
+      <email>ctbeiser gmail com</email>
     </credit>
     <license>
       <p>Creative Commons Share Alike 3.0</p>
     </license>
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
   </info>
-
+<comment>There's some things in the manual that are better written than some of this, but we still need to get permission from the copyright holder.</comment>
 <title>Basics</title>
-    
+<p>Sudoku can be played using the keyboard, the mouse, or any combination of the two.</p>
 <section id="mouse">
 <title>Using the mouse</title>
-<p></p>
+<list>
+	<item><p>To select a cell, move your mouse over it and click.</p></item>
+	<item><p>To put a number in a selected cell, click on the center of the cell, and then click on the number you wish to input.</p></item>
+	<item><p>To remove a number from a selected cell, click in the center of the cell and then click clear.</p></item>
+	<!--item><p>To add a note to a cell:</p>
+		<list type="numbered">
+			<item><p>Select it.</p></item>
+			<item><p>Click on the top or bottom of the cell.</p></item>
+			<item><p>Type the the note with the keyboard.</p></item>
+			<item><p>Click anywhere outside the text box.</p></item>
+		</list>
+	</item>
+	<item><p>To remove notes from a cell:</p>
+		<list type="numbered">
+			<item><p>Select it.</p></item>
+			<item><p>Click on the notes.</p></item>
+			<item><p>Press the <key>Backspace</key> key on your keyboard.</p></item>
+			<item><p>Click anywhere outside of the text box.</p></item>
+		</list>
+	</item-->
+</list>
 </section>
 
 <section id="keyboard">
 <title>Using the keyboard</title>
-<p></p>
+<list>
+	<item><p>To select a cell, use the arrow keys to move the blue outline onto it.</p></item>
+	<item><p>To put a number in a cell, select the cell, and then press the number.</p></item>
+	<item><p>To remove a number from a cell, select the cell, and then press <key>0</key>.</p></item>
+	<!--item><p>To add notes to a cell:</p>
+		<list type="numbered">
+			<item><p>Select it.</p></item>
+			<item><p>Press <key>n</key> to add notes to the top of a cell, or <key>m</key> for the bottom.</p></item>
+			<item><p>Type your notes.</p></item>
+			<item><p>Press <key>Enter</key>.</p></item>
+		</list>
+	</item>
+	<item><p>To remove notes from a cell:</p>
+		<list type="numbered">
+			<item><p>Select it.</p></item>
+			<item><p>Press <key>n</key> to remove notes from the top of a cell, or <key>m</key> to remove notes from the bottom.</p></item>
+			<item><p>Press <key>Backspace</key>.</p></item>
+			<item><p>Press <key>Enter</key>.</p></item>
+		</list>
+	</item-->
+</list>
 </section>
-
 </page>
diff --git a/gnome-sudoku/help/C/gnome-sudoku.xml b/gnome-sudoku/help/C/gnome-sudoku.xml
index 9b9ba15..78edd58 100644
--- a/gnome-sudoku/help/C/gnome-sudoku.xml
+++ b/gnome-sudoku/help/C/gnome-sudoku.xml
@@ -148,10 +148,10 @@
     <para>
 
         The rules of Sudoku are quite simple. In order to complete the
-        puzzle, you must fill each square with a number between 1 and
+        puzzle, you must fill each cell with a number between 1 and
         9 such that every row, column and 3x3 box on the board
         contains the numbers 1 through 9.  Stated another way, you
-        must fill each square such that no number appears twice in the
+        must fill each cell such that no number appears twice in the
         same row, column, or 3x3 box.
 	
     </para>
@@ -161,7 +161,7 @@
     the principle ways players think as they play. On the one hand,
     you ask yourself, âHow can I fit all the numbers in this
     box?â On the other hand, you ask yourself, âWhat
-    numbers can fit in this square without causing a conflict with
+    numbers can fit in this cell without causing a conflict with
     other numbers in the same row, column, or 3x3 box?â
 
     </para>
@@ -264,22 +264,22 @@
     </sect1>
     <sect1 id="myapp-basic-play">
     <title>Basic game play</title>
-    <para>To play the game, start filling numbers 1-9 in the squares such that no row, column, or 3x3 box has any number more than one time.</para>
-    <para>You can fill a number in a square with the keyboard or the mouse.</para>
+    <para>To play the game, start filling numbers 1-9 in the cells such that no row, column, or 3x3 box has any number more than one time.</para>
+    <para>You can fill a number in a cell with the keyboard or the mouse.</para>
     <variablelist>
     	<varlistentry>
 	<term>Keyboard</term>
-	<listitem><para>Use the arrow keys or the mouse to select the square you would like to fill. Then type the number you want to put in the square. Typing <keycap>Backspace</keycap> will remove the number.</para></listitem>
+	<listitem><para>Use the arrow keys or the mouse to select the cell you would like to fill. Then type the number you want to put in the cell. Typing <keycap>Backspace</keycap> will remove the number.</para></listitem>
 	</varlistentry>
 	<varlistentry>
 	<term>Mouse</term>
 	<listitem>
 	  <para>
 
-	  Click on a square to select it, then click in the center of
-	  the square to bring up buttons with the numbers 1-9.  Click
+	  Click on a cell to select it, then click in the center of
+	  the cell to bring up buttons with the numbers 1-9.  Click
 	  on a number to select it, or click on
-	  <guibutton>clear</guibutton> to clear the square. You can
+	  <guibutton>clear</guibutton> to clear the cell. You can
 	  also double-click in the center of a square to bring up the
 	  number buttons.
 	  
diff --git a/gnome-sudoku/help/C/hints.page b/gnome-sudoku/help/C/hints.page
index 5503dc4..b4f9c82 100644
--- a/gnome-sudoku/help/C/hints.page
+++ b/gnome-sudoku/help/C/hints.page
@@ -19,13 +19,13 @@
 <title>Hints</title>
 <media type="image" src="figures/possible-numbers.png" width="500" style="floatleft"/>
   <p>
-  To show possible values for all squares click:
+  To show possible values for all cells click:
   </p>
  <p>
  <guiseq><gui>Settings</gui><gui>Show Possible Numbers</gui></guiseq>. 
    </p>
   <p>
-You can edit the possible numbers by clicking in the bottom of the square.
+You can edit the possible numbers by clicking in the bottom of the cell.
   </p>
 <p>
 This feature works based on the logical possibilities given the current board. It does not work by looking at the solution. This means that if you made an error in an earlier move, this feature may show incorrect possible values. 
@@ -33,7 +33,7 @@ This feature works based on the logical possibilities given the current board. I
 
 <section>
    <p>
-   To ask Sudoku to show a square that is easy to fill:
+   To ask Sudoku to show a cell that is easy to fill:
   </p>
  <list>
   <item><p>
@@ -41,7 +41,7 @@ This feature works based on the logical possibilities given the current board. I
  </p></item>
  </list>
  
- <p> A square which usually has only one possible solution based on the current state of the board is outlined with flashing red.  In the case of a puzzle that has no squares that have only one possible solution, a square with two possible solutions or the least amount of possible solutions will be highlighted. Clicking <gui>Hint</gui> multiple times may not always point you to the same square.
+ <p> A cell which usually has only one possible solution based on the current state of the board is outlined with flashing red.  In the case of a puzzle that has no cells that have only one possible solution, a cell with two possible solutions or the least amount of possible solutions will be highlighted. Clicking <gui>Hint</gui> multiple times may not always point you to the same cell.
    </p>
  <note style="tip">
   <p>
diff --git a/gnome-sudoku/help/C/intro.page b/gnome-sudoku/help/C/intro.page
index 83239fb..9e9f42f 100644
--- a/gnome-sudoku/help/C/intro.page
+++ b/gnome-sudoku/help/C/intro.page
@@ -1,23 +1,20 @@
 <page xmlns="http://projectmallard.org/1.0/";
 	type="topic" style="task"
-	id="intro">
+	id="intro"> <!-- This content might be better off at the top of index.page?-->
 
   <info>
    <link type="guide" xref="index"/>
     
     <revision pkgversion="3.4" version="0.1" date="2011-11-06" status="stub"/>
     <credit type="author">
-      <name>Tiffany Antopolski</name>
-      <email>tiffany antopolski gmail com</email>
+      <name>Thomas Hinkle</name>
+      <email>tmhinkle gmail com</email>
     </credit>
     <license>
       <p>Creative Commons Share Alike 3.0</p>
     </license>
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
   </info>
-
 <title>Introduction</title>
-    
-
-
+<p>Gnome Sudoku is an application to generate and play games of Sudoku, a popular number-based logic puzzle.</p>
 </page>
diff --git a/gnome-sudoku/help/C/keyboard-shortcuts.page b/gnome-sudoku/help/C/keyboard-shortcuts.page
index 0b5d529..22cf1f8 100644
--- a/gnome-sudoku/help/C/keyboard-shortcuts.page
+++ b/gnome-sudoku/help/C/keyboard-shortcuts.page
@@ -4,11 +4,10 @@
 
   <info>
    <link type="guide" xref="index#advanced"/>
-    
     <revision pkgversion="3.4" version="0.1" date="2011-11-12" status="stub"/>
     <credit type="author">
-      <name>Tiffany Antopolski</name>
-      <email>tiffany antopolski gmail com</email>
+      <name>Chris Beiser</name>
+      <email>ctbeiser gmail com</email>
     </credit>
     <license>
       <p>Creative Commons Share Alike 3.0</p>
@@ -17,7 +16,83 @@
   </info>
 
 <title>Keyboard shortcuts</title>
-    
+<p> This is a list of the keyboard shortcuts you can use in Sudoku. </p>
 
+<!--page xmlns="http://projectmallard.org/1.0/";
+type="topic" style="task"
+id="keyboard-shortcuts"-->
 
+<section id="starting-restarting">
+	<title>Starting and exiting</title>	
+<comment>Is there a word that encapsulates both starting AND restarting? Didn't include restarting here for the sake of brevity - Chris</comment>
+	<table frame="all" rules="cols" shade="rows">
+		<tr>
+			<td><p>New game</p></td>
+			<td><p><keyseq><key>Ctrl</key><key>N</key></keyseq></p></td>
+		</tr>
+		<tr>
+			<td><p>Reset game</p></td>
+			<td><p><keyseq><key>Ctrl</key><key>B</key></keyseq></p></td>
+		</tr>
+		<tr>
+			<td><p>Close the sudoku window</p></td>
+			<td><p><keyseq><key>Ctrl</key><key>W</key></keyseq></p></td>
+		</tr>
+	</table>
+</section>
+<section id="helpers">
+	<title>Hints and Notes</title>
+	<table frame="all" rules="cols" shade="rows">
+		<tr>
+			<td><p>Hint</p></td>
+			<td><p><keyseq><key>Ctrl</key><key>H</key></keyseq></p></td>
+		</tr>
+		<tr>
+			<td><p>Track Additions</p></td>
+			<td><p><keyseq><key>Ctrl</key><key>T</key></keyseq></p></td>
+		</tr>
+		<tr>
+			<td><p>Clear notes from the top of a cell</p></td>
+			<td><p><keyseq><key>Ctrl</key><key>J</key></keyseq></p></td>
+		</tr>
+		<tr>
+			<td><p>Clear notes from the bottom of a cell</p></td>
+			<td><p><keyseq><key>Ctrl</key><key>K</key></keyseq></p></td>
+		</tr>
+		<tr>
+			<td><p>Add a number to the top notes of a cell</p></td>
+			<td><p><keyseq><key>Ctrl</key><key>#</key></keyseq></p></td>
+		</tr>
+		<tr>
+			<td><p>Remove a number to the top notes of a cell</p></td>
+			<td><p><keyseq><key>Alt</key><key>#</key></keyseq></p></td>
+		</tr>
+	</table>
+</section>
+<section id="other">
+	<title>Other</title>
+	<table frame="all" rules="cols" shade="rows">
+		<tr>
+			<td><p>Print displayed puzzle</p></td>
+			<td><p><keyseq><key>Ctrl</key><key>P</key></keyseq></p></td>
+		</tr>
+		<tr>
+			<td><p>Undo</p></td>
+			<td><p><keyseq><key>Ctrl</key><key>Z</key></keyseq></p></td>
+		</tr>
+		<tr>
+			<td><p>Redo</p></td>
+			<td><p><keyseq><key>Ctrl</key><key>Shift</key><key>Z</key></keyseq></p></td>
+		</tr>
+		<tr>
+			<td><p>Open Help</p></td>
+			<td><p><key>F1</key></p></td>
+		</tr>
+		<tr>
+			<td><p>Switch to fullscreen mode</p></td>
+			<td><p><key>F11</key></p></td>
+		</tr>
+	</table>
+</section>
+<!--/page-->
 </page>
diff --git a/gnome-sudoku/help/C/notes.page b/gnome-sudoku/help/C/notes.page
index 2c06a50..dc573d5 100644
--- a/gnome-sudoku/help/C/notes.page
+++ b/gnome-sudoku/help/C/notes.page
@@ -7,9 +7,13 @@
     
     <revision pkgversion="3.4" version="0.1" date="2011-11-06" status="stub"/>
     <credit type="author">
-      <name>Tiffany Antopolski</name>
-      <email>tiffany antopolski gmail com</email>
+      <name>Chris Beiser</name>
+      <email>ctbeiser gmail com</email>
     </credit>
+	<credit type="author">
+	  <name>Thomas Hinkle</name>
+	  <email>tmhinkle gmail com</email>
+	</credit>
     <license>
       <p>Creative Commons Share Alike 3.0</p>
     </license>
@@ -17,7 +21,14 @@
   </info>
 
 <title>Notes</title>
-    
-
-
+<p>Notes, or pencilmarks, can be added to any cell. They allow you to mark possible values for a cell, or store other data that might help you. Notes will store all characters in order, but will remove repetitions of characters.</p> <comment>Other wordings I considered were 'repeated instances of characters', but I wanted to communicate it would leave the first one. If you can come up with something better, by all means, change it.</comment>
+<p>To add notes to a cell:</p>
+<steps>
+	<item><p>Select the cell</p></item>
+	<item><p>Click on the part of a cell that is above the line that appears when you hover over it. Alternatively, type <key>N</key>.</p></item>
+	<item><p>Type your notes</p></item>
+	<item><p>Press <key>Enter</key> or click outside of the text box.</p></item>
+</steps>
+<note><p>You can also take notes in the bottom of the cell by clicking in the bottom of the cell or by typing <key>M</key>. However, this area is used when you click <link xref="hints">Show All Possible Numbers</link>. If you plan to use this area, you should not use Show All Possible Numbers.</p></note>
+<note><p>You can add a number to the notes at the top of the square by typing <keyseq><key>Ctrl</key><key>1</key></keyseq> through <keyseq><key>Ctrl</key><key>9</key></keyseq></p></note>
 </page>
diff --git a/gnome-sudoku/help/C/rules.page b/gnome-sudoku/help/C/rules.page
index 1897fee..242d3b5 100644
--- a/gnome-sudoku/help/C/rules.page
+++ b/gnome-sudoku/help/C/rules.page
@@ -7,8 +7,8 @@
     
     <revision pkgversion="3.4" version="0.1" date="2011-11-06" status="stub"/>
     <credit type="author">
-      <name>Tiffany Antopolski</name>
-      <email>tiffany antopolski gmail com</email>
+      <name>Thomas Hinkle</name>
+      <email>tmhinkle gmail com</email>
     </credit>
     <license>
       <p>Creative Commons Share Alike 3.0</p>
@@ -17,7 +17,6 @@
   </info>
 
 <title>Game rules</title>
-    
-
+<p>The rules of Sudoku are quite simple. In order to complete the puzzle, you must fill each square with a number between 1 and 9 such that every row, column and 3x3 box on the board contains the numbers 1 through 9. In a solved sudoku, each cell is filled such that no number appears twice in the same row, column, or 3x3 box. Each puzzle has only one solution</p>
 
 </page>
diff --git a/gnome-sudoku/help/C/statistics.page b/gnome-sudoku/help/C/statistics.page
index 3d0a2ed..44fc73a 100644
--- a/gnome-sudoku/help/C/statistics.page
+++ b/gnome-sudoku/help/C/statistics.page
@@ -28,15 +28,15 @@
 
 <section>
 <p>
-<app>GNOME Sudoku</app> ranks puzzles based on the number of squares that can be rapidly filled. 
+<app>GNOME Sudoku</app> ranks puzzles based on the number of cells that can be rapidly filled. 
 </p>
 <p>
 The puzzle statistics box shows:
 </p>
 <list>
  <item><p>the overall difficulty</p></item>
- <item><p>the number of squares which can be filled by elimination, starting from the blank grid (i.e. only a 2 can go in this box, so it must be a 2)</p></item>
-  <item><p>the number of squares that can be filled by the process of filling, starting from the blank grid (i.e. only one square in this row can be a 2, so it must be a 2)</p></item>
+ <item><p>the number of cells which can be filled by elimination, starting from the blank grid (i.e. only a 2 can go in this box, so it must be a 2)</p></item>
+  <item><p>the number of cells that can be filled by the process of filling, starting from the blank grid (i.e. only one cell in this row can be a 2, so it must be a 2)</p></item>
   <item><p>the number of times in solving the puzzle that the program used the trial-and-error algorithm to solve the puzzle</p></item>
 </list>
 <note>
diff --git a/gnome-sudoku/help/C/toolbar.page b/gnome-sudoku/help/C/toolbar.page
index 1235414..ea68f46 100644
--- a/gnome-sudoku/help/C/toolbar.page
+++ b/gnome-sudoku/help/C/toolbar.page
@@ -7,8 +7,8 @@
     
     <revision pkgversion="3.4" version="0.1" date="2011-11-13" status="stub"/>
     <credit type="author">
-      <name>Tiffany Antopolski</name>
-      <email>tiffany antopolski gmail com</email>
+      <name>Chris Beiser</name>
+      <email>ctbeiser gmail com</email>
     </credit>
     <license>
       <p>Creative Commons Share Alike 3.0</p>
@@ -17,7 +17,7 @@
   </info>
 
 <title>Toolbar</title>
-    
+<p>The toolbar, located under the menu bar, lets you perform common actions with your mouse. To use a toolbar item, just click on it. The buttons, from left to right, are New Game, Undo, Redo, <link xref="hints">Hint</link>, and <link xref="trackers">Track Additions</link>.</p> <comment>The just might violate the neutral-voice, but it seems to emphasize that there's no other steps. - Chris Beiser.</comment>
 
 
 </page>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]