GNOME.org
 

[gbrainy] More work on gbrainy documentation

commit 631e5262777aca371aab7a583883447c65404e24
Author: Jordi Mas <jmas softcatala org>
Date:   Sat Dec 26 10:19:19 2009 +0100

    More work on gbrainy documentation

 help/C/figures/preferences.png |  Bin 0 -> 29165 bytes
 help/C/figures/results.png     |  Bin 0 -> 38668 bytes
 help/C/gametypes.page          |    3 +-
 help/C/history.page            |   13 ++++++++++++
 help/C/index.page              |    6 ++++-
 help/C/legal.xml               |    9 ++++++++
 help/C/playing.page            |   15 +++++--------
 help/C/preferences.page        |   42 ++++++++++++++++++++++++++++++++++++++-
 help/C/results.page            |   15 ++++++++++++++
 help/C/scoring.page            |   38 +++++++++++++++++++++++++++++++++++-
 help/Makefile.am               |    8 +++++-
 11 files changed, 132 insertions(+), 17 deletions(-)
---
diff --git a/help/C/figures/preferences.png b/help/C/figures/preferences.png
new file mode 100644
index 0000000..2885565
Binary files /dev/null and b/help/C/figures/preferences.png differ
diff --git a/help/C/figures/results.png b/help/C/figures/results.png
new file mode 100644
index 0000000..527ef6d
Binary files /dev/null and b/help/C/figures/results.png differ
diff --git a/help/C/gametypes.page b/help/C/gametypes.page
index 1b53fd4..c4a61a9 100644
--- a/help/C/gametypes.page
+++ b/help/C/gametypes.page
@@ -7,8 +7,7 @@
 </info>
 <title>Game Types</title>
 
-<p><app>gbrainy</app> is a brain teaser game and trainer to have fun and to keep your brain trained.</p>
-<p>It provides the following types of games:</p>
+<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.</p></item>
 	<item><p>Mental calculation. Games based on arithmetical operations designed to prove your mental calculation skills.</p></item>
diff --git a/help/C/history.page b/help/C/history.page
new file mode 100644
index 0000000..b665ea7
--- /dev/null
+++ b/help/C/history.page
@@ -0,0 +1,13 @@
+<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 history</title>
+
+<p><app>gbrainy</app> saves player game scores to be able to track player's score evolution. Using the preferences the user can select how many games are stored and how many games you have to play in order that gbrainy stores the game. </p>
+
+</page>
diff --git a/help/C/index.page b/help/C/index.page
index 298b2af..11c7f9d 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -12,7 +12,11 @@
 	</section>
 
 	<section id="playing" style="1column">
-		<title>Playing</title>
+		<title>A Game Session</title>
+	</section>
+
+	<section id="history" style="1column">
+		<title>Player's history</title>
 	</section>
 
 	<section id="preferences" style="1column">
diff --git a/help/C/legal.xml b/help/C/legal.xml
new file mode 100644
index 0000000..86d6173
--- /dev/null
+++ b/help/C/legal.xml
@@ -0,0 +1,9 @@
+<license xmlns="http://projectmallard.org/1.0/";
+         href="http://creativecommons.org/licenses/by-sa/3.0/";>
+<p>This work is licensed under a
+<link href="http://creativecommons.org/licenses/by-sa/3.0/";>Creative Commons
+Attribution-Share Alike 3.0 Unported License</link>.</p>
+<p>As a special exception, the copyright holders give you permission to copy,
+modify, and distribute the example code contained in this document under the
+terms of your choosing, without restriction.</p>
+</license>
diff --git a/help/C/playing.page b/help/C/playing.page
index 3778ce0..8bc528b 100644
--- a/help/C/playing.page
+++ b/help/C/playing.page
@@ -2,12 +2,14 @@
       type="topic"
       id="playing">
 <info>
+  <title type="sort">1</title>
   <link type="guide" xref="index#playing"/>
 </info>
 <title>Playing</title>
 <section id="starting" style="1column">
 	<title>Starting a game</title>
 	<p>You can start a new game by clicking on the different buttons of the application toolbar.</p>
+	<p>The following buttons are available:</p>
 	<media type="image" mime="image/png" src="figures/toolbar.png"></media>
 	<list>
 		<item><p><gui>All</gui>. Starts a new game playing all the available games.</p></item>
