[four-in-a-row] Changed user-help to Mallard



commit 690ebac66b404bcad3b00ce6f81b8759892ec9fd
Author: Aruna Sankaranarayanan <arunasank src gnome org>
Date:   Fri Mar 29 17:02:32 2013 +0530

    Changed user-help to Mallard
    
    Added 9 new pages to Mallard documentation for Four-in-a-row.
    These are appearance.page, basics.page, choose-opponent.page
    controls-change.page, controls-default.page, index.page,
    make-easy.page, scores.page, sound-animation.page
    Edited ../Makefile.am
    Added a new image to help/C/figures - logo.png.
    Removed trailing whitespaces and made text 80 characters compliant
    Changed contents of legal.xml to CC-by-SA.

 help/C/appearance.page       |   40 ++++
 help/C/basics.page           |   53 +++++
 help/C/choose-opponent.page  |   54 +++++
 help/C/controls-change.page  |   55 +++++
 help/C/controls-default.page |   40 ++++
 help/C/figures/logo.png      |  Bin 0 -> 562 bytes
 help/C/index.docbook         |  515 ------------------------------------------
 help/C/index.page            |   33 +++
 help/C/legal.xml             |   82 +------
 help/C/make-easy.page        |   55 +++++
 help/C/scores.page           |   57 +++++
 help/C/sound-animation.page  |   41 ++++
 help/Makefile.am             |   13 +-
 13 files changed, 445 insertions(+), 593 deletions(-)
