[gbrainy] Milo's new gbrainy documentation



commit 8f8365b541a350a2dcd77d5f13b9e7652f070535
Author: Milo Casagrande <milo ubuntu com>
Date:   Tue Apr 6 19:12:39 2010 +0200

    Milo's new gbrainy documentation

 help/C/customgame.page                       |   47 +++++++
 help/C/difficulty.page                       |   40 ++++++
 help/C/figures/all-games.png                 |  Bin 0 -> 445 bytes
 help/C/figures/bottom.png                    |  Bin 8628 -> 0 bytes
 help/C/figures/gbrainy.png                   |  Bin 0 -> 1284 bytes
 help/C/figures/history.png                   |  Bin 23258 -> 0 bytes
 help/C/figures/logic-games.png               |  Bin 0 -> 1811 bytes
 help/C/figures/math-games.png                |  Bin 0 -> 1191 bytes
 help/C/figures/memory-games.png              |  Bin 0 -> 1146 bytes
 help/C/figures/preferences.png               |  Bin 29165 -> 0 bytes
 help/C/figures/results.png                   |  Bin 38668 -> 0 bytes
 help/C/figures/toolbar.png                   |  Bin 10488 -> 0 bytes
 help/C/figures/verbal-games.png              |  Bin 0 -> 1762 bytes
 help/C/gameplay.page                         |   52 +++++++
 help/C/gametypes.page                        |  117 ++++++++++++++--
 help/C/history.page                          |   87 ++++++++++--
 help/C/index.page                            |   54 +++++---
 help/C/introduction.page                     |   15 --
 help/C/license.page                          |   57 ++++++++
 help/C/multiplayer.page                      |   25 ++++
 help/C/newgame.page                          |  188 ++++++++++++++++++++++++++
 help/C/pause.page                            |   75 ++++++++++
 help/C/playing.page                          |   41 ------
 help/C/preferences.page                      |   48 -------
 help/C/results.page                          |   16 ---
 help/C/score.page                            |  122 +++++++++++++++++
 help/C/scoring.page                          |   45 ------
 help/C/times.page                            |   40 ++++++
 help/C/tips.page                             |   33 +++++
 help/Makefile.am                             |   33 +++--
 src/Clients/Classical/Dialogs/AboutDialog.cs |    7 +-
 31 files changed, 914 insertions(+), 228 deletions(-)
