GNOME.org
 

[gnome-games] Six topic pages completed.

commit 43f94cb327a8ae4ad58ef9b6aa1878e7f5c45e8e
Author: Tiffany Antopolski <tiffany antopolski gmail com>
Date:   Sun Nov 13 20:04:17 2011 -0500

    Six topic pages completed.
    
    topics completed are printing(2), hints, stats, trackers (with video demonstration)
    and topic about filing bugs.

 gnome-sudoku/help/C/basics.page                    |    8 +++
 gnome-sudoku/help/C/bug-filing.page                |   43 ++++++++++++++
 gnome-sudoku/help/C/figures/possible-numbers.png   |  Bin 0 -> 65626 bytes
 gnome-sudoku/help/C/figures/stats-very-hard.png    |  Bin 0 -> 28325 bytes
 gnome-sudoku/help/C/figures/trackers.webm          |  Bin 0 -> 551440 bytes
 gnome-sudoku/help/C/highlighting.page              |    2 +-
 gnome-sudoku/help/C/hints.page                     |   37 +++++++++++-
 gnome-sudoku/help/C/index.page                     |    4 +
 .../help/C/{bugs.page => keyboard-shortcuts.page}  |    8 +-
 gnome-sudoku/help/C/notes.page                     |    2 +-
 gnome-sudoku/help/C/print-blank-puzzles.page       |   15 +++++-
 gnome-sudoku/help/C/print-book.page                |   23 --------
 gnome-sudoku/help/C/print-inprogress-game.page     |   41 ++++++++++++++
 gnome-sudoku/help/C/statistics.page                |   32 ++++++++++-
 .../help/C/{autofill.page => toolbar.page}         |    8 +-
 gnome-sudoku/help/C/trackers.page                  |   59 ++++++++++++++++++-
 16 files changed, 237 insertions(+), 45 deletions(-)
---
diff --git a/gnome-sudoku/help/C/basics.page b/gnome-sudoku/help/C/basics.page
index 76463d3..fee4994 100644
--- a/gnome-sudoku/help/C/basics.page
+++ b/gnome-sudoku/help/C/basics.page
@@ -18,6 +18,14 @@
 
 <title>Basics</title>
     
+<section id="mouse">
+<title>Using the mouse</title>
+<p></p>
+</section>
 
+<section id="keyboard">
+<title>Using the keyboard</title>
+<p></p>
+</section>
 
 </page>
diff --git a/gnome-sudoku/help/C/bug-filing.page b/gnome-sudoku/help/C/bug-filing.page
new file mode 100644
index 0000000..3949bb7
--- /dev/null
+++ b/gnome-sudoku/help/C/bug-filing.page
@@ -0,0 +1,43 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="bug-filing">
+
+  <info>
+    <link type="guide" xref="index#get-involved"/>
+    <desc>How and where to report problems.</desc>
+
+    <revision pkgversion="3.4" version="0.1" date="2011-11-12" status="stub"/>
+    <credit type="author">
+      <name>Tiffany Antopolski</name>
+      <email>tiffany antopolski com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+<title>Report a Problem</title>
+<p>
+   <app>GNOME Sudoku</app> is maintained by a volunteer community. You are welcome to participate.  If you notice a problem you can file a <em>bug report</em>. To file a bug, go to <link href = "https://bugzilla.gnome.org/"/>.
+   </p>
+   <p>
+   This is a bug tracking system where users and developers can file details about bugs, crashes and request enhancements.  
+   </p>
+   <p>
+   To participate you need an account which will give you the ability to gain access, file bugs, and make comments.  Also, you need to register so you can receive updates by e-mail about the status of your bug. If you don't already have an account, just click on the <gui>New Account</gui> link to create one.
+   </p>
+   <p>
+   Once you have an account, log in, click on <guiseq><gui>File a Bug</gui><gui>Applications</gui><gui>gnome-games</gui></guiseq>.
+   Before reporting a bug, please read the <link href = "https://bugzilla.gnome.org/page.cgi?id=bug-writing.html";>bug writing guidelines</link>,  and please <link href="https://bugzilla.gnome.org/browse.cgi?product=evince";>browse</link> for the bug to see if it already exists.
+   </p>
+   <p>
+   To file your bug, choose the component <gui>gnome-sudoku</gui> in the <gui>Component</gui> menu. 
+   </p>
+   <p>
+   If you are requesting a new feature, choose <gui>enhancement</gui> in the <gui>Severity</gui> menu.
+   Fill in the Summary and Description sections and click <gui>Commit</gui>.
+   </p>
+   <p>
+      Your report will be given an ID number, and its status will be updated as it is being dealt with.
+   </p>
+</page>
diff --git a/gnome-sudoku/help/C/figures/possible-numbers.png b/gnome-sudoku/help/C/figures/possible-numbers.png
new file mode 100644
index 0000000..db3722d
Binary files /dev/null and b/gnome-sudoku/help/C/figures/possible-numbers.png differ
diff --git a/gnome-sudoku/help/C/figures/stats-very-hard.png b/gnome-sudoku/help/C/figures/stats-very-hard.png
new file mode 100644
index 0000000..e491b3c
Binary files /dev/null and b/gnome-sudoku/help/C/figures/stats-very-hard.png differ
diff --git a/gnome-sudoku/help/C/figures/trackers.webm b/gnome-sudoku/help/C/figures/trackers.webm
new file mode 100644
index 0000000..0289661
Binary files /dev/null and b/gnome-sudoku/help/C/figures/trackers.webm differ
diff --git a/gnome-sudoku/help/C/highlighting.page b/gnome-sudoku/help/C/highlighting.page
index 704c7d2..860f9f3 100644
--- a/gnome-sudoku/help/C/highlighting.page
+++ b/gnome-sudoku/help/C/highlighting.page
@@ -3,7 +3,7 @@
 	id="highlighting">
 
   <info>