@@ -16,7 +18,7 @@
 		<item><p><gui>Memory</gui>. Starts a new game playing all the memory games.</p></item>
 		<item><p><gui>Verbal</gui>. Starts a new game playing all the verbal games.</p></item>
 	</list>
-	<p>You can also have the same functionality available under the <guiseq><gui>Game</gui> <gui>New Game</gui></guiseq> menu.</p>
+	<p>You have also the same functionality available under the <guiseq><gui>Game</gui> <gui>New Game</gui></guiseq> menu.</p>
 </section>
 
 <section id="during" style="1column">
@@ -24,19 +26,14 @@
 
 	<p>The game starts by showing a puzzle to the user and making a question. Read always the instructions carefully. </p>
 
-	<p>At the bottom of the application you have the main set of controls to interact with the game:</p>
+	<p>At the bottom of the application (see the capture below) you have the main set of controls to interact with the game.</p>
 
 	<media type="image" mime="image/png" src="figures/bottom.png"></media>
 
-	<p>Once you know the answer you have to type it in the entry field next to the <gui>Answer:</gui>label</p>.
+	<p>Once you know the answer you have to type it in the entry field next to the <gui>Answer:</gui> label</p>.
 
-	<p>Some puzzle include a tip that gives some guidance when trying to solve them. You can use the <gui>Tip</gui> button when it is enabled to get a tip.</p>
+	<p>Some puzzles include a tip that gives some guidance when trying to solve them. You can use the <gui>Tip</gui> button when it is enabled to get a tip.</p>
 
 	<p>Once you have answered the puzzle you will be informed if you did provide the right answer. You can use the <gui>Next</gui> button to go to the next puzzle.</p>
-
-</section>
-
-<section id="ending" style="1column">
-<title>Ending the game</title>
 </section>
 </page>
diff --git a/help/C/preferences.page b/help/C/preferences.page
index b6bc1ee..64f0315 100644
--- a/help/C/preferences.page
+++ b/help/C/preferences.page
@@ -2,8 +2,46 @@
       type="topic"
       id="preferences">
 <info>
-  <link type="guide" xref="preferences"/>
+  <link type="guide" xref="index#preferences"/>
 </info>
 <title>Preferences</title>
-<b>TDB: How to use the preferences</b>
+
+<p>You can access the <gui>Preferences</gui> from the main application menu.</p>
+<media type="image" mime="image/png" src="figures/preferences.png"></media>
+
+<section id="general" style="1column">
+	<title>General Settings</title>
+	<p>The <gui>Skip games that use colors</gui> option removes from the list of available games the games that use colors to challenge the player making it friendly to color blind users.</p>
+</section>
+
+<section id="difficulty" style="1column">
+	<title>Difficulty Level</title>
+	<p>The difficulty level establishes the complexity of the games shown during a gaming session. Influences the number of elements to remember in memory games, the size of numbers in calculation games, makes more obvious or obfuscated logic puzzles, etc. The available difficulty levels are:</p>
+	<list>
+		<item><p><gui>Easy</gui>. The complexity of the games shows is the average for kids.</p></item>
+		<item><p><gui>Medium</gui>. This is the default level of the difficulty of <app>gbrainy</app>. The complexity of the games shown is considered good for a regular player.</p></item>
+		<item><p><gui>Master</gui>. Ideal for advanced players with a special talent for playing <app>gbrainy</app> alike games.</p></item>
+	</list>
+	<p>The difficulty level additionally fine tunes the scoring algorithm by been more generous when playing at the easy level or more demanding when playing at master level.</p>
+
+</section>
+
+<section id="memory" style="1column">
+	<title>Memory Games</title>
+	<p>These options affect the behaviour of memory games:</p>
+	<list>
+		<item><p><gui>Time in seconds to memorize the challenge</gui>. Establishes the time that a collection of objects is shown to allow the player to memorize it.</p></item>
+		<item><p><gui>Show countdown message</gui>. When checked shows the player a countdown message before every memory game. This is helpfully when playing different game types in a single game session because indicates to the user that should get ready to memorize the next game. Advanced players usually disable this option.</p></item>
+	</list>
+</section>
+
+<section id="history" style="1column">
+    <title>Player History</title>
+	<list>
+		<item><p><gui>Minimum number of played games to store the game</gui>. Determines the number of games that a player should play in a game session to store it and make it available in the player's history.</p></item>
+		<item><p><gui>Maximum number of stored games in the player's history</gui>. Once this limit has been reach the result of the older games is removed to store the results of the new game sessions. </p></item>
+		<item><p><gui>Clear player's history</gui>. Clears the player's history by removing all the previous recorded scores.</p></item>
+	</list>
+</section>
+
 </page>