---
diff --git a/help/C/customgame.page b/help/C/customgame.page
new file mode 100644
index 0000000..096ef2b
--- /dev/null
+++ b/help/C/customgame.page
@@ -0,0 +1,47 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="topic"
+  id="custompage">
+      
+  <info>
+    <link type="guide" xref="index#play"/>
+    <link type="seealso" xref="newgame"/>
+    <link type="seealso" xref="gametypes"/>
+    <desc>Start a custom games selection.</desc>
+    <revision pkgversion="2.30" version="0.1" date="2010-01-20" status="draft"/>
+    <credit type="author">
+      <name>Milo Casagrande</name>
+      <email>milo ubuntu com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>  
+  </info>
+
+  <title>Custom games selection</title>
+  <p>
+    It is possible to play a custom selection of all the games in <app>gbrainy</app>.
+  </p>
+  <p>
+    To do so, proceed as follows:
+  </p>
+  <steps>
+    <item>
+      <p>
+        Choose <guiseq><gui style="menu">Game</gui><gui style="menuitem">New Game</gui>
+        <gui style="menuitem">Custom Game Selection</gui></guiseq>.
+      </p>
+    </item>
+    <item>
+      <p>
+        In the <gui>Custom Game</gui> dialog, select the games that you would 
+        like to play by clicking on the check box next to the name of the game.
+      </p>
+    </item>
+    <item>
+      <p>
+        Once you are done, click on <gui style="button">Start</gui> to start playing your custom
+        games selection.
+      </p>
+    </item>
+  </steps>
+</page>
diff --git a/help/C/difficulty.page b/help/C/difficulty.page
new file mode 100644
index 0000000..06a294a
--- /dev/null
+++ b/help/C/difficulty.page
@@ -0,0 +1,40 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="topic"
+  id="difficulty">
+      
+  <info>
+    <title type="sort">2</title>
+    <link type="guide" xref="index#play"/>
+    <desc>Change the difficulty level of the games.</desc>
+    <revision pkgversion="2.30" version="0.1" date="2010-01-10" status="draft"/>
+    <revision pkgversion="2.30" version="0.2" date="2010-01-20" status="review"/>
+   <credit type="author">
+    <name>Milo Casagrande</name>
+    <email>milo ubuntu com</email>
+   </credit>
+   <license>
+     <p>Creative Commons Share Alike 3.0</p>
+   </license>
+  </info>
+
+  <title>Difficulty levels</title>
+  <p>
+    To change the difficulty level of the game, proceed as follows:
+  </p>
+  <steps>
+    <item>
+      <p>
+        Choose <guiseq><gui style="menu">Settings</gui><gui style="menuitem">Preferences</gui></guiseq>.
+      </p>
+    </item>
+    <item>
+      <p>
+        In the <gui>Difficulty Level</gui> section, select the desired level.
+      </p>
+      <p>
+        You can choose from three different levels: <gui style="radiobutton">Easy</gui>, <gui style="radiobutton">Medium</gui>,
+        and <gui style="radiobutton">Master</gui>. The default level is <gui style="radiobutton">Medium</gui>.
+      </p>
+    </item>
+  </steps>
+</page>
diff --git a/help/C/figures/all-games.png b/help/C/figures/all-games.png
new file mode 100644
index 0000000..0c87b4e
Binary files /dev/null and b/help/C/figures/all-games.png differ
diff --git a/help/C/figures/gbrainy.png b/help/C/figures/gbrainy.png
new file mode 100644
index 0000000..8b9ab07
Binary files /dev/null and b/help/C/figures/gbrainy.png differ
diff --git a/help/C/figures/logic-games.png b/help/C/figures/logic-games.png
new file mode 100644
index 0000000..1475418
Binary files /dev/null and b/help/C/figures/logic-games.png differ
diff --git a/help/C/figures/math-games.png b/help/C/figures/math-games.png
new file mode 100644
index 0000000..7c91653
Binary files /dev/null and b/help/C/figures/math-games.png differ
diff --git a/help/C/figures/memory-games.png b/help/C/figures/memory-games.png
new file mode 100644
index 0000000..a60dd23
Binary files /dev/null and b/help/C/figures/memory-games.png differ
diff --git a/help/C/figures/verbal-games.png b/help/C/figures/verbal-games.png
new file mode 100644
index 0000000..ab7e352
Binary files /dev/null and b/help/C/figures/verbal-games.png differ
diff --git a/help/C/gameplay.page b/help/C/gameplay.page
new file mode 100644
index 0000000..dc5f8e6
--- /dev/null
+++ b/help/C/gameplay.page
@@ -0,0 +1,52 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="topic"
+  id="gameplay">
+      
+  <info>
+    <link type="guide" xref="index"/>
+    <desc>Introduction to <app>gbrainy</app>.</desc>
+    <revision pkgversion="2.30" version="0.1" date="2010-01-10" status="draft"/>
+    <revision pkgversion="2.30" version="0.1" date="2010-01-21" status="review"/>
+    <revision pkgversion="2.30" version="0.1" date="2010-04-05" status="review"/>
+   <credit type="author">
+    <name>Milo Casagrande</name>
+    <email>milo ubuntu com</email>
+   </credit>
+   <license>
+     <p>Creative Commons Share Alike 3.0</p>
+   </license>
+  </info>
+
+  <title>Gameplay</title>
+  
+  <p>
+   <app>gbrainy</app> is a brain teaser game; the aim of the game is to have fun and keep 
+   your brain trained. 
+  </p>
+  <p>
+   It features different game types like logic puzzles, mental calculation games, 
+   memory trainers and verbal analogies, designed to test different cognitive skills.
+  </p>
+  <p>
+    You can choose different difficulty levels making <app>gbrainy</app> 
+    enjoyable for kids, adults or senior citizens. It also features a game history, 
+    personal records, tips and fullscreen mode support. <app>gbrainy</app> can also 
+    be <link href="http://live.gnome.org/gbrainy/Extending";>extended</link> easily 
+    with new games developed by third parties.
+  </p>
+  <p>
+    <app>gbrainy</app> relies heavily on the work of previous puzzle masters, 
+    ranging from classic puzzles from ancient times to more recent works like 
+    <link href="http://en.wikipedia.org/wiki/Terry_Stickels";>Terry Stickels'</link> 
+    puzzles or the classic <link href="http://en.wikipedia.org/wiki/Dr._Brain";>Dr. Brain</link> 
+    game. 
+  </p>
+  <note>
+    <p>
+      There have been recent discussions in the scientific community regarding whether 
+      brain training software improves cognitive performance. Most of the 
+      studies show that there is little or no improvement, but that doesn't mean 
+      you can't have a good time playing games like <app>gbrainy</app>!
+    </p>
+  </note>
+</page>
diff --git a/help/C/gametypes.page b/help/C/gametypes.page
index 1eca37b..cb04854 100644
--- a/help/C/gametypes.page
+++ b/help/C/gametypes.page
@@ -1,17 +1,106 @@
 <page xmlns="http://projectmallard.org/1.0/";
