[swell-foop] added help pages



commit 845cac91e96051b296cad6aa46c9550989835e63
Author: roopa <nroopa57 gmail com>
Date:   Thu Jun 25 22:48:49 2020 +0530

    added help pages

 help/C/Introduction.page      |  30 ++++++++++++++
 help/C/figures/logo.png       | Bin 0 -> 11788 bytes
 help/C/figures/start-game.png | Bin 0 -> 36209 bytes
 help/C/index.page             |  43 ++++++++++++++++++++
 help/C/keyboard-shortcut.page |  38 ++++++++++++++++++
 help/C/legal.xml              |  80 +++----------------------------------
 help/C/playing-game.page      |  36 +++++++++++++++++
 help/C/preferences.page       |  72 +++++++++++++++++++++++++++++++++
 help/C/score.page             |  90 ++++++++++++++++++++++++++++++++++++++++++
 help/C/start.page             |  34 ++++++++++++++++
 help/C/strategy.page          |  45 +++++++++++++++++++++
 11 files changed, 394 insertions(+), 74 deletions(-)
---
diff --git a/help/C/Introduction.page b/help/C/Introduction.page
new file mode 100644
index 0000000..989d395
--- /dev/null
+++ b/help/C/Introduction.page
@@ -0,0 +1,30 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="topic"
+      id="introduction">
+
+  <info>
+    <link type="guide" xref="index"/>
+    <revision version="3.14" date="2020-06-24" status="review"/>
+
+    <credit type="author">
+      <name>Roopa</name>
+      <email its:translate="no">nroopa57 gmail com</email>
+      <years>2020</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+
+    <desc>Know about <app>Swell Foop</app>.</desc>
+
+  </info>
+
+  <title>Introduction</title>
+
+  <p>The goal of the game is to remove as many objects as possible in the
+  less number of moves. Objects that are adjacent to each other get removed
+  as a group. The remaining objects then collapse to fill in the gaps and form
+  new groups. You cannot remove single objects.</p>
+
+</page>
+
diff --git a/help/C/figures/logo.png b/help/C/figures/logo.png
new file mode 100644
index 0000000..7deabe4
Binary files /dev/null and b/help/C/figures/logo.png differ
diff --git a/help/C/figures/start-game.png b/help/C/figures/start-game.png
new file mode 100644
index 0000000..6cf794d
Binary files /dev/null and b/help/C/figures/start-game.png differ
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..4d950fa
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,43 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      xmlns:e="http://projectmallard.org/experimental/";
+      type="guide" style="2column task"
+      id="index">
+
+  <info>
+    <title type="link" role="trail"><media type="image" its:translate="no"
+    src="figures/logo.png"/></title>
+
+    <revision pkgversion="3.14" date="2020-06-24" status="review"/>
+    <credit type="author">
+      <name>Roopa</name>
+      <email its:translate="no">nroopa57 gmail com</email>
+    </credit>
+
+   <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+
+   <desc>Swell Foop help.</desc>
+
+  </info>
+
+  <title>
+    <media type="image" mime="image/png" src="figures/logo.png"
+    its:translate="no" />
+    Swell Foop
+  </title>
+  <p>Swell Foop is a puzzle game, previously known as Same GNOME. To know more
+  about the game, Look at -> <link xref="Introduction">Game introduction</link>.</p>
+
+  <section id="play">
+    <title>Playing Swell-foop</title>
+  </section>
+
+  <section id="advanced-settings" style="2column">
+    <title>Advance settings</title>
+  </section>
+
+  <section id="tip" style="2column">
+    <title>Useful tips</title>
+  </section>
+</page>
+
diff --git a/help/C/keyboard-shortcut.page b/help/C/keyboard-shortcut.page
new file mode 100644
index 0000000..bcb4a62
--- /dev/null
+++ b/help/C/keyboard-shortcut.page
@@ -0,0 +1,38 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="keyboard-shortcuts">
+  <info>
+    <link type="guide" xref="index#tip" />
+    <revision pkgversion="3.14" date="2020-006-24" status="review"/>
+
+    <credit type="author">
+      <name>Roopa</name>
+      <email>nroopa57 gmail com</email>
+      
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+
+    <desc>Play the game through keyboard.</desc>
+
+  </info>
+
+  <title>Keyboard shortcuts</title>
+  <p>To access the game through keyboard, use the following shortcuts:</p>
+
+    <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>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/help/C/legal.xml b/help/C/legal.xml
index 899282c..73ee890 100644
--- a/help/C/legal.xml
+++ b/help/C/legal.xml
@@ -1,76 +1,8 @@
-  <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>
+<license xmlns="http://projectmallard.org/1.0/";
+         href="http://creativecommons.org/licenses/by-sa/4.0/";>
 
