[gnome-robots/mallard-help] Bug 665833: Added Mallard help for GNOME-robots
- From: Aruna Sankaranarayanan <arunasank src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-robots/mallard-help] Bug 665833: Added Mallard help for GNOME-robots
- Date: Tue, 21 May 2013 12:21:36 +0000 (UTC)
commit f5833ec3c1796acb5b37664ecc1ea2983cae0507
Author: Aruna Sankaranarayanan <arunasank src gnome org>
Date: Tue May 21 16:55:03 2013 +0530
Bug 665833: Added Mallard help for GNOME-robots
Added:
appearance.page basics.page, controls-default.page, index.page, scores.page
help/C/appearance.page | 65 ++++
help/C/basics.page | 53 +++
help/C/controls-default.page | 149 ++++++++
help/C/figures/boo-high-risk.png | Bin 0 -> 3768 bytes
help/C/figures/boo-low-risk.png | Bin 0 -> 4058 bytes
help/C/figures/gnome-high-risk.png | Bin 0 -> 334 bytes
help/C/figures/gnome-low-risk.png | Bin 0 -> 342 bytes
help/C/figures/gnome-robots-main.png | Bin 5732 -> 0 bytes
help/C/figures/random.png | Bin 0 -> 1365 bytes
help/C/figures/robots-high-risk.png | Bin 0 -> 2317 bytes
help/C/figures/robots-low-risk.png | Bin 0 -> 3880 bytes
help/C/figures/teleport.png | Bin 0 -> 1457 bytes
help/C/figures/ufo-high-risk.png | Bin 0 -> 4743 bytes
help/C/figures/ufo-low-risk.png | Bin 0 -> 3489 bytes
help/C/figures/wait.png | Bin 0 -> 1099 bytes
help/C/index.docbook | 666 ----------------------------------
help/C/index.page | 33 ++
help/C/legal.xml | 82 +----
help/C/scores.page | 82 +++++
help/Makefile.am | 19 +-
20 files changed, 405 insertions(+), 744 deletions(-)
---
diff --git a/help/C/appearance.page b/help/C/appearance.page
new file mode 100644
index 0000000..bd4fb2b
--- /dev/null
+++ b/help/C/appearance.page
@@ -0,0 +1,65 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide" style="task"
+ id="appearance">
+
+ <info>
+ <link type="guide" xref="index#preferences"/>
+
+ <revision pkgversion="3.8" version="0.1" date="2013-04-03" status="draft"/>
+
+ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+ <credit type="author copyright">
+ <name>Aruna Sankaranarayanan</name>
+ <email>safincrazy gmail com</email>
+ </credit>
+
+ <desc>Use different game-themes in <app>Robots</app>.</desc>
+ </info>
+
+<title>Change the default appearance of the game</title>
+
+ <p>You can change the <app>Robots</app> backdrop and the different robots
+ that are present in a game by changing the game theme and background.</p>
+
+ <steps>
+ <title>To change the game theme and background:</title>
+ <item>
+ <p>Select<guiseq><gui style="menu">Settings</gui>
+ <gui style="menuitem">Preferences</gui>
+ <gui style="menuitem">Appearance</gui></guiseq>.</p>
+ </item>
+ <item>
+ <p>Select a theme from the drop-down menu available when you click the
+ button next to <gui>Image theme</gui>.</p>
+ <list>
+ <title>Available themes:</title>
+ <item>
+ <p>boo</p>
+ </item>
+ <item>
+ <p>gnomes</p>
+ </item>
+ <item>
+ <p>robots</p>
+ </item>
+ <item>
+ <p>ufo</p>
+ </item>
+ </list>
+ </item>
+ <item>
+ <p>To change your background color, click the button next to
+ <gui>Background color</gui>. Select a color from the choices avaialable
+ and click <gui style="button">Select</gui>.</p>
+ </item>
+ </steps>
+
+ <note style="info">
+ <p>You can hide the toolbar that contains buttons to start a new game,
+ wait and teleport, by selecting <guiseq><gui style="menu">View</gui>
+ <gui style="menuitem">Toolbar</gui></guiseq>. The small tick mark next to
+ <gui>Toolbar</gui> will disappear and the toolbar will be hidden.</p>
+ </note>
+
+</page>
diff --git a/help/C/basics.page b/help/C/basics.page
new file mode 100644
index 0000000..e126818
--- /dev/null
+++ b/help/C/basics.page
@@ -0,0 +1,53 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide" style="task"
+ id="basics">
+
+ <info>
+ <link type="guide" xref="index#play"/>
+
+ <revision pkgversion="3.8" version="0.1" date="2013-04-03" status="draft"/>
+
+ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+ <credit type="author copyright">
+ <name>Aruna Sankaranarayanan</name>
+ <email>safincrazy gmail com</email>
+ </credit>
+
+ <desc>Start, quit and play <app>Robots</app> in fullscreen.</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>Robots</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>Robots</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>Robots</app>
+ at any time.</p>
+
+</section>
+
+</page>
+
diff --git a/help/C/controls-default.page b/help/C/controls-default.page
new file mode 100644
index 0000000..5c5367a
--- /dev/null
+++ b/help/C/controls-default.page
@@ -0,0 +1,149 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ xmlns:its="http://www.w3.org/2005/11/its";
+ type="guide" style="task"
+ id="controls-default">
+
+ <info>
+ <link type="guide" xref="index#play"/>
+
+ <revision pkgversion="3.8" version="0.1" date="2013-04-03" status="draft"/>
+
+ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+ <credit type="author copyright">
+ <name>Aruna Sankaranarayanan</name>
+ <email>safincrazy gmail com</email>
+ </credit>
+
+ <desc>How do I move in a game?</desc>
+ </info>
+
+<title>Mouse and keyboard controls for <app>Robots</app></title>
+
+ <p>In <app>Robots</app> you can move in nine possible ways, wait for the
+ robots, or teleport.</p>
+
+<section id="keyboard">
+ <title>Keyboard controls</title>
+
+ <p>Use the following keys from the numeric keypad on the far right of your
+ keyboard, to move in <app>Robots</app>.</p>
+
+ <table frame="all">
+ <tr>
+ <td><p>Possible moves</p></td>
+ <td><p>Key</p></td>
+ </tr>
+ <tr>
+ <td><p>North west</p></td>
+ <td><p><key>Home</key></p></td>
+ </tr>
+ <tr>
+ <td><p>North</p></td>
+ <td><p><key>↑</key></p></td>
+ </tr>
+ <tr>
+ <td><p>North east</p></td>
+ <td><p><key>PgUp</key></p></td>
+ </tr>
+ <tr>
+ <td><p>West</p></td>
+ <td><p><key>→</key></p></td>
+ </tr>
+ <tr>
+ <td><p>East</p></td>
+ <td><p><key>←</key></p></td>
+ </tr>
+ <tr>
+ <td><p>South west</p></td>
+ <td><p><key>End</key></p></td>
+ </tr>
+ <tr>
+ <td><p>South</p></td>
+ <td><p><key>↓</key></p></td>
+ </tr>
+ <tr>
+ <td><p>South east</p></td>
+ <td><p><key>PgDn</key></p></td>
+ </tr>
+ <tr>
+ <td><p>Stay in the same position</p></td>
+ <td><p><key>5</key></p></td>
+ </tr>
+ <tr>
+ <td><p>Teleport safely</p></td>
+ <td><p><key>+</key></p></td>
+ </tr>
+ <tr>
+ <td><p>Teleport randomly</p></td>
+ <td><p><key>*</key></p></td>
+ </tr>
+ <tr>
+ <td><p>Wait for the robots</p></td>
+ <td><p><key>Enter</key></p></td>
+ </tr>
+ </table>
+
+</section>
+
+<section id="mouse">
+ <title>Use the mouse to move around</title>
+
+ <terms>
+ <item>
+ <title>Move in a particular direction</title>
+ <p>When you move your mouse around the main character, a small black
+ arrow will appear pointing towards the direction in which the character
+ will move if you click. For example, to move north, if you move your
+ cursor to the column above the main character, a small black arrow will
+ appear pointing northwards. On clicking, the character will move one
+ square northwards.</p>
+ </item>
+ <item>
+ <title>Stay in the same position</title>
+ <p>Click on the main character to stay put in the same square.</p>
+ </item>
+ <item>
+ <title>Wait for the robots</title>
+ <p>If you want to wait for the robots to finish moving without making
+ any move, you can click the
+ <media type="image" its:translate="no" src="figures/wait.png"/>
+ button on the toolbar or select
+ <guiseq><gui style="menu">Move</gui>
+ <gui style="menuitem">Wait</gui></guiseq>.
+ This is not advisable unless there
+ are very few robots and you are absolutely sure that they will perish
+ before reaching you.</p>
+ </item>
+ <item>
+ <title>Teleports</title>
+ <p>If there are no more moves possible or if you want to move to another
+ side of the board, you can teleport. There are two types of teleports
+ available.</p>
+ <terms>
+ <item>
+ <title>Safe teleports</title>
+ <p>Safe teleports move the main character to a location that is safe
+ from enemy robots. In each game only a few safe teleports are
+ allowed, so use these carefully. To safely teleport, click the
+ <media type="image" its:translate="no" src="figures/teleport.png"/>
+ button on the toolbar or select
+ <guiseq><gui style="menu">Move</gui>
+ <gui style="menuitem">Teleport</gui></guiseq>.</p>
+ </item>
+ <item>
+ <title>Random teleports</title>
+ <p>Use random teleports to teleport to a random location that may be
+ safe or may not be safe. You can use as many random teleports as you
+ want during a game. To teleport to a random square, click the
+ <media type="image" its:translate="no" src="figures/random.png"/>
+ button on the toolbar or select <guiseq><gui style="menu">Move</gui>
+ <gui style="menuitem">Random</gui></guiseq>.</p>
+ </item>
+ </terms>
+ </item>
+ </terms>
+
+</section>
+
+</page>
diff --git a/help/C/figures/boo-high-risk.png b/help/C/figures/boo-high-risk.png
new file mode 100644
index 0000000..014362d
Binary files /dev/null and b/help/C/figures/boo-high-risk.png differ
diff --git a/help/C/figures/boo-low-risk.png b/help/C/figures/boo-low-risk.png
new file mode 100644
index 0000000..0e66a86
Binary files /dev/null and b/help/C/figures/boo-low-risk.png differ
diff --git a/help/C/figures/gnome-high-risk.png b/help/C/figures/gnome-high-risk.png
new file mode 100644
index 0000000..9fe7cd8
Binary files /dev/null and b/help/C/figures/gnome-high-risk.png differ
diff --git a/help/C/figures/gnome-low-risk.png b/help/C/figures/gnome-low-risk.png
new file mode 100644
index 0000000..70fdccd
Binary files /dev/null and b/help/C/figures/gnome-low-risk.png differ
diff --git a/help/C/figures/random.png b/help/C/figures/random.png
new file mode 100644
index 0000000..f0b081a
Binary files /dev/null and b/help/C/figures/random.png differ
diff --git a/help/C/figures/robots-high-risk.png b/help/C/figures/robots-high-risk.png
new file mode 100644
index 0000000..72be83c
Binary files /dev/null and b/help/C/figures/robots-high-risk.png differ
diff --git a/help/C/figures/robots-low-risk.png b/help/C/figures/robots-low-risk.png
new file mode 100644
index 0000000..f8d91f7
Binary files /dev/null and b/help/C/figures/robots-low-risk.png differ
diff --git a/help/C/figures/teleport.png b/help/C/figures/teleport.png
new file mode 100644
index 0000000..b0f129e
Binary files /dev/null and b/help/C/figures/teleport.png differ
diff --git a/help/C/figures/ufo-high-risk.png b/help/C/figures/ufo-high-risk.png
new file mode 100644
index 0000000..fce94a7
Binary files /dev/null and b/help/C/figures/ufo-high-risk.png differ
diff --git a/help/C/figures/ufo-low-risk.png b/help/C/figures/ufo-low-risk.png
new file mode 100644
index 0000000..6e4e1a7
Binary files /dev/null and b/help/C/figures/ufo-low-risk.png differ
diff --git a/help/C/figures/wait.png b/help/C/figures/wait.png
new file mode 100644
index 0000000..d72f3ee
Binary files /dev/null and b/help/C/figures/wait.png differ
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..805b199
--- /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-04-03" 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>Robots</title>
+
+ <p><app>Robots</app> is based on the UNIX command-line game of the same
+ name. The aim of the game is to destroy all the robots by getting them to
+ crash into each other or into junk-heaps from previous collisions, while
+ stopping them from crashing into you.</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/scores.page b/help/C/scores.page
new file mode 100644
index 0000000..aa6a88f
--- /dev/null
+++ b/help/C/scores.page
@@ -0,0 +1,82 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide" style="task"
+ id="scores">
+
+ <info>
+ <link type="guide" xref="index#play"/>
+
+ <revision pkgversion="3.8" version="0.1" date="2013-04-03" status="draft"/>
+
+ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+ <credit type="author copyright">
+ <name>Aruna Sankaranarayanan</name>
+ <email>safincrazy gmail com</email>
+ </credit>
+
+ <desc>Scoring points in <app>Robots</app></desc>
+ </info>
+
+<title>Scores</title>
+
+ <p>There are two type of enemies in <app>Robots</app>, enemies that give you
+ 10 points when they die and enemies that give you 20 points when they
+ die.</p>
+
+<section id="high-risk">
+ <title>High-risk enemies</title>
+
+ <p>Depending on your <link xref="appearance">game theme</link>, the
+ following are the enemies that give you 20 points when they die.</p>
+
+ <list>
+ <item>
+ <p>Bats <media type="image" src="figures/boo-high-risk.png" height="20"
+ width="20"/></p>
+ </item>
+ <item>
+ <p>High-risk Robots <media type="image" src="figures/robots-high-risk.png" height="20"
+ width="20"/></p>
+ </item>
+ <item>
+ <p>High-risk gnomes <media type="image" src="figures/gnome-high-risk.png" height="20"
+ width="20"/></p>
+ </item>
+ <item>
+ <p>High-risk UFOs <media type="image" src="figures/ufo-high-risk.png" height="20"
+ width="20"/></p>
+ </item>
+ </list>
+
+</section>
+
+<section id="low-risk">
+ <title>Low-risk enemies</title>
+
+ <p>The following are the enemies that give you 10 points when they die.
+ Again, it is your theme that determines which of these will appear in a
+ game.</p>
+
+ <list>
+ <item>
+ <p>Ghosts <media type="image" src="figures/boo-low-risk.png" height="20"
+ width="20"/></p>
+ </item>
+ <item>
+ <p>Low-risk Robots <media type="image" src="figures/robots-low-risk.png" height="20"
+ width="20"/></p>
+ </item>
+ <item>
+ <p>Low-risk gnomes <media type="image" src="figures/gnome-low-risk.png" height="20"
+ width="20"/></p>
+ </item>
+ <item>
+ <p>Low-risk UFOs <media type="image" src="figures/ufo-low-risk.png" height="20"
+ width="20"/></p>
+ </item>
+ </list>
+
+</section>
+
+</page>
+
diff --git a/help/Makefile.am b/help/Makefile.am
index b316eb7..5af7aa9 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -2,10 +2,25 @@
HELP_ID = gnome-robots
HELP_MEDIA = \
- figures/gnome-robots-main.png
+ figures/boo-high-risk.png \
+ figures/boo-low-risk.png \
+ figures/gnome-high-risk.png \
+ figures/gnome-low-risk.png \
+ figures/random.png \
+ figures/robots-high-risk.png \
+ figures/robots-low-risk.png \
+ figures/teleport.png \
+ figures/ufo-high-risk.png \
+ figures/ufo-low-risk.png \
+ figures/wait.png
+
HELP_FILES = \
- index.docbook \
+ appearance.page \
+ basics.page \
+ controls-default.page \
+ index.page \
+ scores.page \
legal.xml
HELP_LINGUAS = ca cs da de el en_GB es eu fr it oc sl sr sr latin sv zh_CN
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
