[gnome-games] gnomine help: additional content

From: Tiffany Antopolski <antopolski src gnome org>
To: commits-list gnome org
Cc:
Subject: [gnome-games] gnomine help: additional content
Date: Tue, 7 Feb 2012 03:22:02 +0000 (UTC)
commit 54568a04cbf1529f1b4ae11c28077465b3dadcbe
Author: Tiffany Antopolski <tiffany antopolski gmail com>
Date:   Mon Feb 6 22:21:37 2012 -0500

    gnomine help: additional content

 gnomine/help/C/bug-filing.page    |   47 +++++++++++++++++++++++++++++++++++++
 gnomine/help/C/develop.page       |   27 +++++++++++++++++++++
 gnomine/help/C/difficulty.page    |   33 +++++++++++--------------
 gnomine/help/C/documentation.page |   29 ++++++++++++++++++++++
 gnomine/help/C/face.page          |    1 -
 gnomine/help/C/flags.page         |   33 ++++++++++++++++++++++++++
 gnomine/help/C/hint.page          |   19 +++++++++++++++
 gnomine/help/C/index.page         |    8 ++++-
 gnomine/help/C/introduction.page  |   39 ------------------------------
 gnomine/help/C/new-game.page      |   10 +------
 gnomine/help/C/play.page          |   34 ++++++++++++++++++++++++++
 gnomine/help/C/rule.page          |   18 +-------------
 gnomine/help/C/shortcuts.page     |   45 +++++++++++++++++++++++++++++++++++
 gnomine/help/C/toolbar.page       |   19 +++++++++++++++
 gnomine/help/C/translate.page     |   39 ++++++++++++++++++++++++++++++
 15 files changed, 316 insertions(+), 85 deletions(-)
---
diff --git a/gnomine/help/C/bug-filing.page b/gnomine/help/C/bug-filing.page
new file mode 100644
index 0000000..d434708
--- /dev/null
+++ b/gnomine/help/C/bug-filing.page
@@ -0,0 +1,47 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="bug-filing">
+
+  <info>
+    <link type="guide" xref="index#get-involved"/>
+    <link type="seealso" xref="commandline"/>
+    <revision pkgversion="3.4" version="0.1" date="2012-02-06" status="review"/>
+    <credit type="editor copyright">
+      <name>Tiffany Antopolski</name>
+      <email>tiffany antopolski com</email>
+      <years>2011</years>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+<title>Help make <app>Gnomine</app> better</title>
+
+<section id="bug-report">
+<title>Report a bug or suggest an improvement</title>
+<p>
+   <app>Gnomine</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=gnome-games";>browse</link> for the bug to see if it already exists.
+   </p>
+   <p>
+   To file your bug, choose the component <gui>gnomine</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. Thanks for helping make <app>Gnomine</app> better!
+   </p>
+</section>
+</page>
diff --git a/gnomine/help/C/develop.page b/gnomine/help/C/develop.page
new file mode 100644
index 0000000..8944a53
--- /dev/null
+++ b/gnomine/help/C/develop.page
@@ -0,0 +1,27 @@
+<page xmlns="http://projectmallard.org/1.0/";
+	type="topic" style="task"
+	id="develop">
+
+  <info>
+   <link type="guide" xref="index#get-involved"/>
+    
+    <revision pkgversion="3.4" version="0.1" date="2012-02-06" status="review"/>
+    <credit type="author copyright">
+      <name>Tiffany Antopolski</name>
+      <email>tiffany antopolski gmail com</email>
+      <years>2011</years>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+<title>Help develop</title>
+ <p>
+  The <app>GNOME Games</app> are developed and maintained by a volunteer community.  You are welcome to participate.
+ </p>
+ <p>
+   If you would like to <link href="https://live.gnome.org/GnomeGames/Contributing";>help develop <app>GNOME Games</app></link>, you can get in touch with the developers using <link href="https://cbe005.chat.mibbit.com/?url=irc%3A%2F%2Firc.gnome.org%2Fgnome-games";>irc</link>, or via our <link href="http://mail.gnome.org/mailman/listinfo/games-list";>mailing list</link>. 
+ </p>
+
+</page>
diff --git a/gnomine/help/C/difficulty.page b/gnomine/help/C/difficulty.page
index 77ba2ed..c3bf222 100644
--- a/gnomine/help/C/difficulty.page
+++ b/gnomine/help/C/difficulty.page
@@ -12,32 +12,29 @@
       <years>2011</years>
     </credit>
 
-    <desc>How to set game difficulty level</desc>
   </info>
 
-  <title>Define the game difficulty</title>
+  <title>Change the game difficulty</title>
 