-      type="topic"
-      id="gametypes">
-<info>
-  <title type="sort">2</title>
-  <link type="guide" xref="index#introduction"/>
-</info>
-<title>Game Types</title>
+  type="topic"
+  id="gametypes">
+  <info>
+    <title type="sort">3</title>
+    <desc>What types of game you can play.</desc>
+    <link type="guide" xref="index#play"/>
+    <link type="seealso" xref="gameplay"/>
+    <revision pkgversion="2.30" version="0.1" date="2010-01-10" status="draft"/>
+    <revision pkgversion="2.30" version="0.2" date="2010-01-21" status="review"/>    
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+  <title>Game types</title>
 
-<p><app>gbrainy</app> provides the following types of games:</p>
-<list>
-	<item><p>Logic puzzles. Games designed to challenge your reasoning and thinking skills. These games are based on sequences of elements, visual and spatial reasoning or relationships between elements.</p></item>
-	<item><p>Mental calculation. Games based on arithmetical operations designed to prove your mental calculation skills. Games that require the player to use multiplication, division, addition and subtraction combined in different ways.</p></item>
-	<item><p>Memory trainers. Games designed to challenge your short term memory. These games show collections of objects and ask the player to recall them, sometimes establishing relationships between figures, words, numbers or colors.</p></item>
-	<item><p>Verbal analogies. Games that challenge your verbal aptitude. Games that ask the player to identify cause and effect, use synonyms or antonyms, and use his vocabulary.</p></item>
-</list>
+  <p>
+    <app>gbrainy</app> provides the following types of games:
+  </p>
+  
+  <table frame="none" rules="none" shade="none">
+    <tr>
+      <td>
+      <terms>
+        <item>
+          <title>Logic puzzles</title>
+          <p>
+            Games designed to challenge your reasoning and thinking skills. These 
+            games are based on sequences of elements, visual and spatial reasoning 
+            or relationships between elements.
+          </p>
+        </item>
+      </terms>
+      </td>
+      <td>
+        <media type="image" mime="image/png" src="figures/logic-games.png">
+          <p>
+            Logic games logo
+          </p>
+        </media>
+      </td>
+    </tr>
+    <tr>
+      <td>
+      <terms>
+        <item>
+          <title>Mental calculations</title>
+          <p>
+            Games based on arithmetical operations designed to improve your mental 
+            calculation skills. Games that require the player to use multiplication, 
+            division, addition and subtraction combined in different ways.
+          </p>
+        </item>
+      </terms>
+      </td>
+      <td>
+        <media type="image" mime="image/png" src="figures/math-games.png">
+          <p>
+            Calculation games logo
+          </p>
+        </media>
+      </td>
+    </tr>
+    <tr>
+      <td>
+      <terms>
+        <item>
+          <title>Memory trainers</title>
+          <p>
+            Games designed to challenge your short-term memory. These games show 
+            collections of objects and ask the player to recall them, sometimes 
+            establishing relationships between figures, words, numbers or colors.
+          </p>
+        </item>
+      </terms>
+      </td>
+      <td>
+        <media type="image" mime="image/png" src="figures/memory-games.png">
+          <p>
+            Memory games logo
+          </p>
+        </media>
+      </td>
+    </tr>
+    <tr>
+      <td>
+      <terms>
+        <item>
+          <title>Verbal analogies</title>
+          <p>
+            Games that challenge your verbal aptitude. These games ask the player to 
+            identify cause and effect, use synonyms or antonyms, and use their vocabulary.
+          </p>
+        </item>
+      </terms>
+      </td>
+      <td>
+        <media type="image" mime="image/png" src="figures/verbal-games.png">
+          <p>
+            Verbal analogies games logo
+          </p>
+        </media>
+      </td>
+    </tr>
+  </table>
 </page>
diff --git a/help/C/history.page b/help/C/history.page
index b851755..dfd49b3 100644
--- a/help/C/history.page
+++ b/help/C/history.page
@@ -1,16 +1,77 @@
 <page xmlns="http://projectmallard.org/1.0/";
