GNOME.org
 

[gnome-games] mahjongg/help: Almost final changes to docs.

commit becfb97a6236588490a795b508789ebed012654f
Author: Tiffany Antopolski <tiffany antopolski gmail com>
Date:   Sat Jan 7 01:20:49 2012 -0500

    mahjongg/help: Almost final changes to docs.

 mahjongg/help/C/gameplay.page  |   20 +-
 mahjongg/help/C/hints.page     |    3 +-
 mahjongg/help/C/index.page     |    7 +-
 mahjongg/help/C/mahjongg.xml   |  758 ----------------------------------------
 mahjongg/help/C/map.page       |   26 ++
 mahjongg/help/C/moves.page     |    4 +-
 mahjongg/help/C/pause.page     |   12 +-
 mahjongg/help/C/rules.page     |   31 ++
 mahjongg/help/C/scoring.page   |    7 +-
 mahjongg/help/C/shortcuts.page |   38 ++-
 mahjongg/help/C/strategy.page  |   19 +
 mahjongg/help/C/toolbar.page   |    4 +-
 mahjongg/help/C/topic.dat      |    1 -
 mahjongg/help/Makefile.am      |   12 +-
 14 files changed, 154 insertions(+), 788 deletions(-)
---
diff --git a/mahjongg/help/C/gameplay.page b/mahjongg/help/C/gameplay.page
index 61341c7..ee1a22b 100644
--- a/mahjongg/help/C/gameplay.page
+++ b/mahjongg/help/C/gameplay.page
@@ -3,23 +3,33 @@
   id="gameplay">
       
   <info>
-    <link type="guide" xref="index"/>
-    <desc>Introduction to <app>Mahjongg</app>.</desc>
+    <link type="guide" xref="index#play"/>
     <revision pkgversion="3.2.1" version="0.1" date="2011-12-30" status="draft"/>
    <credit type="author">
     <name>Chris Beiser</name>
     <email>ctbeiser gmail com</email>
    </credit>
+   <credit type="editor">
+     <name>Tiffany Antopolski</name>
+     <email>tiffany antopolski gmail com</email>
+   </credit>
    <license>
      <p>Creative Commons Share Alike 3.0</p>
    </license>
   </info>
 
-  <title>Gameplay</title>
+  <title>Basic gameplay</title>
     <p>
-	Mahjongg is played by matching identical tiles in order to make them disappear. The only tiles eligible for matching are uncovered tiles with a free side on either the left or the right. You win by removing all tiles, and you are scored by the amount of time it takes you to do so.
+	Mahjongg is played by matching two identical tiles per turn. A tile is eligible for matching if no part of another tile is lying directly on it, and it has a free long edge on either the left or the right. You win by removing all tiles, and you are scored by the amount of time it takes you to do so.
     </p>
- 
+    <p>
+      To match two tiles:
+    </p> 
+    <steps>
+     <item><p>Click on the a tile you want to match. If it is an eligible tile, it will be highlighted.</p></item>
+     <item><p>Click on a matching tile. If it is a truely a matching tile, both tiles will vanish.</p></item>
+    </steps>
+    
     <section id="usage-video">
       <title>Video demonstration</title>
        <media type="video" mime="application/ogg" src="figures/mahjongg-video.ogv">
diff --git a/mahjongg/help/C/hints.page b/mahjongg/help/C/hints.page
index 95b6876..f831d44 100644
--- a/mahjongg/help/C/hints.page
+++ b/mahjongg/help/C/hints.page
@@ -3,8 +3,7 @@
   id="hints">
       
   <info>
-    <link type="guide" xref="index#play"/>
-    <desc>Hint shows two tiles that can be matched.</desc>
+    <link type="guide" xref="index#tips"/>
     <revision pkgversion="3.2.1" version="0.1" date="2011-12-30" status="stub"/>
    <credit type="author">
     <name>Chris Beiser</name>
diff --git a/mahjongg/help/C/index.page b/mahjongg/help/C/index.page
index daaa8c1..380af03 100644
--- a/mahjongg/help/C/index.page
+++ b/mahjongg/help/C/index.page
@@ -19,13 +19,16 @@
   </info>
 
  <title><media type="image" src="figures/logo32.png">Mahjongg logo</media>Mahjongg</title>
+  <p>
+  Mahjongg is a simple pattern recognition game. You score points by matching identical tiles.
+  </p>
 
   <section id="play" style="2column">
     <title>Playing Mahjongg</title>
   </section>
 
-  <section id="using" style="2column">
-    <title>Using Mahjongg</title>
+  <section id="tips" style="2column">
+    <title>Useful tips</title>
   </section>
 
 