-  <comment>
-    <cite date="2011-12-05" href="mailto:baptistem gnome org">Baptiste Mille-Mathias</cite>
-    <p>This assumes the reader knows how to.... By the end of this page,
-    the reader will be able to....</p>
-  </comment>
-
-  <p>You can tune the difficulty by choosing the groid size used to play <app>gnomine</app>.</p>
+  <p>You can set the difficulty by choosing the grid size used to play <app>gnomine</app>.</p>
 
   <steps>
-    <item><p>Click <guiseq><gui>Settings</gui><gui>Preferences</gui></guiseq>.</p></item>
-    <item><p>Select among the proposed grid sizes: </p>
+    <item><p>Click <guiseq><gui>Game</gui><gui>New</gui></guiseq>.</p></item>
+    <item><p>Select from the proposed grid sizes:</p>
       <list>
-        <item><p><gui>Small</gui> (8 x 8 board tiles and 10 mines to find)</p></item>
-        <item><p><gui>Medium</gui> (16 x 16 board tiles and 40 mines to find)</p></item>
-        <item><p><gui>Big</gui> (30 x 16 board tiles and 99 mines to find)</p></item>
-        <item><p><gui>Custom</gui> (custom number of tiles and mines)</p></item>
+        <item><p>8 x 8 board  with 10 mines</p></item>
+        <item><p>16 x 16 board with 40 mines to find</p></item>
+        <item><p>30 x 16 board with 99 mines</p></item>
+        <item><p>Custom board</p>
+
+
+   <note><p>For the <gui>Custom</gui> size, you have to define the <gui>Horizontal</gui>
+  and the <gui>Vertical</gui> numbers of tiles, and the number of mines</p></note>
+
+
+       </item>
       </list>
     </item>
   </steps>
 
-  <p>For the <gui>Custom</gui> size, you have to define the <gui>Horizontal</gui> 
-  and the <gui>Vertical</gui> numbers of tiles, and the number of mines</p>
-
 </page>
diff --git a/gnomine/help/C/documentation.page b/gnomine/help/C/documentation.page
new file mode 100644
index 0000000..b114c95
--- /dev/null
+++ b/gnomine/help/C/documentation.page
@@ -0,0 +1,29 @@
+<page xmlns="http://projectmallard.org/1.0/";
+	type="topic" style="task"
+	id="documentation">
+  <info>
+    <revision pkgversion="3.4" version="0.1" date="2012-02-06" status="review"/>
+   <link type="guide" xref="index#get-involved"/>
+    <credit type="editor copyright">
+      <name>Tiffany Antopolski</name>
+      <email>tiffany antopolski gmail com</email>
+      <years>2011</years>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+<title>Help write documentation</title>
+
+<p>
+  The <app>GNOME Games</app> documentation is maintained by a volunteer community.  You are welcome to participate.</p>
+
+<p>To contribute to the Documentation Project,  feel free to get in touch with us using <link href="https://cbe003.chat.mibbit.com/?url=irc%3A%2F%2Firc.gnome.org%2Fdocs";>irc</link>, or via our <link href="http://mail.gnome.org/mailman/listinfo/gnome-doc-list";>mailing list</link>. 
+</p>
+<p>
+Our <link href="https://live.gnome.org/DocumentationProject/Contributing";>wiki</link> page contains useful information. 
+</p>
+
+
+</page>
diff --git a/gnomine/help/C/face.page b/gnomine/help/C/face.page
index 17d7450..55d6be0 100644
--- a/gnomine/help/C/face.page
+++ b/gnomine/help/C/face.page
@@ -11,7 +11,6 @@
       <years>2011</years>
     </credit>
 
-    <desc></desc>
   </info>
 
   <title>The meaning of the faces</title>
diff --git a/gnomine/help/C/flags.page b/gnomine/help/C/flags.page
new file mode 100644
index 0000000..e883340
--- /dev/null
+++ b/gnomine/help/C/flags.page
@@ -0,0 +1,33 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="flags">
+  <info>
+    <link type="guide" xref="index#tips"/>
+    <revision version="0.1" date="2012-02-06" status="stub"/>
+
+    <credit type="author copyright">
+      <name>Tiffany Antopolski</name>
+      <email>tiffany antopolski gmail com</email>
+      <years>2012</years>
+    </credit>
+
+    <desc></desc>
+  </info>
+
+  <title>Flags</title>
+
+  <comment>
+    <cite date="2012-02-06" href="mailto:tiffany antopolski gmail com">Tiffany Antopolski</cite>
+    <p>This assumes the reader knows how to.... By the end of this page,
+    the reader will be able to....</p>
+  </comment>
+
+  <p>Short introductory text...</p>
+
+  <steps>
+    <item><p>First step...</p></item>
+    <item><p>Second step...</p></item>
+    <item><p>Third step...</p></item>
+  </steps>
+
+</page>
diff --git a/gnomine/help/C/hint.page b/gnomine/help/C/hint.page
new file mode 100644
index 0000000..00f75e8
--- /dev/null
+++ b/gnomine/help/C/hint.page
@@ -0,0 +1,19 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="hint">
+  <info>
+    <revision version="0.1" date="2012-02-06" status="stub"/>
+
+    <credit type="author copyright">
+      <name>Tiffany Antopolski</name>
+      <email>tiffany antopolski gmail com</email>
+      <years>2012</years>
+    </credit>
+
+    <desc></desc>
+  </info>
+
+  <title>Hints</title>
+
+
+</page>
diff --git a/gnomine/help/C/index.page b/gnomine/help/C/index.page
index 1650dff..4d4e0b7 100644
--- a/gnomine/help/C/index.page
+++ b/gnomine/help/C/index.page
@@ -13,9 +13,13 @@
       <p>Creative Commons Share Alike 3.0</p>
     </license>
   </info>