diff --git a/help/C/results.page b/help/C/results.page
new file mode 100644
index 0000000..3b5c4b5
--- /dev/null
+++ b/help/C/results.page
@@ -0,0 +1,15 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="results">
+<info>
+  <title type="sort">3</title>
+  <link type="guide" xref="index#playing"/>
+</info>
+
+<title>Results</title>
+<p>When you finish a game session <app>gbrainy</app> shows a summary of the results of the session.</p>
+<media type="image" mime="image/png" src="figures/results.png"></media>
+
+<p>If the number of games played in the session are the minimum number defined in the prefences to store the session then the results of the game session are stored in the players' history.</p>
+
+</page>
diff --git a/help/C/scoring.page b/help/C/scoring.page
index 38a5674..ec3ffa3 100644
--- a/help/C/scoring.page
+++ b/help/C/scoring.page
@@ -2,8 +2,44 @@
       type="topic"
       id="scoring">
 <info>
+  <title type="sort">2</title>
   <link type="guide" xref="index#playing"/>
 </info>
+
 <title>Scoring</title>
-<b>TDB: How gbrainy scoring works</b>
+
+<section id="intro" style="1column">
+	<title>Introduction</title>
+	<p>During a game session a player usually solves several games. <app>gbrainy</app> scores every individual game and then computes the totals for every set of game types played during the session.</p>
+</section>
+
+<section id="games" style="1column">
+	<title>Scoring individual games</title>
+	<p>If the player answers a game incorrectly it does not get any score for it. If the player answers the game correctly <app>gbrainy</app> scores the player considering the time used and if the played used the tip.</p>
+
+	<p>When playing at medium difficulty level the player is expected to solve in the time indicated the following game types:</p>
+	<list>
+		<item><p>Logic puzzles in 120 seconds.</p></item>
+		<item><p>Mental calculation games in 60 seconds.</p></item>
+		<item><p>Memory trainers games in 30 seconds.</p></item>
+		<item><p>Verbal analogies in 30 seconds.</p></item>
+	</list>
+	<p>At easy difficulty level the player is given 30% more time and at master level is given only 70% of the previous times.</p>
+	<p>With the expected time for the current difficulty level and the time used by the player to complete the game the following logic is applied:</p>
+	<list>
+		<item><p>If the player required less than the time expected scores 100%.</p></item>
+		<item><p>If the player required less than the double of time expected scores 80%.</p></item>
+		<item><p>if the player required more than the double of time expected scores 70%.</p></item>
+		<item><p>If the player required more than three times the time expected scores 60%.</p></item>
+	</list>
+	<p>Additionally, if the player used the tip then scores only 80% of the previous score for the game.</p>
+</section>
+
+<section id="totals" style="1column">
+	<title>Computing the totals</title>
+	<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 of a logarithm of 10 for the easy difficult level, 20 for the medium difficult level and 30 for master difficult level.</p>
+	<p>This means that to score 100% playing at medium difficult level you need to score 100% on at least 20 games of every game type played, 80 games in you have played all the games times.</p>. 
+	<p>This may sound challenging but allows players to compare game scores from different sessions (in the player history) and allows to better show the progression of the player during all the games that has played.</p>
+</section>
+
 </page>
diff --git a/help/Makefile.am b/help/Makefile.am
index 429660c..301b2b7 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -5,7 +5,9 @@ DOC_INCLUDES = legal.xml
 
 DOC_FIGURES = \
 	figures/toolbar.png	\
-	figures/bottom.png	
+	figures/bottom.png	\
+	figures/results.png	\
+	figures/preferences.png
 
 DOC_PAGES = \
 	index.page \
@@ -13,7 +15,9 @@ DOC_PAGES = \
 	gametypes.page \
 	playing.page \
 	scoring.page \
-	preferences.page
+	preferences.page \
+	results.page \
+	history.page
 
 DOC_LINGUAS=
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]