-      type="topic"
-      id="history">
-<info>
-  <title type="sort">3</title>
-  <link type="guide" xref="index#history"/>
-</info>
-
-<title>Player's Game History</title>
-<p>You can access the <gui>Player's Game History</gui> from the main application menu.</p>
-<media type="image" mime="image/png" src="figures/history.png"></media>
-<p>In this dialog the player can see how his performance has been evolving from every game type during the last recorded game sessions.</p>
-<p>By clicking on the <gui>Total</gui>, <gui>Logic</gui>, <gui>Memory</gui>, <gui>Mental Calculation</gui> and <gui>Verbal</gui> checkboxes the user can select which game types results are shown on the player's game history graphic.</p>
-<p><app>gbrainy</app> saves the player game scores to be able to track player's score evolution. Using the <link xref="preferences">Preferences</link> the user can select how many games sessions are recorded and how many games you have to play to have the game results stored.</p>
+  type="topic"
+  id="history">
+  <info>
+    <link type="guide" xref="index#play"/>
+    <desc>Access your personal game history.</desc>
+    <revision pkgversion="2.30" version="0.1" date="2010-01-22" status="draft"/>
+    <credit type="author">
+      <name>Milo Casagrande</name>
+      <email>milo ubuntu com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
 
+  <title>Personal game history</title>
+  
+  <p>
+    The <gui>Player's Game History</gui> dialog shows your performance in every 
+    game type during the last few game sessions.
+  </p>
+  
+  <section id="history-personal">
+    <title>View the games history</title>
+    <p>
+      To access your personal game history, choose <guiseq><gui style="menu">View</gui>
+      <gui style="menuitem">Player's Game History</gui></guiseq>.
+    </p>
+  </section>
+  
+  <section id="history-change-graphic">
+    <title>Select which results to show</title>
+    <p>
+      To select the results that will be shown in the graphic, use the different 
+      check boxes located under the graph.
+    </p>
+  </section>
+  
+  <section id="history-save-prefs">
+    <title>Change the number of saved games</title>
+    <p>
+      <app>gbrainy</app> saves the player's scores so it can track how they evolve.
+    </p>
+    <p>
+      In order to change the number of sessions recorded or how many games will
+      be stored in the history, proceed as follows:
+    </p>
+    <steps>
+      <item>
+        <p>
+          Choose <guiseq><gui style="menu">Settings</gui><gui style="menuitem">
+          Preferences</gui></guiseq>.
+        </p>
+      </item>
+      <item>
+        <p>
+          In the <gui>Player's Game History</gui> section:
+        </p>
+        <list>
+          <item>
+            <p>
+              Use the first spin box to change how many game sessions need to
+              be recorded before you can start to see the results in the history graphic. 
+            </p>
+          </item>
+          <item>
+            <p>
+              Use the second spin box to change how many game sessions will be shown
+              in the history graphic.
+            </p>
+          </item>
+        </list>
+      </item>
+    </steps>
+  </section>
 </page>
diff --git a/help/C/index.page b/help/C/index.page
index fe646aa..e013e99 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -1,29 +1,39 @@
 <page xmlns="http://projectmallard.org/1.0/";
-      type="guide"
-      id="index">
-	<info>
-		<credit type="author">
-			<name>Jordi Mas i Hernandez</name>
-			<email>jmas softcatala org</email>
-		</credit>
-		<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
-	</info>
+  type="guide"
+  id="index"
+  style="2column">
 
-	<title>gbrainy Help</title>
+  <info>
+    <title type="link">gbrainy</title>
+    <title type="text">gbrainy</title>
+    <revision pkgversion="2.30" version="0.1" date="2010-01-10" status="draft"/>
+    <revision pkgversion="2.30" version="0.2" date="2010-02-09" status="draft"/>
+    <title type="link">gbrainy</title>
+    <desc>The <app>gbrainy</app> help.</desc>
+    <credit type="author">
+      <name>Milo Casagrande</name>
+      <email>milo ubuntu com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
 
-	<section id="introduction" style="1column">
-	    <title>Introduction</title>
-	</section>
+  <title>
+    <media type="image" mime="image/png" src="figures/gbrainy.png">gbrainy logo</media>
+    gbrainy
+  </title>
 
-	<section id="playing" style="1column">
-		<title>Game Session</title>
-	</section>
+  <section id="play" style="2column">
+    <title>Basic Gameplay &amp; Usage</title>
+  </section>
 
-	<section id="history" style="1column">
-		<title>Player's Game History</title>
-	</section>
+  <section id="multi" style="2column">
+    <title>Multiplayer Game</title>
+  </section>
+  
+  <section id="tips" style="2column">
+    <title>Tips &amp; Tricks</title>
+  </section>
 
-	<section id="preferences" style="1column">
-		<title>Preferences</title>
-	</section>
 </page>