-  
-  <title><media type="image" src="figures/logo32.png">GNOME Mines logo</media>GNOME Mines</title>
 
+  <title><media type="image" src="figures/logo32.png">GNOME Mines logo</media>GNOME Mines</title>
+  <p>
+    <app>Gnomine</app> is a Mine Sweeper clone game. The aim of the game is to
+    locate all the mines hidden under tiles on a square board. You'll need some
+    reflection and some luck to find all of them without causing an explosion.
+  </p>
   <section id="play" style="2column">
     <title>Game Play</title>
   </section>
diff --git a/gnomine/help/C/new-game.page b/gnomine/help/C/new-game.page
index 6233b18..af2f25b 100644
--- a/gnomine/help/C/new-game.page
+++ b/gnomine/help/C/new-game.page
@@ -12,19 +12,13 @@
       <years>2011</years>
     </credit>
 
-    <desc>Start a new game</desc>
   </info>
 
   <title>Start a new game</title>
 
-  <comment>
-    <cite date="2011-12-07" href="mailto:baptistem gnome org">Baptiste Mille-Mathias</cite>
-    <p>This assumes the reader knows how to.... By the end of this page,
-    the reader will be able to....</p>
-  </comment>
 
-  <p>To start a new game choose menu <guiseq><gui>Game</gui><gui>New</gui>
+  <p>To start a new game click <guiseq><gui>Game</gui><gui>New</gui>
     </guiseq>. If you have a game on-going, it will be lost.</p>
-  <p>If you want to set the difficulty before starting, look at the page <link xref="difficulty"/>.</p>
+  <p>Each time you start a new game, you will be asked to <link xref="difficulty">select your preferred difficulty level</link>.</p>
 
 </page>
diff --git a/gnomine/help/C/play.page b/gnomine/help/C/play.page
new file mode 100644
index 0000000..c69faf1
--- /dev/null
+++ b/gnomine/help/C/play.page
@@ -0,0 +1,34 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="play">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+    <revision version="0.1" date="2011-12-08" status="review"/>
+
+    <credit type="author copyright">
+      <name>Baptiste Mille-Mathias</name>
+      <email>baptistem gnome org</email>
+      <years>2011</years>
+    </credit>
+
+  </info>
+
+  <title>How to play</title>
+
+  <p>For the fist step, click on any tile on the game board to uncover it, it will displayed the following:</p>
+    <list>
+      <item><p>A number, which represent the number of mine surrounding the tile</p></item>
+      <item><p>A blank title</p></item>
+      <item><p>A mine, in which case you lose.</p></item>
+    </list>
+
+  <p>When you think there is a mine under a tile, you can right click on the tile to put a red flag on it, that will indicate there is potentialy a mine, and will prevent the tile from being inadvertaly clicked and the mine to explode.</p>
+<figure>
+    <title><app>gnomine</app> main window</title>
+    <desc>The main window of <app>gnomine</app>, the menu at top, the face, the
+    board game and the status bar.</desc>
+    <media type="image" src="figures/gnomine.png"/>
+  </figure>
+
+</page>
diff --git a/gnomine/help/C/rule.page b/gnomine/help/C/rule.page
index a254126..eba7b3a 100644
--- a/gnomine/help/C/rule.page
+++ b/gnomine/help/C/rule.page
@@ -12,24 +12,8 @@
       <years>2011</years>
     </credit>
 
-    <desc>How to play to <app>gnomine</app></desc>
   </info>
 