-   <link type="guide" xref="index#play"/>
+   <link type="guide" xref="index#tips"/>
     
     <revision pkgversion="3.4" version="0.1" date="2011-11-06" status="stub"/>
     <credit type="author">
diff --git a/gnome-sudoku/help/C/hints.page b/gnome-sudoku/help/C/hints.page
index a2684e0..65d4f78 100644
--- a/gnome-sudoku/help/C/hints.page
+++ b/gnome-sudoku/help/C/hints.page
@@ -3,9 +3,9 @@
 	id="hints">
 
   <info>
-   <link type="guide" xref="index#play"/>
+   <link type="guide" xref="index#tips"/>
     
-    <revision pkgversion="3.4" version="0.1" date="2011-11-06" status="stub"/>
+    <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>
@@ -17,7 +17,36 @@
   </info>
 
 <title>Hints</title>
-    
-
+<media type="image" src="figures/possible-numbers.png" width="500" style="floatleft"/>
+  <p>
+  To show possible values for all squares 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.
+  </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. 
+   </p> 
 
+<section>
+   <p>
+   To ask Sudoku to show a square that is easy to fill:
+  </p>
+ <list>
+  <item><p>
+   Click <guiseq><gui>Tools</gui><gui>Hint</gui></guiseq>, or <gui>Hint</gui> in the <link xref="toolbar">toolbar</link>.
+ </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>
+ <note style="tip">
+  <p>
+These features can make easy puzzles too easy, so you should use this mode sparingly.
+  </p>
+</note>
+</section>
 </page>
diff --git a/gnome-sudoku/help/C/index.page b/gnome-sudoku/help/C/index.page
index 374e9dd..300ba44 100644
--- a/gnome-sudoku/help/C/index.page
+++ b/gnome-sudoku/help/C/index.page
@@ -24,6 +24,10 @@
     <title>Game Play</title>
    </section>
 
+   <section id="tips" style="2column">
+    <title>Useful tips</title>
+   </section>
+
    <section id="print" style="2column">
     <title>Printing</title>
    </section>
diff --git a/gnome-sudoku/help/C/bugs.page b/gnome-sudoku/help/C/keyboard-shortcuts.page
similarity index 70%
rename from gnome-sudoku/help/C/bugs.page
rename to gnome-sudoku/help/C/keyboard-shortcuts.page
index fe162a5..0b5d529 100644
--- a/gnome-sudoku/help/C/bugs.page
+++ b/gnome-sudoku/help/C/keyboard-shortcuts.page
@@ -1,11 +1,11 @@
 <page xmlns="http://projectmallard.org/1.0/";
 	type="topic" style="task"
-	id="bugs">
+	id="keyboard-shortcuts">
 
   <info>
-   <link type="guide" xref="index#get-involved"/>
+   <link type="guide" xref="index#advanced"/>
     