diff --git a/help/C/license.page b/help/C/license.page
new file mode 100644
index 0000000..7ef1551
--- /dev/null
+++ b/help/C/license.page
@@ -0,0 +1,57 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="guide"
+  id="license">
+  
+  <info>
+    <link type="seealso" xref="index"/>
+    <revision pkgversion="2.30" version="0.1" date="2009-12-28" status="draft"/>
+    <desc>Legal information.</desc>
+  </info>
+
+  <title>License</title>
+  <p>
+    <!-- Translators: try to use the same translation as the one provided by the CreativeCommons website. 
+    If there is no translation for your language, consider providing one to CreativeCommons. -->
+    This work is distributed under a CreativeCommons Attribution-Share Alike
+    3.0 Unported license.
+  </p>
+  <p>
+    You are free:
+  </p>
+  <terms>
+    <item>
+      <title><em>To share</em></title>
+      <p>To copy, distribute and transmit the work.</p>
+    </item>
+    <item>
+      <title><em>To remix</em></title>
+      <p>To adapt the work.</p> 
+    </item>
+  </terms>
+  <p>
+    Under the following conditions:
+  </p>
+  <terms>
+    <item>
+      <title><em>Attribution</em></title>
+      <p>
+        You must attribute the work in the manner specified by the author or 
+        licensor (but not in any way that suggests that they endorse you or 
+        your use of the work).  
+      </p>
+    </item>
+    <item>
+      <title><em>Share Alike</em></title>
+      <p>
+        If you alter, transform, or build upon this work, you may distribute the 
+        resulting work only under the same, similar or a compatible license.  
+      </p>
+    </item>
+  </terms>
+  <p>
+    <!-- Translators: there are no official localized versions of the legal code, only the deed is localized. -->
+    For the full text of the license, see the 
+    <link href="http://creativecommons.org/licenses/by-sa/3.0/legalcode";>CreativeCommons website</link>, 
+    or read the full <link href="http://creativecommons.org/licenses/by-sa/3.0/";>Commons Deed</link>. 
+  </p>
+</page>
diff --git a/help/C/multiplayer.page b/help/C/multiplayer.page
new file mode 100644
index 0000000..329a64e
--- /dev/null
+++ b/help/C/multiplayer.page
@@ -0,0 +1,25 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="topic"
+  id="multiplayer">
+
+  <info>
+    <link type="guide" xref="index#multi"/>
+  	<desc>How to play with other people.</desc>
+  	<!-- Taken from GNOME Tetravex -->
+    <revision pkgversion="2.30" version="0.1" date="2009-12-18" status="draft"/> 
+    <credit type="author">
+      <name>Milo Casagrande</name>
+      <email>milo ubuntu com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+  <title>Play with other people</title>
+
+  <p>
+    It is not possible to play against other people over the Internet or a 
+    local network with <app>gbrainy</app>.
+  </p>
+</page>
diff --git a/help/C/newgame.page b/help/C/newgame.page
new file mode 100644
index 0000000..26bf9f2
--- /dev/null
+++ b/help/C/newgame.page
@@ -0,0 +1,188 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="topic"
+  id="newgame">
+      
+  <info>
+    <title type="sort">1</title>
+    <link type="guide" xref="index#play"/>
+    <link type="seealso" xref="gametypes"/>
+    <desc>Start and play a game.</desc>
+    <revision pkgversion="2.30" version="0.1" date="2010-01-10" status="draft"/>
+    <revision pkgversion="2.30" version="0.2" date="2010-01-21" status="review"/>
+   <credit type="author">
+    <name>Milo Casagrande</name>
+    <email>milo ubuntu com</email>
+   </credit>
+   <license>
+     <p>Creative Commons Share Alike 3.0</p>
+   </license>
+  </info>
+
+  <title>Game session</title>
+  
+  <section id="game-start">
+    <title>Start a new session</title>
+    <p>
+      To start a new game, do one of the following:
+    </p>
+    <list>
+      <item>
+        <p>
+          Choose <guiseq><gui style="menu">Game</gui><gui style="menuitem">New Game</gui></guiseq>, and select
+          the type of game to play.
+        </p>
+      </item>
+      <item>
+        <p>
+          Click on one of the buttons in the toolbar.
+        </p>
+      </item>
+    </list>
+    <p>
+      The toolbar buttons have the following meanings:
+    </p>
+    <comment>
+      <cite date="2010-04-05" href="mailto:philbull gmail com">Phil Bull</cite>
+      <p>
+      The descriptions in the list below just echo the name of each button 
+      (X: Start a new game playing X games). Can we do anything more useful with 
+      them (e.g. link to descriptions of each game type, or give examples of 
+      the sorts of games in each category?)
+      </p>
+    </comment>
+    <table frame="none" rules="none" shade="none">
+      <tr>
+        <td>
+        <terms>
+          <item>
+            <title>All</title>
+            <p>
+              Starts a new game playing all the available game types.            
+            </p>
+          </item>
+        </terms>
+        </td>
+        <td>
+          <media type="image" mime="image/png" src="figures/all-games.png">
+            <p>
+              All games button
+            </p>
+          </media>
+        </td>
+      </tr>
+      <tr>
+        <td>
+        <terms>
+          <item>
+            <title>Logic</title>
+            <p>
+              Start a new game playing only logic games.
+            </p>
+          </item>
+        </terms>
+        </td>
+        <td>
+          <media type="image" mime="image/png" src="figures/logic-games.png">
+            <p>
+            Logic games button
+            </p>
+          </media>
+        </td>
+      </tr>
+      <tr>
+        <td>
+        <terms>
+          <item>
+            <title>Calculation</title>
+            <p>
+              Starts a new game playing only calculation games.
+            </p>
+          </item>
+        </terms>
+        </td>
+        <td>
+          <media type="image" mime="image/png" src="figures/math-games.png">
+            <p>
+              Calculation games button
+            </p>
+          </media>
+        </td>
+      </tr>
+      <tr>
+        <td>
+        <terms>
+          <item>
+            <title>Memory</title>
+            <p>
+              Starts a new game playing only memory games.
+            </p>
+          </item>
+        </terms>
+        </td>
+        <td>
+          <media type="image" mime="image/png" src="figures/memory-games.png">
+            <p>
+              Memory games button
+            </p>
+          </media>
+        </td>
+      </tr>
+      <tr>
+        <td>
+        <terms>
+          <item>
+            <title>Verbal</title>
+            <p>
+              Starts a new game playing only verbal analogy games.           
+            </p>
+          </item>
+        </terms>
+        </td>
+        <td>
+          <media type="image" mime="image/png" src="figures/verbal-games.png">
+            <p>
+              Verbal games button
+            </p>
+          </media>
+        </td>
+      </tr>
+    </table>
+    <note>
+      <p>
+        These descriptions also apply to the game types that you can select from
+        the <gui style="menu">Game</gui> menu.
+      </p>
+    </note>
+  </section>
+  <section id="game-play">
+    <title>Play a session</title>
+    <note style="tip">
+      <p>
+        When you play a game, always read the instructions carefully!
+      </p>
+    </note>
+    <p>
+      The game session begins by showing you the problem and then asking for the answer.
+      At the bottom of the window is the main set of controls that you can use to interact with the game.
+    </p>
+    <p>
+      Once you know the answer to the problem, type it in the <gui style="input">Answer</gui>
+      text entry and press <gui style="button">OK</gui>.
+    </p>
+    <p>
+      To proceed to the next game, click <gui style="button">Next</gui>.
+    </p>
+    <comment>
+      <cite date="2010-04-05" href="mailto:philbull gmail com">Phil Bull</cite>
+      <p>
+      I don't understand what this note means. Does it mean that the game will count negatively?
+      </p>
+    </comment>
+    <note>
+      <p>
+        If you click <gui style="button">Next</gui> before completing the game,
+        or without providing an answer, that game will be counted in your results.
+      </p>
+    </note>
+  </section>
+</page>
diff --git a/help/C/pause.page b/help/C/pause.page
new file mode 100644
index 0000000..e969a41
--- /dev/null
+++ b/help/C/pause.page
@@ -0,0 +1,75 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="topic"
+  id="pause">
+      
+  <info>
+    <title type="sort">4</title>
+    <link type="guide" xref="index#play"/>
+    <link type="seealso" xref="newgame"/>
+    <desc>How to pause or stop a game.</desc>
+    <revision pkgversion="2.30" version="0.1" date="2010-01-10" status="draft"/>
+    <credit type="author">
+      <name>Milo Casagrande</name>
+      <email>milo ubuntu com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+  <title>Pause/Stop a game</title>
+
+  <section id="pause-pause">
+    <title>Pause and resume a game</title>
+    <p>
+      To pause a game so that you can resume it at the same point at a later 
+      time, perform one of the following:
+    </p>
+    <list>
+      <item>
+        <p>
+          Choose <guiseq><gui style="menu">Game</gui><gui style="menuitem">Pause Game</gui></guiseq>.
+        </p>
+      </item>
+      <item>
+        <p>
+          Click on the <gui style="button">Pause</gui> button in the toolbar.
+        </p>
+      </item>
+    </list>
+    <p>
+      In order to resume the game after you paused it, perform one of the following:
+    </p>
+    <list>
+      <item>
+        <p>
+          Choose <guiseq><gui style="menu">Game</gui><gui style="menuitem">Pause Game</gui></guiseq>.
+        </p>
+      </item>
+      <item>
+        <p>
+          Click on the <gui style="button">Resume</gui> button in the toolbar.
+        </p>
+      </item>
+    </list>
+  </section>
+  
+  <section id="pause-stop">
+    <title>Stop a game</title>
+    <p>
+      To stop a game, in order to end it, perform one of the following:
+    </p>
+    <list>
+      <item>
+        <p>
+          Choose <guiseq><gui style="menu">Game</gui><gui style="menuitem">End Game</gui></guiseq>.
+        </p>
+      </item>
+      <item>
+        <p>
+          Click on the <gui style="button">Finish</gui> button in the toolbar.
+        </p>
+      </item>
+    </list>
+  </section>
+</page>
diff --git a/help/C/score.page b/help/C/score.page
new file mode 100644
index 0000000..0a9d9c9
--- /dev/null
+++ b/help/C/score.page
@@ -0,0 +1,122 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="topic"
+  id="score">
+      
+  <info>
+    <link type="guide" xref="index#play"/>
+    <link type="seealso" xref="history"/>
+    <desc>How the player scores are calculated.</desc>
+    <revision pkgversion="2.30" version="0.1" date="2010-01-22" status="draft"/>
+    <credit type="author">
+      <name>Milo Casagrande</name>
+      <email>milo ubuntu com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+  <title>Game score and timings</title>
+  <p>
+    If you answer a puzzle incorrectly, you will not get any score for it.
+  </p>
+  <p>
+    If you answer a puzzle correctly, you will get a score which depends on the time
+    taken to resolve the problem and whether you used the tip during the game.
+  </p>
+  <p>
+    The following table summarizes the different game durations (in seconds) based
+    on the difficulty level.
+  </p>
+  <table frame="all" rules="all">
+    <tr>
+      <td><p></p></td>
+      <td><p>Easy</p></td>
+      <td><p>Medium</p></td>
+      <td><p>Master</p></td>
+    </tr>
+    <tr>
+      <td><p>Logic puzzles</p></td>
+      <td><p>156</p></td>
+      <td><p>120</p></td>
+      <td><p>110</p></td>
+    </tr>
+    <tr>
+      <td><p>Mental calculation</p></td>
+      <td><p>78</p></td>
+      <td><p>60</p></td>
+      <td><p>55</p></td>
+    </tr>
+    <tr>
+      <td><p>Memory trainers</p></td>
+      <td><p>39</p></td>
+      <td><p>30</p></td>
+      <td><p>27</p></td>
+    </tr>
+    <tr>
+      <td><p>Verbal analogies</p></td>
+      <td><p>39</p></td>
+      <td><p>30</p></td>
+      <td><p>27</p></td>
+    </tr>
+  </table>
+  <p>
+    With the expected time for the chosen difficulty level and the time you
+    take to complete the game, the following logic is applied:
+  </p>
+  <list>
+    <item>
+      <p>
+        If you take less than the time expected to complete the game, you score 100%.
+      </p>
+    </item>
+    <item>
+      <p>
+        If you take more than the time expected to complete the game, you score 80%.
+      </p>
+    </item>
+    <item>
+      <p>
+        If you take more than 2x the time expected to complete the game,
+        you score 70%.
+      </p>
+    </item>
+    <item>
+      <p>
+        If you take more than 3x the time expected to complete the game,
+        you score 60%.
+      </p>
+    </item>
+    <item>
+      <p>
+        If you use a tip, you score only the 80% of the original score.
+      </p>
+    </item>
+  </list>
+  
+  <section id="computing-scores">
+    <title>Computing the totals</title>
+    <comment>
+      <cite date="2010-04-05" href="mailto:philbull gmail com">Phil Bull</cite>
+      <p>
+      In this section, does "logarithm of 20" mean score = log_20(sum(results))?
+      </p>
+    </comment>
+    <p>
+      <app>gbrainy</app> keeps track of the different games types played. To compute
+      the final score of every set of game types it sums all the results of the 
+      same game types played and then applies a factor based on: the logarithm of 
+      10 for the easy level; on the logarithm of 20 for the medium level; and 
+      on the logarithm of 30 for the master level.
+    </p>
+	  <p>
+	    This means that when playing at medium difficult level, to get a score of 
+	    100% you need to score 100% on at least 20 games of every game type played.
+	  </p>
+	  <p>
+	    This may sound challenging, but it allows players to compare game scores from 
+	    different sessions (in the player's game history) and allows better tracking of
+	    the progression of the player through all of the games played.
+	  </p>
+  </section>
+</page>
diff --git a/help/C/times.page b/help/C/times.page
new file mode 100644
index 0000000..6a423b3
--- /dev/null
+++ b/help/C/times.page
@@ -0,0 +1,40 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="topic"
+  id="times">
+      
+  <info>
+    <link type="guide" xref="index#play"/>
+    <desc>Change the challenge presentation time in memory games.</desc>
+    <revision pkgversion="2.30" version="0.1" date="2010-01-10" status="draft"/>
+    <revision pkgversion="2.30" version="0.2" date="2010-01-19" status="review"/>
+   <credit type="author">
+    <name>Milo Casagrande</name>
+    <email>milo ubuntu com</email>
+   </credit>
+   <license>
+     <p>Creative Commons Share Alike 3.0</p>
+   </license>
+  </info>
+
+  <title>Change the challenge duration</title>
+  <p>
+    To change the number of seconds you are given to memorize the challenge when
+    playing memory games, proceed as follows:
+  </p>
+  <steps>
+    <item>
+      <p>
+        Choose <guiseq><gui style="menu">Settings</gui><gui style="menuitem">Preferences</gui></guiseq>.
+      </p>
+    </item>
+    <item>
+      <p>
+        In the <gui>Memory Games</gui> section, use the spin box to increase or
+        decrease the number of seconds that the challenge will be visible for.
+      </p>
+      <p>
+        The default value is 4 seconds.
+      </p>
+    </item>
+  </steps>
+</page>
diff --git a/help/C/tips.page b/help/C/tips.page
new file mode 100644
index 0000000..7402713
--- /dev/null
+++ b/help/C/tips.page
@@ -0,0 +1,33 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="topic"
+  id="tips">
+      
+  <info>
+    <link type="guide" xref="index#tips"/>
+    <link type="seealso" xref="newgame"/>
+    <desc>Use the tips to solve a puzzle.</desc>
+    <revision pkgversion="2.30" version="0.1" date="2010-01-21" status="draft"/>
+    <revision pkgversion="2.30" version="0.1" date="2010-01-22" status="review"/>
+    <credit type="author">
+      <name>Milo Casagrande</name>
+      <email>milo ubuntu com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+  <title>Tips</title>
+  <p>
+    With some of the games you can play, it is possible to get simple tips that
+    can help you to solve the problem.
+  </p>
+  <p>
+    When playing a game, click on the <gui style="button">Tip</gui> button at the bottom of the window (next to the <gui style="input">Answer</gui> text entry).
+  </p>
+  <note>
+    <p>
+      This feature is not available for some of the games.
+    </p>
+  </note>
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index 290893d..cd52ba8 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -4,21 +4,28 @@ DOC_ID = gbrainy
 DOC_INCLUDES = legal.xml
 
 DOC_FIGURES = \
-	figures/toolbar.png	\
-	figures/bottom.png	\
-	figures/results.png	\
-	figures/preferences.png	\
-	figures/history.png
+	figures/all-games.png		\
+	figures/logic-games.png		\
+	figures/memory-games.png	\
+	figures/gbrainy.png		\
+	figures/math-games.png		\
+	figures/verbal-games.png	
+
 
 DOC_PAGES = \
-	index.page \
-	introduction.page \
-	gametypes.page \
-	playing.page \
-	scoring.page \
-	preferences.page \
-	results.page \
-	history.page
+	customgame.page	\ 
+	gametypes.page	\
+	license.page	\
+	pause.page	\
+	tips.page	\
+	difficulty.page	\
+	history.page	\
+	multiplayer.page \
+	score.page	\
+	gameplay.page	\	
+	index.page	\
+	newgame.page	\
+	times.page
 
 DOC_LINGUAS = ca cs da de es
 
diff --git a/src/Clients/Classical/Dialogs/AboutDialog.cs b/src/Clients/Classical/Dialogs/AboutDialog.cs
index c08d7ac..4dd721d 100644
--- a/src/Clients/Classical/Dialogs/AboutDialog.cs
+++ b/src/Clients/Classical/Dialogs/AboutDialog.cs
@@ -43,6 +43,11 @@ namespace gbrainy.Clients.Classical
 				"Openclipart.org"
 			};
 
+			string [] documenters = new string [] {
+				"Milo Casagrande <milo ubuntu com>",
+				"Jordi Mas i Hernandez <jmas softcatala org>"
+			};
+
 			// Translators: Replace by the name of the people that translated the application
 			string translators = Catalog.GetString ("translator-credits");
 
@@ -56,7 +61,7 @@ namespace gbrainy.Clients.Classical
 			ProgramName = "gbrainy";
 			Version = Defines.VERSION;
 			Authors = authors;
-			Documenters = null;
+			Documenters = documenters;
 			Logo = LoadFromAssembly ("gbrainy.svg");
 
 			Copyright = Defines.COPYRIGHT + "\n";



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]