[tali/wip/mallard-help-merge: 1/25] help: initial commit with new help



commit f71fc393e5884e161ae1ac5aec6f0123544ab80a
Author: Rashi Aswani <aswanirashi19.gmail.com>
Date:   Tue Jun 10 19:47:47 2014 +0530

    help: initial commit with new help

 help/C/figures/logo.png        |  Bin 0 -> 616 bytes
 help/C/figures/logo32.png      |  Bin 0 -> 1875 bytes
 help/C/game-settings.page      |   34 +++++++++++++++++++++++
 help/C/index.page              |   36 ++++++++++++++++++++++++
 help/C/keyboard-shortcuts.page |   29 ++++++++++++++++++++
 help/C/legal.xml               |    5 +++
 help/C/play-game.page          |   45 +++++++++++++++++++++++++++++++
 help/C/players-setting.page    |   40 +++++++++++++++++++++++++++
 help/C/score-slot.page         |   58 ++++++++++++++++++++++++++++++++++++++++
 help/C/scores.page             |   31 +++++++++++++++++++++
 help/C/start-game.page         |   28 +++++++++++++++++++
 help/Makefile.am               |   25 ++++++++++++++---
 12 files changed, 327 insertions(+), 4 deletions(-)
---
diff --git a/help/C/figures/logo.png b/help/C/figures/logo.png
new file mode 100644
index 0000000..ca2eee4
Binary files /dev/null and b/help/C/figures/logo.png differ
diff --git a/help/C/figures/logo32.png b/help/C/figures/logo32.png
new file mode 100644
index 0000000..dfbd307
Binary files /dev/null and b/help/C/figures/logo32.png differ
diff --git a/help/C/game-settings.page b/help/C/game-settings.page
new file mode 100644
index 0000000..6809baa
--- /dev/null
+++ b/help/C/game-settings.page
@@ -0,0 +1,34 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="game-setting">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+    <revision version="3.12" date="2014-06-17" status="review"/>
+
+    <credit type="author">
+      <name>Rashi Aswani</name>
+      <email>aswanirashi19 gmail com</email>
+      <years>2014</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+
+  </info>
+
+  <title>Game settings</title>
+
+  <p>You can play the regular version of the game which is similar to Yahtzee
+  or the game with colors, similar to Kismet. To switch over to another version
+  of the game:</p> 
+    <list>
+      <item><p>Select <guiseq><gui style="menu">Tali</gui>
+      <gui style="menuitem">Preferences</gui></guiseq> from the application
+      menu.</p></item>
+      <item><p>You can select the game version you want to play from the drop
+      down menu next to <gui>Game Type</gui>.</p></item>
+      <item><p>To start playing the newly selected version of the game, you
+      need to <link xref="start-game">Start a new game</link>.</p></item>
+    </list>
+</page>
+
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..645735c
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,36 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  xmlns:its="http://www.w3.org/2005/11/its";
+  id="index"
+  type="guide"
+  style="2column">
+
+  <info>
+    <title type="link" role="trail"><media type="image" its:translate="no"
+    src="figures/logo.png"/></title>
+    <title type="link">Tali</title>
+    <title type="text">Tali</title>
+    <desc>Tali help.</desc>
+    <revision version="3.12" date="2014-06-10" status="draft"/>
+    <credit type="author">
+      <name>Rashi Aswani</name>
+      <email>aswanirashi19 gmail com</email>
+    </credit>
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+  <title><media type="image" its:translate="no" src="figures/logo32.png">
+  Tali logo</media> Tali</title>
+  <p><app>Tali</app> is similar to poker with dice. You roll five dice three
+  times and try to create the best hand.</p>
+
+ <section id="play" style="2column">
+    <title>Playing Tali</title>
+  </section>
+
+  <section id="tips" style="2column">
+    <title>Useful tips</title>
+  </section>
+</page>
+
diff --git a/help/C/keyboard-shortcuts.page b/help/C/keyboard-shortcuts.page
new file mode 100644
index 0000000..7fcdbd2
--- /dev/null
+++ b/help/C/keyboard-shortcuts.page
@@ -0,0 +1,29 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="keyboard-shortcuts">
+  <info>
+    <link type="guide" xref="index#tips" />
+    <revision version="3.12" date="2014-06-09" status="review"/>
+
+    <credit type="author">
+      <name>Rashi Aswani</name>
+      <email>aswanirashi19 gmail com</email>
+      <years>2014</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+
+  </info>
+
+  <title>Keyboard shortcuts</title>
+  <p>You can play <app>tali</app> using the keyboard keys as well.</p>
+  <list>
+    <item><p>You can choose the dice to roll using keys 1 through 5, the key 1
+    corresponds to the first die and so on.</p></item>
+    <item><p>Switch to the <gui>Roll!</gui> button using <key>Tab</key>, press
+    <key>Enter</key>to roll.</p></item>
+    <item><p>You can switch to the score slots using <key>Tab</key>, navigate
+    among the score slots using the arrow keys, press <key>Enter</key> or
+    <key>spacebar</key> key to select the score slot.</p></item>
+  </list>
+</page>
diff --git a/help/C/legal.xml b/help/C/legal.xml
new file mode 100644
index 0000000..9050059
--- /dev/null
+++ b/help/C/legal.xml
@@ -0,0 +1,5 @@
+<license xmlns="http://projectmallard.org/1.0/";>
+
+<p>This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License. To view a 
copy of this license, visit <link 
xref="http://creativecommons.org/licenses/by-sa/3.0/";>http://creativecommons.org/licenses/by-sa/3.0/</link> 
or send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.</p>
+</license>
+
diff --git a/help/C/play-game.page b/help/C/play-game.page
new file mode 100644
index 0000000..6044d85
--- /dev/null
+++ b/help/C/play-game.page
@@ -0,0 +1,45 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="play-game">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+    <revision version="3.12" date="2014-06-13" status="review"/>
+
+    <credit type="author">
+      <name>Rashi Aswani</name>
+      <email>aswanirashi19 gmail com</email>
+      <years>2014</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+
+  </info>
+
+  <title>Play</title>
+
+  <p>You have to roll the five dice three times and try to create a best
+  hand. When the game starts, you see the results of the first throw of the
+  dice.</p>
+
+  <steps>
+    <item><p>Click on the dice you wish to roll. You can select all the dice to
+    roll in the second or third roll by clicking <gui>Roll all!</gui> on the
+    bottom left.</p></item>
+    <item><p>Click on <gui>Roll!</gui> to roll the selected dice.</p></item>
+    <item><p>When you have a hand you like or have run out of chances to throw
+    the dice, click on a row corresponding to what you think is your best
+    scoring combination. It is possible to have a score of zero and if you
+    click on the wrong row, you will be scored accordingly.</p></item>
+  </steps>
+  <note>
+    <p>You can only use each combination once, if you have chosen a scoring
+    combination once, you can not choose the same again.</p>
+  </note>
+  <note style="important">
+    <p>There is one exception to this rule, if you roll a <gui>5 of a
+    kind</gui> a second time, you can place it in the <gui>5 of a kind</gui>
+    row again for fifty points.You can keep doing this each time you get
+    another <gui>5 of a  kind</gui>.</p>
+  </note>
+</page>
diff --git a/help/C/players-setting.page b/help/C/players-setting.page
new file mode 100644
index 0000000..23473f1
--- /dev/null
+++ b/help/C/players-setting.page
@@ -0,0 +1,40 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="players-setting">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+    <revision version="3.12" date="2014-06-14" status="review"/>
+
+    <credit type="author">
+      <name>Rashi Aswani</name>
+      <email>aswanirashi19 gmail com</email>
+      <years>2014</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+
+  </info>
+
+  <title>Players settings</title>
+  
+  <p>You can change the number of <gui>Human Players</gui> and <gui>Computer
+  Opponents</gui>.</p>
+
+  <list>
+    <item><p>Select <guiseq><gui style="menu">Tali</gui>
+    <gui style="menuitem">Preferences</gui></guiseq> from the application menu.
+    </p></item>
+    <item><p>You can increase or decrease the number of <gui>Human
+    Players</gui> from <gui>Number of players</gui>. The maximum number of
+    players can be six. You can change their names as well from
+    <gui>Player Names</gui>.</p></item>
+    <item><p>You can change the number of <gui>Computer Opponents</gui> from
+    <gui>Number of opponents</gui> and set the difficulty level of the opponent
+    from the drop down menu next to <gui>Difficulty</gui>.</p></item>
+    <item><p>You can also enable the delay between the rolls by checking the
+    <gui style="checkbox">Delay between rolls</gui>.</p></item>
+  </list>
+
+</page>
+
diff --git a/help/C/score-slot.page b/help/C/score-slot.page
new file mode 100644
index 0000000..e777e96
--- /dev/null
+++ b/help/C/score-slot.page
@@ -0,0 +1,58 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="score-slot">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+    <revision version="3.12" date="2014-06-14" status="review"/>
+
+    <credit type="author">
+      <name>Rashi Aswani</name>
+      <email>aswanirashi19 gmail com</email>
+      <years>2014</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+
+  </info>
+
+  <title>Score slots</title>
+
+  <p>You can choose a score slot from the seven available score slots:</p>
+  <terms>
+    <item>
+      <title>3 of a kind</title>
+      <p>Three of the dice have the same number. The score is the total of all
+      the dice. For example: 3, 4, 4, 4, 6.</p>
+    </item>
+    <item>
+      <title>4 of a kind</title>
+      <p>Four of the dice have the same number. The score is the total of all
+      the dice. For example: 2, 5, 5, 5, 5. In the Colors game, the score is 25
+      plus the total of all the dice.</p>
+    </item>
+    <item>
+      <title>Full House</title>
+      <p>Five dice consisting of two groups: One group of three with the same
+      numbers and another group of two with the same numbers. For example: 1,
+      1, 1, 4, 4. In the Colors game, the score is 15 plus the total of all
+      the dice.</p>
+    </item>
+    <item>
+      <title>Small Straight</title>
+      <p>Four dice with consecutive numbers. The fifth die can be any number.
+      For example: 2, 3, 4, 5, 5. This category is only used in the regular
+      game. The score is 30 points.</p>
+    </item>
+    <item>
+      <title>Large Straight</title>
+      <p>Five dice with consecutive numbers. For example: 2, 3, 4, 5, 6. The
+      score is 40 points.</p>
+    </item>
+    <item>
+      <title>5 of a Kind</title>
+      <p>Five identical dice. For example: 3, 3, 3, 3, 3. In the Colors game,
+      the score is 50 plus the total of all the dice.</p>
+    </item>
+  </terms>    
+</page>
diff --git a/help/C/scores.page b/help/C/scores.page
new file mode 100644
index 0000000..3da2204
--- /dev/null
+++ b/help/C/scores.page
@@ -0,0 +1,31 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="scores">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+    <revision version="3.12" date="2014-06-11" status="review"/>
+
+    <credit type="author">
+      <name>Rashi Aswani</name>
+      <email>aswanirashi19 gmail com</email>
+      <years>2014</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+
+  </info>
+
+  <title>Scores</title>
+
+  <p>You can check out your scores of the games played so far:</p>
+    <list>
+      <item><p>Select <guiseq><gui style="menu">Tali</gui>
+      <gui style="menuitem">Scores</gui></guiseq> from the application menu.
+      </p></item>
+      <item><p> The dialog will display the <gui>Regular</gui> version by
+      default, to view scores obtained in <gui>Colors</gui>, select it from the
+      drop down menu at the top of the dialog.</p></item>
+    </list>
+</page>
+
diff --git a/help/C/start-game.page b/help/C/start-game.page
new file mode 100644
index 0000000..f21b020
--- /dev/null
+++ b/help/C/start-game.page
@@ -0,0 +1,28 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="start-game">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+    <revision version="3.12" date="2014-06-11" status="review"/>
+
+    <credit type="author">
+      <name>Rashi Aswani</name>
+      <email>aswanirashi19 gmail com</email>
+      <years>2014</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+
+  </info>
+
+  <title>Start a new game</title>
+
+  <p>You can start a new game anytime in between the game. To start a new
+  game:</p>
+    <list>
+      <item><p>Select <guiseq><gui style="menu">Tali</gui>
+      <gui style="menuitem">New Game</gui></guiseq> from the application menu.
+      </p></item>
+    </list>
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index 0da096b..947cd0f 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -2,13 +2,30 @@
 HELP_ID = tali
 
 HELP_MEDIA = \
-       figures/mainwindow.png \
-       figures/preferences.png
+       figures/logo32.png \
+       figures/logo.png
 
 HELP_FILES = \
-       index.docbook \
+       index.page \
+       start-game.page \
+       play-game.page \
+       score-slot.page \
+       players-setting.page \
+       game-settings.page \
+       scores.page \
+       keyboard-shortcuts.page \
+
+HELP_FILES = \
+       index.page \
+       start-game.page \
+       play-game.page \
+       score-slot.page \
+       players-setting.page \
+       game-settings.page \
+       scores.page \
+       keyboard-shortcuts.page \
        legal.xml
 
-HELP_LINGUAS = ca cs da de el en_GB es eu fr gl it oc pt_BR ru sl sr sr latin sv zh_CN
+HELP_LINGUAS =
 
 -include $(top_srcdir)/git.mk


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