-    <revision pkgversion="3.4" version="0.1" date="2011-11-06" status="stub"/>
+    <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>
@@ -16,7 +16,7 @@
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
   </info>
 
-<title>Report a problem</title>
+<title>Keyboard shortcuts</title>
     
 
 
diff --git a/gnome-sudoku/help/C/notes.page b/gnome-sudoku/help/C/notes.page
index b114ab2..2c06a50 100644
--- a/gnome-sudoku/help/C/notes.page
+++ b/gnome-sudoku/help/C/notes.page
@@ -3,7 +3,7 @@
 	id="notes">
 
   <info>
-   <link type="guide" xref="index#play"/>
+   <link type="guide" xref="index#tips"/>
     
     <revision pkgversion="3.4" version="0.1" date="2011-11-06" status="stub"/>
     <credit type="author">
diff --git a/gnome-sudoku/help/C/print-blank-puzzles.page b/gnome-sudoku/help/C/print-blank-puzzles.page
index cbf7473..c0abe73 100644
--- a/gnome-sudoku/help/C/print-blank-puzzles.page
+++ b/gnome-sudoku/help/C/print-blank-puzzles.page
@@ -16,8 +16,21 @@
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
   </info>
 
-<title>Print blank puzzles</title>
+<title>Print blank sudokus</title>
     
+<p>
+To print one or more blank puzzles:
+</p>
+
+ <steps>
+ <item><p>Click <guiseq><gui>Game</gui><gui>Print multiple sudokus</gui></guiseq>.</p>
+</item>
+ <item><p>Select total number of sudokus to print from the drop down menu.</p></item>
+ <item><p>Select the number of sudokus per page from the next drop down menu.</p></item>
+ <item><p>Select difficult level of the games you would like to print.</p></item>
+ <item><p>Games that have already been played are not printed by default.  If you don't care about repeating games, select <gui>Include games you've already played in list of games to print.</gui> in the <gui>Details</gui> category.</p></item>
+ <item><p>Games that are printed are not marked as played by default.  You can choose to <gui>Mark games as played once you've printed them.</gui> under the <gui>Details</gui> category.</p></item>
+ </steps>
 
 
 </page>
diff --git a/gnome-sudoku/help/C/print-inprogress-game.page b/gnome-sudoku/help/C/print-inprogress-game.page
new file mode 100644
index 0000000..859a11e
--- /dev/null
+++ b/gnome-sudoku/help/C/print-inprogress-game.page
@@ -0,0 +1,41 @@
+<page xmlns="http://projectmallard.org/1.0/";
+	type="topic" style="task"
+	id="print-inprogress-game">
+
+  <info>
+   <link type="guide" xref="index#print"/>
+    
+    <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>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+  </info>
+
+<title>Print your game</title>
+ <p>
+  You can print the sudoku are playing to a file or to a printer. 
+ </p>
+ <p>
+  To print the sudoku you are currently playing:
+ </p>
+ <steps>
+  <item><p>
+    Click <guiseq><gui>Game</gui><gui>Print</gui></guiseq>. 
+  </p></item>
+  <item><p>
+    Select your printer.
+ </p></item>
+  <item><p>
+     Click <gui>Print</gui>.
+  </p></item>
+ </steps>
+ <note><p>
+   If you don't have a printer in the list, see <link href="help:gnome-help/printing-setup">Set up a local printer</link>.
+  </p></note>
+
+</page>
diff --git a/gnome-sudoku/help/C/statistics.page b/gnome-sudoku/help/C/statistics.page
index d3a0b9f..69e1134 100644
--- a/gnome-sudoku/help/C/statistics.page
+++ b/gnome-sudoku/help/C/statistics.page
@@ -3,7 +3,7 @@
 	id="statistics">
 
   <info>
-   <link type="guide" xref="index#advanced"/>
+   <link type="guide" xref="index#tips"/>
     
     <revision pkgversion="3.4" version="0.1" date="2011-11-06" status="stub"/>
     <credit type="author">
@@ -17,7 +17,33 @@
   </info>
 
 <title>Statistics</title>
-    
-
+<p>To view the statistics about the current puzzle, click <guiseq><gui>Game</gui><gui>Puzzle Statistics</gui></guiseq>.
+</p>
+  <figure>
+            <desc>Very hard puzzle statistics box example</desc>
+            <media type="image" mime="image/png"
+            src="figures/stats-very-hard.png" width="400" >
+            </media>
+      </figure>
 