diff --git a/mahjongg/help/C/map.page b/mahjongg/help/C/map.page
new file mode 100644
index 0000000..e1144a6
--- /dev/null
+++ b/mahjongg/help/C/map.page
@@ -0,0 +1,26 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="map">
+  <info>
+    <link type="guide" xref="index#play"/>
+    <revision version="0.1" date="2012-01-06" status="stub"/>
+
+    <credit type="author copyright">
+      <name>Tiffany Antopolski</name>
+      <email>tiffany antopolski gmail com</email>
+      <years>2012</years>
+    </credit>
+
+  </info>
+
+  <title>Change tile layout</title>
+
+  <p>To select a different tile layout:</p>
+  <steps>
+   <item><p>Click <guiseq><gui>Settings</gui><gui>Preferences</gui></guiseq>.</p></item>
+   <item><p>Under <gui>Maps</gui> select a layout from the drop-down menu.</p></item>
+   <item><p>Click <gui>Close</gui></p></item>
+  </steps>
+
+  <p>Your new tile layout will take effect immediately.</p>
+</page>
diff --git a/mahjongg/help/C/moves.page b/mahjongg/help/C/moves.page
index 127fd48..9c3953e 100644
--- a/mahjongg/help/C/moves.page
+++ b/mahjongg/help/C/moves.page
@@ -3,7 +3,7 @@
   id="moves">
       
   <info>
-    <link type="guide" xref="index#using"/>
+    <link type="guide" xref="index#tips"/>
     <!--desc></desc-->
     <revision pkgversion="3.2.1" version="0.1" date="2011-12-30" status="incomplete"/>
    <credit type="author">
@@ -17,7 +17,7 @@
 
   <title>Moves left</title>
 
-  <p>The <gui>Moves Left</gui> counter, located in the bottom of the <app>Mahjongg</app> window, shows the number of different moves that can be made. It can help you see how far you are from running out of moves, and whether you've seen all possible moves.
+  <p>The <gui>Moves Left</gui> counter is located in the <link xref="toolbar">toolbar</link>. Itdisplays the number of different moves that can be made. It can help you see how far you are from running out of moves, and whether you've seen all possible moves.
   </p>
 
 <media type="image" src="figures/moves-left.png">
diff --git a/mahjongg/help/C/pause.page b/mahjongg/help/C/pause.page
index 723f9e8..795ed3f 100644
--- a/mahjongg/help/C/pause.page
+++ b/mahjongg/help/C/pause.page
@@ -3,7 +3,7 @@
   id="startstop">
       
   <info>
-    <link type="guide" xref="index#using"/>
+    <link type="guide" xref="index#tips"/>
     
     <revision pkgversion="3.2.1" version="0.1" date="2011-12-30" status="stub"/>
    <credit type="author">
@@ -15,8 +15,14 @@
    </license>
   </info>
 
-  <title>Start, restart &amp; pause games</title>
-
+  <title>Pausing your game</title>
+  
   <p>
+    You can pause your current game using one of the following methods:
   </p>
+  <steps>
+    <item><p>Using the <gui>Pause</gui> button on the <link xref="toolbar">toolbar</link>.</p></item>
+    <item><p>Using the <key>Pause</key> key on your keyboard.  Not all keyboards have this key.</p></item>
+    <item><p>Using the <link xref="shortcuts">keyboard shortcut</link>.</p></item>
+  </steps>
 </page>
diff --git a/mahjongg/help/C/rules.page b/mahjongg/help/C/rules.page
new file mode 100644
index 0000000..e1bb876
--- /dev/null
+++ b/mahjongg/help/C/rules.page
@@ -0,0 +1,31 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="topic"
+  id="eligible">
+      
+  <info>
+    <link type="guide" xref="index#play"/>
+    <revision pkgversion="3.2.1" version="0.1" date="2011-12-30" status="stub"/>
+   <credit type="author">
+    <name>Chris Beiser</name>
+    <email>ctbeiser gmail com</email>
+   </credit>
+   <credit type="editor">
+     <name>Tiffany Antopolski</name>
+     <email>tiffany antopolski gmail com</email>
+   </credit>
+   <license>
+     <p>Creative Commons Share Alike 3.0</p>
+   </license>
+  </info>
+
+  <title>Rules</title>
+   <list>
+    <item><p>Tiles must be identical to be vanished.</p></item>
+    <item><p>Fully and partially covered tiles can not be matched.</p></item>
+    <item><p>Tiles must have a free long edge in order to be eligible for matching.</p></item>
+    <item><p>You can undo a move without penalty.</p></item>
+    <item><p>Using the <link xref="hints">hint</link> option adds a 30 second penalty to your time.</p></item>
+    <item><p>If the arrangement does not allow for further tiles to be matched, you will be given the option to shuffle the tiles in order to keep playing.</p></item>
+    <item><p>Shuffling tiles adds a 60 second penalty to your time.</p></item>
+   </list>
+</page>
diff --git a/mahjongg/help/C/scoring.page b/mahjongg/help/C/scoring.page
index 1982728..4610a87 100644
--- a/mahjongg/help/C/scoring.page
+++ b/mahjongg/help/C/scoring.page
@@ -4,7 +4,6 @@
       
   <info>
     <link type="guide" xref="index#play"/>