-       <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>
+  <p>This work is licensed under a
+  <link href="http://creativecommons.org/licenses/by-sa/4.0/";>Creative Commons
+  Attribution-ShareAlike 4.0 International</link> license.</p>
 
+</license>
diff --git a/help/C/playing-game.page b/help/C/playing-game.page
new file mode 100644
index 0000000..ca0a48d
--- /dev/null
+++ b/help/C/playing-game.page
@@ -0,0 +1,36 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="topic"
+      id="play">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+    <revision pkgversion="3.14" date="2014-07-14" status="review"/>
+
+    <credit type="author">
+      <name>Roopa</name>
+      <email>nroopa57 gmail com</email>
+      <years>2020</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+
+    <desc>How to play?</desc>
+
+  </info>
+
+  <title>Play <app>Swell Foop</app></title>
+
+  <p>The board starts as a full grid of objects depending on the size of board
+  you select. You can remove the tiles as follows:</p>
+  <list>
+    <item><p>If a group of objects are adjacent and all the same type, then
+    they can be removed simply by clicking them or by pressing the
+    <key>space bar</key>.</p></item>
+    <item><p>Once the group has been removed the objects above them
+    fall down to fill the space. If an entire column is cleared then the objects
+    slide leftward to fill the gap.</p></item>
+  </list>
+  <media its:translate="no" type="image" src="figures/start-game.png"/>
+</page>
+
diff --git a/help/C/preferences.page b/help/C/preferences.page
new file mode 100644
index 0000000..e44cb02
--- /dev/null
+++ b/help/C/preferences.page
@@ -0,0 +1,72 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="settings">
+
+  <info>
+    <link type="guide" xref="index#advanced-settings"/>
+    <revision pkgversion="3.14" date="2020-06-25" status="review"/>
+
+    <credit type="author">
+      <name>Roopa</name>
+      <email>nroopa57 gmail com</email>
+      <years>2020</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+
+    <desc>Change game settings.</desc>
+
+  </info>
+
+  <title>Game settings</title>
+
+  <p>You can change the game look according to your preference.</p>
+
+  <section id="board-size">
+  <title>Change the size</title>
+  <p>You can set the size of the board according to your preference:</p>
+  <steps>
+    <item><p>Select <guiseq><gui style="menu">Swell Foop</gui>
+    <gui style="menuitem">Preferences</gui></guiseq>.</p></item>
+    <item><p>The default board size is <gui>Small</gui>. You can change it from
+    <gui>Board size</gui> under <gui>Setup</gui>.</p></item>
+  </steps>
+  </section>
+
+  <section id="colors">
+  <title>Change the number of objects</title>
+  <p>You can increase the number of different objects in the game.</p>
+  <steps>
+    <item><p>Select <guiseq><gui style="menu">Swell Foop</gui>
+    <gui style="menuitem">Preferences</gui></guiseq>.</p></item>
+    <item><p>The default number of colors is 3, you can increase or decrease
+    it from <gui>Number of colors</gui> under <gui>Setup</gui>. The maximum
+    number of colors allowed are 4.</p></item>
+  </steps>
+  </section>
+
+  <section id="theme">
+  <title>Change the look</title>
+  <p>To change the appearance of the objects:</p>
+  <steps>
+    <item><p>Select <guiseq><gui style="menu">Swell Foop</gui>
+    <gui style="menuitem">Preferences</gui></guiseq>.</p></item>
+    <item><p>The default theme is <gui>Shapes and Colors</gui>. You can select
+    another theme from <gui>Theme</gui> under <gui>Appearance</gui>.</p></item>
+  </steps>
+  </section>
+
+  <section id="animation">
+  <title>Change the speed</title>
+  <p>The default animation is designed to be smooth and graceful. If you like
+  playing fast and furious then this may be too slow for you. You can speed up
+  the game play at the expense of animation quality.</p>
+  <steps>
+    <item><p>Select <guiseq><gui style="menu">Swell Foop</gui>
+    <gui style="menuitem">Preferences</gui></guiseq>.</p></item>
+    <item><p>To speed up the game, check the <gui style="checkbox">Zealous
+    Animation</gui> under <gui>Operation</gui>.</p></item>
+  </steps>
+  </section>
+</page>
+
diff --git a/help/C/score.page b/help/C/score.page
new file mode 100644
index 0000000..0fefdcd
--- /dev/null
+++ b/help/C/score.page
@@ -0,0 +1,90 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      xmlns:its="http://www.w3.org/2005/11/its";
+      type="topic"
+      id="scores">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+    <revision pkgversion="3.14" date="2020-06-24" status="review"/>
+
+    <credit type="author">
+      <name>Roopa</name>
+      <email its:translate="no">nroopa57 gmail com</email>
+      <years>2020</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+
+    <desc>Check out your scores.</desc>
+
+  </info>
+
+  <title>Scores</title>
+
+  <p>You can checkout your current game scores at the top of the game
+  screen. To view scores obtained in previous games:</p>
+  <steps>
+    <item><p>Select <guiseq><gui style="menu">Swell Foop</gui>
+    <gui style="menuitem">Scores</gui></guiseq>.</p></item>
+    <item><p>The dialog by default displays scores for <gui>6 x 5, 3 colors
+    </gui> game. To view others, select the size from the menu whose scores you
+    wish to see.</p></item>
+  </steps>
+
+  <section id="scoring">
+  <title>Scoring</title>
+
+  <p>Scoring is done based on the objects you delete.</p>
+
+  <table frame="all" rules="cols" shade="rows">
+    <tr>
+      <td><p>Number of Objects</p></td>
+      <td><p>Points Scored</p></td>
+    </tr>
+    <tr>
+      <td><p>2</p></td>
+      <td><p>0</p></td>
+    </tr>
+    <tr>
+      <td><p>3</p></td>
+      <td><p>1</p></td>
+    </tr>
+    <tr>
+      <td><p>4</p></td>
+      <td><p>4</p></td>
+    </tr>
+    <tr>
+      <td><p>5</p></td>
+      <td><p>9</p></td>
+    </tr>
+    <tr>
+      <td><p>6</p></td>
+      <td><p>16</p></td>
+    </tr>
+    <tr>
+      <td><p>7</p></td>
+      <td><p>25</p></td>
+    </tr>
+    <tr>
+      <td><p>8</p></td>
+      <td><p>36</p></td>
+    </tr>
+    <tr>
+      <td><p>9</p></td>
+      <td><p>49</p></td>
+    </tr>
+    <tr>
+      <td><p>â‹®</p></td>
+      <td><p>â‹®</p></td>
+    </tr>
+    <tr>
+      <td><p>n</p></td>
+      <td><p>(n-2)^2</p></td>
+    </tr>
+  </table>
+  <note style="tip">
+    <p>There is a 1000 point bonus on clearing the board.</p>
+  </note>
+  </section>
+</page>
+
diff --git a/help/C/start.page b/help/C/start.page
new file mode 100644
index 0000000..48cb1a8
--- /dev/null
+++ b/help/C/start.page
@@ -0,0 +1,34 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="start">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+    <revision pkgversion="3.14" date="2020-06-25" status="review"/>
+
+    <credit type="author">
+      <name>Roopa</name>
+      <email>nroopa57 gmail com</email>
+      <years>2020</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+
+    <desc>Play another game.</desc>
+
+  </info>
+
+  <title>Start a new game</title>
+
+  <p>You can play <app>Swell Foop</app> all over again. To start a
+  new game:</p>
+  <steps>
+    <item><p>Select <guiseq><gui style="menu">Swell Foop</gui>
+    <gui style="menuitem">New Game</gui></guiseq>. Alternatively, you can click
+    on <gui style="button">Start a new game</gui> button.</p></item>
+    <item><p>Click on <gui style="button">New Game</gui> in the dialog to start
+    a new game.</p>
+    </item>
+  </steps>
+</page>
+
diff --git a/help/C/strategy.page b/help/C/strategy.page
new file mode 100644
index 0000000..3e8a666
--- /dev/null
+++ b/help/C/strategy.page
@@ -0,0 +1,45 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="strategy">
+
+  <info>
+    <link type="guide" xref="index#tip"/>
+    <revision pkgversion="3.14" date="2014-07-19" status="review"/>
+
+    <credit type="author">
+      <name>Roopa</name>
+      <email>nroopa57 gmail com</email>
+      <years>2020</years>
+    </credit>
+
+    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+
+    <desc>Crack the game using strategies.</desc>
+
+  </info>
+
+  <title>Strategy</title>
+
+  <p>The most important rule when aiming for a high score is to think ahead,
+  each group you remove will form and destroy other groups. Some tips to play
+  smartly are:</p>
+  <list>
+    <item><p>Try to remove higher groups first, unless removing another group
+    will make it larger. Vertically aligned objects can't be misaligned, but
+    horizontal arrangements can.</p></item>
+    <item><p>Since the score increases quadratically, big groups of objects
+    will score more.</p></item>
+    <item><p>If you have a choice between merging two groups of two into four
+    or, just adding one more to the group of six then, you should add the single
+    object. Even though the groups of two you are left with score no points,
+    the bigger group scores more overall.</p></item>
+  </list>
+
+  <note style="tip">
+    <p>Don't forget the thousand point bonus for clearing the board. To get 1000
+    points from a single group you need 34 objects. You are very unlikely to be
+    in a position where you have to sacrifice a group that large to clear the
+    board.</p>
+  </note>
+</page>
+


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