+<section>
+<p>
+<app>GNOME Sudoku</app> ranks puzzles based on the number of squares 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 only one square 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>
+<p>
+All sudoku puzzles can be solved without ever having to guess. 
+When the statistics box says that Sudoku used trial-and-error X number of times, it does not mean that a human would have to use trial-and-error to solve the puzzle.
+</p>
+</note>
+</section>
 </page>
diff --git a/gnome-sudoku/help/C/autofill.page b/gnome-sudoku/help/C/toolbar.page
similarity index 73%
rename from gnome-sudoku/help/C/autofill.page
rename to gnome-sudoku/help/C/toolbar.page
index a3ee6ef..1235414 100644
--- a/gnome-sudoku/help/C/autofill.page
+++ b/gnome-sudoku/help/C/toolbar.page
@@ -1,11 +1,11 @@
 <page xmlns="http://projectmallard.org/1.0/";
 	type="topic" style="task"
-	id="autofill">
+	id="toolbar">
 
   <info>
-   <link type="guide" xref="index#play"/>
+   <link type="guide" xref="index#tips"/>
     
-    <revision pkgversion="3.4" version="0.1" date="2011-11-06" status="stub"/>
+    <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>
@@ -16,7 +16,7 @@
     <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
   </info>
 
-<title>Autofill</title>
+<title>Toolbar</title>
     
 
 
diff --git a/gnome-sudoku/help/C/trackers.page b/gnome-sudoku/help/C/trackers.page
index 536f420..89d3536 100644
--- a/gnome-sudoku/help/C/trackers.page
+++ b/gnome-sudoku/help/C/trackers.page
@@ -3,9 +3,9 @@
 	id="trackers">
 
   <info>
-   <link type="guide" xref="index#play"/>
-    
-    <revision pkgversion="3.4" version="0.1" date="2011-11-06" status="stub"/>
+   <link type="guide" xref="index#tips"/>
+   <desc>Keep track of trial-and-error solutions</desc> 
+    <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>
@@ -17,7 +17,58 @@
   </info>
 
 <title>Trackers</title>
-    
+ <p>
+Trackers can be used to keep track of trial-and-error solutions. Tracked moves are entered in a different color to help make the moves visually distinct from moves made earlier in the game. This feature is particulartly useful when solving difficult games. 
+  </p>
+<p>
+  You can toggle the tracker interface in one of the following ways:
+</p>
+<list>
+<item><p>Click <guiseq><gui>Tools</gui><gui>Track Additions</gui></guiseq>.</p></item>
+<item><p>Click <gui>Track Additions</gui> in the toolbar. If the toolbar is not visible, click <guiseq><gui>Settings</gui><gui>Show Toolbar</gui></guiseq>.</p></item>
+</list>
+ <note>
+  <p>Some sudoku players believe you should never use trial-and-error to solve a puzzle. These players should not use this feature.</p>
+ </note>
+ <section id="demo">
+  <title>Video Demonstration</title>
 
+  <media type="video" width="650" mime="application/ogg" src="figures/trackers.webm">
+ <tt:tt xmlns:tt="http://www.w3.org/ns/ttml";>
+        <tt:body>
+          <tt:div begin="1s" end="5s">
+            <tt:p>
+              Click <guiseq><gui>Tools</gui><gui>Track Additions</gui></guiseq>.
+            </tt:p>
+          </tt:div>
+          <tt:div begin="5s" end="8s">
+            <tt:p>
+             You can make untracked moves if no tracker is selected.
+            </tt:p>
+          </tt:div>
+          <tt:div begin="8s" end="16s">
+            <tt:p>
+              To create a new tracker click <gui>Add</gui>. From this point on, any number you enter will be part of the selected tracker.
+            </tt:p>
+          </tt:div>
+          <tt:div begin="16s" end="27s">
+            <tt:p>
+             You can create as many trackers as you want by clicking <gui>Add</gui>.
+            </tt:p>
+          </tt:div>
+          <tt:div begin="27s" end="36s">
+            <tt:p>
+              You can apply a set of tracked additions by selecting the tracker and clicking <gui>Apply</gui>.
+            </tt:p>
+          </tt:div>
+          <tt:div begin="36s" end="40s">
+            <tt:p>
+          You can clear a tracker by selecting it and clicking <gui>Clear</gui>.
+            </tt:p>
+          </tt:div>
+        </tt:body>
+      </tt:tt>
+  </media>
 
+ </section>
 </page>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]