---
diff --git a/help/C/appearance.page b/help/C/appearance.page
new file mode 100644
index 0000000..d062756
--- /dev/null
+++ b/help/C/appearance.page
@@ -0,0 +1,40 @@
+<page xmlns="http://projectmallard.org/1.0/";
+       type="topic" style="task"
+       id="appearance">
+
+  <info>
+    <link type="guide" xref="index#preferences"/>
+
+    <revision pkgversion="3.8" version="0.1" date="2013-03-29" status="draft"/>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <credit type="author">
+      <name>Aruna Sankaranarayanan</name>
+      <email>safincrazy gmail com</email>
+    </credit>
+
+    <desc>Use different themes to improve your gaming experience.</desc>
+  </info>
+
+  <title>Change the appearance of your gaming area</title>
+
+  <p>By default, <app>Four-in-a-row</app> uses solid red and blue marbles
+  against a black grid when you start a new game. In order to use a different
+  theme:</p>
+
+  <steps>
+    <item>
+      <p>Select <guiseq><gui style="menu">Settings</gui>
+      <gui style="menuitem">Preferences</gui>
+      <gui style="menuitem">Game</gui></guiseq>.</p>
+    </item>
+    <item>
+      <p>Under <gui>Appearance</gui>, you will see
+      <gui style="group">Theme</gui>. Pick the theme of your choice from
+      the drop down menu present on the right of <gui>Theme</gui>. The change
+      will be reflected immediately in the game window.</p>
+    </item>
+  </steps>
+
+</page>
diff --git a/help/C/basics.page b/help/C/basics.page
new file mode 100644
index 0000000..4b2d408
--- /dev/null
+++ b/help/C/basics.page
@@ -0,0 +1,53 @@
+<page xmlns="http://projectmallard.org/1.0/";
+       type="topic" style="task"
+       id="basics">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+
+    <revision pkgversion="3.8" version="0.1" date="2013-03-29" status="draft"/>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <credit type="author">
+      <name>Aruna Sankaranarayanan</name>
+      <email>safincrazy gmail com</email>
+    </credit>
+
+    <desc> Start, play in fullscreen mode and quit a game of
+    <app>Four-in-a-row</app>.</desc>
+  </info>
+
+  <title>Basic instructions</title>
+
+<section id="start">
+  <title>Start a new game</title>
+
+  <p>Select <guiseq><gui style="menu">Game</gui>
+  <gui style="menuitem">New</gui></guiseq>
+  or press <keyseq><key>Ctrl</key><key>N</key></keyseq> to start a new
+  game.</p>
+
+</section>
+
+<section id="fullscreen">
+  <title>Play <app>Four-in-a-row</app> in fullscreen mode</title>
+
+  <p>Select <guiseq><gui style="menu">View</gui>
+  <gui style="menuitem">Fullscreen</gui></guiseq> or press <key>F11</key> to
+  play your game in fullscreen mode. You can return to the default screen size
+  by pressing <key>F11</key> again.</p>
+
+</section>
+
+<section id="quit">
+  <title>Quit <app>Four-in-a-row</app></title>
+
+  <p> Select <guiseq><gui style="menu">Game</gui>
+  <gui style="menuitem">Quit</gui></guiseq> or press
+  <keyseq><key>Ctrl</key><key>Q</key></keyseq> to quit <app>Four-in-a-row</app>
+  at any time.</p>
+
+</section>
+
+</page>
diff --git a/help/C/choose-opponent.page b/help/C/choose-opponent.page
new file mode 100644
index 0000000..6326610
--- /dev/null
+++ b/help/C/choose-opponent.page
@@ -0,0 +1,54 @@
+<page xmlns="http://projectmallard.org/1.0/";
+       type="topic" style="task"
+       id="choose-opponent">
+
+  <info>
+    <link type="guide" xref="index#preferences"/>
+
+    <revision pkgversion="3.8" version="0.1" date="2013-03-29" status="draft"/>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <credit type="author">
+      <name>Aruna Sankaranarayanan</name>
+      <email>safincrazy gmail com</email>
+    </credit>
+
+    <desc>Change the level at which the computer plays or play with a
+    friend.</desc>
+  </info>
+
+  <title>Choose a different opponent to play with</title>
+  <p>By default, your opponent in <app>Four-in-a-row</app> is the computer,
+  playing at level 1. To change this level or to play with a friend:</p>
+
+  <steps>
+    <item>
+      <p>Select <guiseq><gui style="menu">Settings</gui>
+      <gui style="menuitem">Preferences</gui>
+      <gui style="menuitem">Game</gui></guiseq>.</p>
+    </item>
+    <item>
+      <p>You will see <gui>Player One</gui> and <gui>Player Two</gui>. Under
+      each player, you can see the color of his marbles or blocks during the
+      game. Choose <gui style="radiobutton">Human</gui> if want to play with a
+      friend or family member. Alternatively, if you want to play against the
+      computer and want to change the level at which the computer plays, you
+      can choose between <gui style="radiobutton">Level one</gui>,
+      <gui style="radiobutton">Level two</gui> or
+      <gui style="radiobutton">Level three</gui>, where
+      <gui style="radiobutton">Level one</gui> is the
+      easiest level and <gui style="radiobutton">Level three</gui> is the most
+      difficult level.</p>
+      <note style="tip">
+       <p>If you are playing with a friend or family member,
+       <gui>Player One</gui> gets to play first in the first game of
+       <app>Four-in-a-row</app>. In subsequent games, the chance to play first
+       is given alternately to each player. So, <gui>Player Two</gui> will get
+       to play first in the second game, <gui>Player One</gui> can play first
+       in the third game and so on.</p>
+      </note>
+    </item>
+  </steps>
+
+</page>
diff --git a/help/C/controls-change.page b/help/C/controls-change.page
new file mode 100644
index 0000000..cc8cba2
--- /dev/null
+++ b/help/C/controls-change.page
@@ -0,0 +1,55 @@
+<page xmlns="http://projectmallard.org/1.0/";
+       type="topic" style="task"
+       id="controls-change">
+
+  <info>
+    <link type="guide" xref="index#preferences"/>
+
+    <link type="seealso" xref="controls-default"/>
+
+    <revision pkgversion="3.8" version="0.1" date="2013-03-29" status="draft"/>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <credit type="author">
+      <name>Aruna Sankaranarayanan</name>
+      <email>safincrazy gmail com</email>
+    </credit>
+
+    <desc>Set custom control keys.</desc>
+  </info>
+
+  <title>Change the default controls</title>
+
+  <p>To change the <link xref="controls-default">default controls</link> in
+  <app>Four-in-a-row</app>: </p>
+
+  <steps>
+    <item>
+      <p>Select <guiseq><gui style="menu">Settings</gui>
+      <gui style="menuitem">Preferences</gui>
+      <gui style="menuitem">Keyboard Controls</gui></guiseq>.</p>
+    </item>
+    <item>
+      <p>In the list, select the line you want to change, then click on the
+      control. This highlights the line and the words
+      <gui>New accelerator…</gui> are now present in place of the
+      old control.</p>
+    </item>
+    <item>
+      <p>Press the key you want to use instead of the default key.</p>
+      <note style="tip">
+        <p>To keep the old setting click <gui>New accelerator…</gui> again,
+        right click on <gui>New accelerator…</gui>, press <key>Esc</key> or
+        click anywhere else inside the <gui>Keyboard Controls</gui> box.</p>
+      </note>
+    </item>
+  </steps>
+
+  <note style="info">
+    <p>When you are playing with a friend or a family member, both players
+    will share the same set of controls, to be used alternately during your
+    respective turns.</p>
+  </note>
+
+</page>
diff --git a/help/C/controls-default.page b/help/C/controls-default.page
new file mode 100644
index 0000000..f570645
--- /dev/null
+++ b/help/C/controls-default.page
@@ -0,0 +1,40 @@
+<page xmlns="http://projectmallard.org/1.0/";
+       type="topic" style="task"
+       id="controls-default">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+
+    <link type="seealso" xref="controls-change"/>
+
+    <revision pkgversion="3.8" version="0.1" date="2013-03-29" status="draft"/>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <credit type="author">
+      <name>Aruna Sankaranarayanan</name>
+      <email>safincrazy gmail com</email>
+    </credit>
+
+    <desc>Default controls for <app>Four-in-a-row</app>.</desc>
+  </info>
+
+  <title>Controls</title>
+
+  <p>You can use your mouse and click on a particular square in the game area
+  to drop your marble into that square. If you want to use the keyboard
+  instead, the default keys for <app>Four-in-a-row</app> are:</p>
+
+  <list>
+    <item>
+      <p><key>&#8592;</key> to move the marble to your left.</p>
+    </item>
+    <item>
+      <p><key>&#8594;</key> to move the marble to your right.</p>
+    </item>
+    <item>
+      <p><key>&#8595;</key> to drop the marble.</p>
+    </item>
+  </list>
+
+</page>
diff --git a/help/C/figures/logo.png b/help/C/figures/logo.png
new file mode 100644
index 0000000..b58b0ea
Binary files /dev/null and b/help/C/figures/logo.png differ
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..768af06
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,33 @@
+<page xmlns="http://projectmallard.org/1.0/";
+       type="guide" style="task"
+       id="index">
+
+  <info>
+    <revision pkgversion="3.8" version="0.1" date="2013-03-29" status="draft"/>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <credit type="author">
+      <name>Aruna Sankaranarayanan</name>
+      <email>safincrazy gmail com</email>
+    </credit>
+
+    <desc>Index</desc>
+  </info>
+
+  <title><media type="image" src="figures/logo.png" width="22" height="22">
+  </media>Four-in-a-row</title>
+
+  <p><app>Four-in-a-row</app> is a strategy game for GNOME. The aim of the
+  game is to stack four of your marbles in a horizontal, vertical or diagonal
+  line while stopping your opponent from doing the same with their marbles.</p>
+
+  <section id="play" style="2column">
+    <title>Game play</title>
+  </section>
+
+  <section id="preferences" style="2column">
+    <title>Preferences</title>
+  </section>
+
+</page>
diff --git a/help/C/legal.xml b/help/C/legal.xml
index 899282c..09cd8c8 100644
--- a/help/C/legal.xml
+++ b/help/C/legal.xml
@@ -1,76 +1,6 @@
-  <legalnotice id="legalnotice">
-       <para>
-         Permission is granted to copy, distribute and/or modify this
-         document under the terms of the GNU Free Documentation
-         License (GFDL), Version 1.1 or any later version published
-         by the Free Software Foundation with no Invariant Sections,
-         no Front-Cover Texts, and no Back-Cover Texts.  You can find
-         a copy of the GFDL at this <ulink type="help"
-         url="help:fdl">link</ulink> or in the file COPYING-DOCS
-         distributed with this manual.
-         </para>
-         <para> This manual is part of a collection of GNOME manuals
-          distributed under the GFDL.  If you want to distribute this
-          manual separately from the collection, you can do so by
-          adding a copy of the license to the manual, as described in
-          section 6 of the license.
-       </para>
-
-       <para>
-         Many of the names used by companies to distinguish their
-         products and services are claimed as trademarks. Where those
-         names appear in any GNOME documentation, and the members of
-         the GNOME Documentation Project are made aware of those
-         trademarks, then the names are in capital letters or initial
-         capital letters.
-       </para>
-
-       <para>
-         DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED
-         UNDER  THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE
-         WITH THE FURTHER UNDERSTANDING THAT:
-
-         <orderedlist>
-               <listitem>
-                 <para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS,
-                    WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
-                    IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES
-                    THAT THE DOCUMENT OR MODIFIED VERSION OF THE
-                    DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR
-                    A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE
-                    RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE
-                    OF THE DOCUMENT OR MODIFIED VERSION OF THE
-                    DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR
-                    MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT,
-                    YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY
-                    CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY
-                    SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER
-                    OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
-                    LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED
-                    VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER
-                    EXCEPT UNDER THIS DISCLAIMER; AND
-                 </para>
-               </listitem>
-               <listitem>
-                 <para>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL
-                       THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE),
-                       CONTRACT, OR OTHERWISE, SHALL THE AUTHOR,
-                       INITIAL WRITER, ANY CONTRIBUTOR, OR ANY
-                       DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION
-                       OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH
-                       PARTIES, BE LIABLE TO ANY PERSON FOR ANY
-                       DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR
-                       CONSEQUENTIAL DAMAGES OF ANY CHARACTER
-                       INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS
-                       OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR
-                       MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR
-                       LOSSES ARISING OUT OF OR RELATING TO USE OF THE
-                       DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT,
-                       EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF
-                       THE POSSIBILITY OF SUCH DAMAGES.
-                 </para>
-               </listitem>
-         </orderedlist>
-       </para>
-  </legalnotice>
-
+<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-ShareAlike 3.0 Unported License</link>.</p>
+</license>
diff --git a/help/C/make-easy.page b/help/C/make-easy.page
new file mode 100644
index 0000000..dfea585
--- /dev/null
+++ b/help/C/make-easy.page
@@ -0,0 +1,55 @@
+<page xmlns="http://projectmallard.org/1.0/";
+       type="topic" style="task"
+       id="make-easy">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+
+    <revision pkgversion="3.8" version="0.1" date="2013-03-29" status="draft"/>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <credit type="author">
+      <name>Aruna Sankaranarayanan</name>
+      <email>safincrazy gmail com</email>
+    </credit>
+
+    <desc>Use hints or undo your wrong moves.</desc>
+  </info>
+
+  <title>Make your game a little easier</title>
+
+<section id="undo">
+  <title>Change your last move</title>
+
+  <p>When the computer makes a winning move because of your last move or when
+  you accidentally make the wrong move, you can undo your last move and change
+  it. To undo your last move, select <guiseq><gui style="menu">Game</gui>
+  <gui style="menuitem">Undo Move</gui></guiseq> or press
+  <keyseq><key>Ctrl</key><key>Z</key></keyseq>. You can now drop your marble at
+  a different square in the game area to change your move.</p>
+
+  <note style="info">
+    <p>You can undo all your moves starting from your current move till you
+    reach a favourable state of the game or till the beginning of your current
+    game by pressing <keyseq><key>Ctrl</key><key>Z</key></keyseq>
+    repeatedly.</p>
+  </note>
+</section>
+
+<section id="hint">
+  <title>Use hints</title>
+
+  <p>If you are not sure of your next move, you can use a hint. On using one,
+  your marble moves to the top of the column that is the best choice
+  strategy-wise and blinks. You can then drop your marble in that column. To
+  use a hint select <guiseq><gui style="menu">Game</gui>
+  <gui style="menuitem">Hint</gui></guiseq> or press
+  <keyseq><key>Ctrl</key><key>H</key></keyseq>.</p>
+
+  <note style="info">
+  <p>There is no limit on the number of hints you can use in a game.</p>
+  </note>
+</section>
+
+</page>
diff --git a/help/C/scores.page b/help/C/scores.page
new file mode 100644
index 0000000..3eca6d8
--- /dev/null
+++ b/help/C/scores.page
@@ -0,0 +1,57 @@
+<page xmlns="http://projectmallard.org/1.0/";
+       type="topic" style="task"
+       id="scores">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+
+    <revision pkgversion="3.8" version="0.1" date="2013-03-29" status="draft"/>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <credit type="author">
+      <name>Aruna Sankaranarayanan</name>
+      <email>safincrazy gmail com</email>
+    </credit>
+
+    <desc>Keep track of your wins and losses.</desc>
+  </info>
+
+  <title>Scores</title>
+  <p>The score in <app>Four-in-a-row</app> is recorded in terms of your wins,
+  your opponent's wins and games that ended in a draw. To check the scores,
+  select <guiseq><gui style="menu">Game</gui>
+  <gui style="menuitem">Scores</gui></guiseq>. If you are playing against the
+  computer, the number next to:</p>
+
+  <list>
+    <item>
+      <p><gui>You</gui> displays the number of games you have won.</p>
+    </item>
+    <item>
+      <p><gui>Me</gui> displays the number of games won by the computer.</p>
+    </item>
+    <item>
+      <p><gui>Drawn</gui> displays the number of games that ended in a
+      draw.</p>
+    </item>
+  </list>
+
+  <p>If you are playing against a friend, the number next to:</p>
+
+  <list>
+    <item>
+      <p><gui>Red</gui> displays the number of games won by the player who was
+      controlling the red marbles.</p>
+    </item>
+    <item>
+      <p><gui>Blue</gui> displays the number of games won by the player who
+      was controlling the blue marbles.</p>
+    </item>
+    <item>
+      <p><gui>Drawn</gui> displays the number of games that ended in a
+      draw.</p>
+    </item>
+  </list>
+
+</page>
diff --git a/help/C/sound-animation.page b/help/C/sound-animation.page
new file mode 100644
index 0000000..517c8c3
--- /dev/null
+++ b/help/C/sound-animation.page
@@ -0,0 +1,41 @@
+<page xmlns="http://projectmallard.org/1.0/";
+       type="topic" style="task"
+       id="sound-animation">
+
+  <info>
+    <link type="guide" xref="index#preferences"/>
+
+    <revision pkgversion="3.8" version="0.1" date="2013-03-29" status="draft"/>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+    <credit type="author">
+      <name>Aruna Sankaranarayanan</name>
+      <email>safincrazy gmail com</email>
+    </credit>
+
+    <desc>Play <app>Four-in-a-row</app> without sounds and animation.</desc>
+  </info>
+
+  <title>Disable sounds and animation</title>
+  <p>When sounds are enabled, you will hear something every time a marble is
+  dropped and at the end of the game. Enabling animation results in a more
+  fluid movement of the marbles. To disable sounds and animation:</p>
+
+  <steps>
+    <item>
+      <p>Select <guiseq><gui style="menu">Settings</gui>
+      <gui style="menuitem">Preferences</gui>
+      <gui style="menuitem">Game</gui></guiseq>.</p>
+    </item>
+    <item>
+      <p>Under <gui>Appearance</gui>, you will see
+      <gui style="checkbox">Enable animation</gui> and
+      <gui style="checkbox">Enable sounds</gui>. Click on the small
+      square next to the feature you want to disable. This unchecks the
+      feature. You can check the square again if you
+      want to enable the feature.</p>
+    </item>
+  </steps>
+
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index 51bd763..f574e01 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -3,10 +3,19 @@ HELP_ID = four-in-a-row
 
 HELP_MEDIA = \
        figures/mainwindow.png \
-       figures/tileset.png
+       figures/tileset.png \
+       figures/logo.png
 
 HELP_FILES = \
-       index.docbook \
+       appearance.page \
+       basics.page \
+       choose-opponent.page \
+       controls-change.page \
+       controls-default.page \
+       index.page \
+       make-easy.page \
+       scores.page \
+       sound-animation.page \
        legal.xml
 
 HELP_LINGUAS = ca cs da de el en_GB es eu fi fr it oc pt_BR sl sr sr latin sv zh_CN


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