-  <title><app>gnomine</app> game rules</title>
-
-  <comment>
-    <cite date="2011-12-08" href="mailto:baptistem gnome org">Baptiste Mille-Mathias</cite>
-    <p>This assumes the reader knows how to.... By the end of this page,
-    the reader will be able to....</p>
-  </comment>
-
-  <p>For the fist step, click on any tile on the game board to uncover it, it will displayed the following:</p>
-    <list>
-      <item><p>A number, which represent the number of mine surrounding the tile</p></item>
-      <item><p>A blank title</p></item>
-      <item><p>A mine, in which case you lose.</p></item>
-    </list>
-
-  <p>When you think there is a mine under a tile, you can right click on the tile to put a red flag on it, that will indicate there is potentialy a mine, and will prevent the tile from being inadvertaly clicked and the mine to explode.</p>
+  <title>Game rules</title>
 
 </page>
diff --git a/gnomine/help/C/shortcuts.page b/gnomine/help/C/shortcuts.page
new file mode 100644
index 0000000..afe01c3
--- /dev/null
+++ b/gnomine/help/C/shortcuts.page
@@ -0,0 +1,45 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="shortcuts">
+  <info>
+    <link type="guide" xref="index#advanced" />
+    <revision version="0.1" date="2012-02-06" status="review"/>
+
+    <credit type="author copyright">
+      <name>Brian Grohe</name>
+      <email>grohe43 gmail com</email>
+      <years>2012</years>
+    </credit>
+
+    <desc></desc>
+  </info>
+
+  <title>Keyboard shortcuts</title>
+  <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>Fullscreen</p></td>
+         <td><p><key>F11</key></p></td>
+       </tr>
+       <tr>
+         <td><p>Hint</p></td>
+         <td><p><keyseq><key>Ctrl</key><key>H</key></keyseq></p></td>
+       </tr>
+       <tr>
+          <td><p>Pause</p></td>
+          <td><p><key>Pause</key></p>
+              <note><p>Use the toolbar shortcut if your keyboard does not have a <key>Pause</key> key.</p></note></td>
+       </tr>
+       <tr>
+          <td><p>Help</p></td>
+          <td><p><key>F1</key></p></td>
+        </tr>
+        <tr>
+          <td><p>Quit</p></td>
+          <td><p><keyseq><key>Ctrl</key><key>Q</key></keyseq></p></td>
+        </tr>
+      </table>
+</page>
diff --git a/gnomine/help/C/toolbar.page b/gnomine/help/C/toolbar.page
new file mode 100644
index 0000000..7078976
--- /dev/null
+++ b/gnomine/help/C/toolbar.page
@@ -0,0 +1,19 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="toolbar">
+  <info>
+    <link type="guide" xref="index#tips"/>
+    <revision version="0.1" date="2012-01-16" status="review"/>
+    <credit type="author copyright">
+      <name>Tiffany Antopolski</name>
+      <email>tiffany antopolski gmail com</email>
+      <years>2012</years>
+    </credit>
+
+  </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, <link xref="hint">Hint</link>, Pause and Fullscreen.</p>
+
+</page>
diff --git a/gnomine/help/C/translate.page b/gnomine/help/C/translate.page
new file mode 100644
index 0000000..00af0ab
--- /dev/null
+++ b/gnomine/help/C/translate.page
@@ -0,0 +1,39 @@
+<page xmlns="http://projectmallard.org/1.0/";
+	type="topic" style="task"
+	id="translate">
+
+  <info>
+   <link type="guide" xref="index#get-involved"/>
+
+    <revision pkgversion="3.4" version="0.1" date="2012-02-06" status="review"/>
+    <credit type="author copyright">
+      <name>Tiffany Antopolski</name>
+      <email>tiffany antopolski gmail com</email>
+      <years>2011</years>
+    </credit>
+     <credit type="editor">
+      <name>Michael Hill</name>
+      <email>mdhillca gmail com</email>
+    </credit>
+    <license>
+       <p>Creative Commons Share Alike 3.0</p>
+     </license>
+  </info>
+
+<title>Help translate</title>
+<p>
+  The <app>GNOME games</app> user interface and documentation is being translated by a world-wide volunteer community.  You are welcome to participate.
+</p>
+<p>
+ There are <link href="http://l10n.gnome.org/module/gnome-games/";>many languages</link> for which translations are still needed.
+</p>
+<p>
+To start translating you will need to <link href="http:l10n.gnome.org">create an account</link> and join the <link href="http://l10n.gnome.org/teams/";>translation team</link> for your language. This will give you the ability to upload new translations.
+</p>
+
+<p>
+  You can chat with GNOME translators using <link href="https://cbe003.chat.mibbit.com/?url=irc%3A%2F%2Firc.gnome.org%2Fi18n";>irc</link>. People on the channel are located worldwide, so you may not get an immediate response as a result of timezone differences.
+</p>
+<p>Alternatively, you can contact the Internationalization Team using their <link href="http://mail.gnome.org/mailman/listinfo/gnome-i18n";>mailing list</link>.
+</p>
+</page>
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]