-    <desc>In <app>Mahjongg</app>, you are scored by how quickly you can complete a board.</desc>
     <revision pkgversion="3.2.1" version="0.1" date="2011-12-30" status="stub"/>
    <credit type="author">
     <name>Chris Beiser</name>
@@ -15,8 +14,8 @@
    </license>
   </info>
 
-  <title>Scores &amp; the timer</title>
+  <title>Scoring</title>
 
-  <p>
-  </p>
+    <p>In <app>Mahjongg</app>, you are scored by how quickly you can complete a board.</p>
+    <p>You can view the highscore board by clicking <guiseq><gui>Game</gui><gui>Scores</gui></guiseq>.  The scores are stored on a per <link xref="map">map</link> basis.  You can view the highscores for a particular map by selecting it from the drop-down menu. </p> 
 </page>
diff --git a/mahjongg/help/C/shortcuts.page b/mahjongg/help/C/shortcuts.page
index 476b3ea..d9da50a 100644
--- a/mahjongg/help/C/shortcuts.page
+++ b/mahjongg/help/C/shortcuts.page
@@ -16,7 +16,39 @@
   </info>
 
   <title>Keyboard shortcuts</title>
-
-  <p>
-  </p>
+     <table frame="all" rules="cols" shade="rows">
+       <tr>
+         <td><p>Fullscreen</p></td>
+         <td><p><key>F11</key></p></td>
+       </tr>
+       <tr>
+          <td><p>Help</p></td>
+          <td><p><key>F1</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>New game</p></td>
+         <td><p><keyseq><key>Ctrl</key><key>N</key></keyseq></p></td>
+       </tr>
+       <tr>
+          <td><p>Pause</p></td>
+          <td><p><key>Pause</key></p>
+              <note><p>Use the <link xref="toolbar">toolbar</link> shortcut if your keyboard does not have a <key>Pause</key> key.</p></note></td>
+       </tr>
+       <tr>
+          <td><p>Quit</p></td>
+          <td><p><keyseq><key>Ctrl</key><key>Q</key></keyseq></p></td>
+       </tr>
+       <tr>
+          <td><p>Redo</p></td>
+          <td><p><keyseq><key>Shift</key><key>Ctrl</key><key>Z</key></keyseq></p></td>
+       </tr>
+       <tr>
+          <td><p>Undo</p></td>
+          <td><p><keyseq><key>Ctrl</key><key>Z</key></keyseq></p></td>
+       </tr>
+</table>
 </page>
diff --git a/mahjongg/help/C/strategy.page b/mahjongg/help/C/strategy.page
new file mode 100644
index 0000000..30d0958
--- /dev/null
+++ b/mahjongg/help/C/strategy.page
@@ -0,0 +1,19 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="strategy">
+  <info>
+    <link type="guide" xref="index#play" />
+    <revision version="0.1" date="2011-12-10" status="stub"/>
+
+    <credit type="author copyright">
+      <name></name>
+      <email></email>
+      <years>2011</years>
+    </credit>
+
+    <desc></desc>
+  </info>
+
+  <title>Strategy</title>
+
+</page>
diff --git a/mahjongg/help/C/toolbar.page b/mahjongg/help/C/toolbar.page
index 5d44c35..6274c42 100644
--- a/mahjongg/help/C/toolbar.page
+++ b/mahjongg/help/C/toolbar.page
@@ -2,7 +2,7 @@
       type="topic" style="task"
       id="toolbar">
   <info>
-    <link type="guide" xref="index#using"/>
+    <link type="guide" xref="index#tips"/>
     <revision version="0.1" date="2011-12-31" status="stub"/>
     <credit type="author copyright">
       <name>Tiffany Antopolski</name>
@@ -16,6 +16,6 @@
   <title>Show/hide the toolbar</title>
 <p>To show or hide the toolbar, click <guiseq><gui>Settings</gui><gui>Toolbar</gui></guiseq>.</p>
 
-<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="undo">Undo Move</link>, <link xref="hints">Hint</link> and Pause.</p>
+<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 Move, <link xref="hints">Hint</link> and Pause.</p>
 
 </page>
diff --git a/mahjongg/help/Makefile.am b/mahjongg/help/Makefile.am
index 99c5b4d..0f83446 100644
--- a/mahjongg/help/Makefile.am
+++ b/mahjongg/help/Makefile.am
@@ -18,19 +18,19 @@ DOC_PAGES = \
 	commandline.page		\
 	develop.page			\
 	documentation.page		\
-	eligible.page			\
 	gameplay.page			\
-	highscoretable.page		\
 	hints.page			\
 	index.page			\
 	license.page			\
+	map.page			\
 	moves.page			\
+	pause.page			\
+	rules.page			\
 	scoring.page			\
-	shuffling.page			\
-	starting.page			\
+	shortcuts.page			\
+	strategy.page			\
 	toolbar.page			\
-	translate.page			\
-	undo.page
+	translate.page
 
 DOC_LINGUAS = ca cs da el en_GB es eu fr it oc pl ru sl sr sr latin sv de zh_CN
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]