[gnome-nibbles/user-help: 2/4] help: review help pages
- From: Aruna Sankaranarayanan <arunasank src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-nibbles/user-help: 2/4] help: review help pages
- Date: Thu, 4 Apr 2013 17:27:15 +0000 (UTC)
commit 4ec4d6383f2ff4a159aef19617977ece01643727
Author: Ekaterina Gerasimova <kittykat3756 gmail com>
Date: Thu Mar 7 23:23:30 2013 +0000
help: review help pages
Rename controls pages, review all other pages except scores.page.
help/C/basics.page | 45 +++++----
help/C/controls-change.page | 70 +++++++++++++
help/C/{controls.page => controls-default.page} | 54 +++++-----
help/C/fake-bonus.page | 10 ++-
help/C/index.page | 8 +-
help/C/multi-player.page | 58 ++++++-----
help/C/preferences.page | 35 ++++---
help/C/rel-movement.page | 120 +++++++++++------------
help/Makefile.am | 8 +-
9 files changed, 247 insertions(+), 161 deletions(-)
---
diff --git a/help/C/basics.page b/help/C/basics.page
index cc0e9aa..85a38b6 100644
--- a/help/C/basics.page
+++ b/help/C/basics.page
@@ -5,16 +5,20 @@
<info>
<link type="guide" xref="index#play"/>
- <revision pkgversion="3.8" version="0.1" date="2013-03-05" status="review"/>
+ <revision pkgversion="3.8" version="0.1" date="2013-03-07" status="review"/>
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
<credit type="author">
- <name>Aruna Sankaranarayanan</name>
- <email>safincrazy gmail com</email>
+ <name>Aruna Sankaranarayanan</name>
+ <email>safincrazy gmail com</email>
+ </credit>
+ <credit type="editor">
+ <name>Ekaterina Gerasimova</name>
+ <email>kittykat3756 gmail com</email>
</credit>
- <desc>Start, pause, resume and quit a game of <app>Nibbles</app>.</desc>
+ <desc>Start, pause, play in fullscreen mode and quit a game of <app>Nibbles</app>.</desc>
</info>
<title>Basic instructions</title>
@@ -22,41 +26,40 @@
<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>
+ <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="pause">
<title>Pause and resume your game</title>
- <p>Select <guiseq><gui style="menu">Game</gui>
- <gui style="menuitem">Pause</gui></guiseq> to pause your game.
- You can resume your game by selecting <guiseq><gui style="menu">Game</gui>
- <gui style="menuitem">Resume</gui></guiseq>.</p>
+ <p>Select <guiseq><gui style="menu">Game</gui>
+ <gui style="menuitem">Pause</gui></guiseq> to pause your game.
+ You can resume your game by selecting <guiseq><gui style="menu">Game</gui>
+ <gui style="menuitem">Resume</gui></guiseq>.</p>
</section>
<section id="fullscreen">
<title>Play <app>Nibbles</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>
+ <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>Nibbles</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>Nibbles</app>
- at any time.</p>
+ <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>Nibbles</app>
+ at any time.</p>
</section>
diff --git a/help/C/controls-change.page b/help/C/controls-change.page
new file mode 100644
index 0000000..251aa21
--- /dev/null
+++ b/help/C/controls-change.page
@@ -0,0 +1,70 @@
+<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="2012-03-05" status="candidate"/>
+
+ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+ <credit type="author">
+ <name>Aruna Sankaranarayanan</name>
+ <email>safincrazy gmail com</email>
+ </credit>
+ <credit type="editor">
+ <name>Ekaterina Gerasimova</name>
+ <email>kittykat3756 gmail com</email>
+ </credit>
+
+ <desc>Set custom control keys.</desc>
+ </info>
+
+ <title>Change the default controls</title>
+
+ <p>The <link xref="controls-default">default controls</link> can be changed in
+ <app>Nibbles</app> to suit your preference or for
+ <link xref="multi-player">multi-player</link> games, when having more than
+ one set of controls becomes necessary. To change the default controls:</p>
+
+ <steps>
+ <item>
+ <p>Select <guiseq><gui style="menu">Settings</gui>
+ <gui style="menuitem">Preferences</gui></guiseq>.</p>
+ </item>
+ <item>
+ <p>Select the tab for the player whose controls you want to change.</p>
+ <note style="info">
+ <p>Player 1 controls <gui>Worm 1</gui>, player 2 controls
+ <gui>Worm 2</gui>, player 3 controls <gui>Worm 3</gui> and so on.</p>
+ </note>
+ </item>
+ <item>
+ <p>In the <gui style="group">Keyboard Controls</gui> list, select the
+ line, 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>Nibbles Preferences</gui> box.</p>
+ </note>
+ </item>
+ <item>
+ <p>Repeat the above step to change the other default keys for the
+ current player, then select the tab for the next player whose controls
+ you want to change and repeat the process.</p>
+ </item>
+ </steps>
+
+ <p>For example, to use <key>A</key> to <gui>Move Left</gui>, select the
+ <gui>Left</gui> control line and click it, then press <key>A</key> on your
+ keyboard when you see <gui>New accelerator…</gui> on the line.</p>
+
+</page>
diff --git a/help/C/controls.page b/help/C/controls-default.page
similarity index 54%
rename from help/C/controls.page
rename to help/C/controls-default.page
index 8b13eba..e787c99 100644
--- a/help/C/controls.page
+++ b/help/C/controls-default.page
@@ -1,46 +1,50 @@
<page xmlns="http://projectmallard.org/1.0/";
type="topic" style="task"
- id="controls">
+ id="controls-default">
<info>
<link type="guide" xref="index#play"/>
- <revision pkgversion="3.8" version="0.1" date="2013-03-05" status="review"/>
+ <revision pkgversion="3.8" version="0.1" date="2013-03-05" status="candidate"/>
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
<credit type="author">
- <name>Aruna Sankaranarayanan</name>
- <email>safincrazy gmail com</email>
+ <name>Aruna Sankaranarayanan</name>
+ <email>safincrazy gmail com</email>
</credit>
+ <credit type="editor">
+ <name>Ekaterina Gerasimova</name>
+ <email>kittykat3756 gmail com</email>
+ </credit>
+
<desc>Default keys for <app>Nibbles.</app></desc>
</info>
<title>Keyboard Controls</title>
-<section id="default-controls">
-
- <p>For controlling the movements of your worm in a single-player
- environment, use the following default keys:</p>
- <list>
- <item>
- <p><key>Up</key> to move the worm up</p>
- </item>
- <item>
- <p><key>Down</key> to move the worm down</p>
- </item>
- <item>
- <p><key>Left</key> to move the worm left</p>
- </item>
- <item>
- <p><key>Right</key> to move the worm right</p>
- </item>
- </list>
+ <p>For controlling the movements of your worm in a single-player mode, use
+ the following default keys:</p>
+
+ <list>
+ <item>
+ <p><key>Up</key> to move the worm up</p>
+ </item>
+ <item>
+ <p><key>Down</key> to move the worm down</p>
+ </item>
+ <item>
+ <p><key>Left</key> to move the worm left</p>
+ </item>
+ <item>
+ <p><key>Right</key> to move the worm right</p>
+ </item>
+ </list>
<note style="tip">
- <p>You can <link xref="change-controls">change</link>
- the default controls.</p>
+ <p>You can <link xref="controls-change">change</link> the default
+ controls.</p>
</note>
<p>All worm movements happen with repect to the screen unless
@@ -49,6 +53,4 @@
screen, when you press <key>Right</key> the worm moves towards the right of
the screen and so on.</p>
-</section>
-
</page>
diff --git a/help/C/fake-bonus.page b/help/C/fake-bonus.page
index 6bca15f..a711ff2 100644
--- a/help/C/fake-bonus.page
+++ b/help/C/fake-bonus.page
@@ -10,8 +10,12 @@
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
<credit type="author">
- <name>Aruna Sankaranarayanan</name>
- <email>safincrazy gmail com</email>
+ <name>Aruna Sankaranarayanan</name>
+ <email>safincrazy gmail com</email>
+ </credit>
+ <credit type="editor">
+ <name>Ekaterina Gerasimova</name>
+ <email>kittykat3756 gmail com</email>
</credit>
<desc>Use fake bonuses in a <app>Nibbles</app> game to make it more
@@ -24,6 +28,7 @@
points when your worm swallows them. They cause a reversal in the movement of
your worm.</p>
+<!--
<table frame="all">
<title>What happens when the worm swallows a fake bonus</title>
<tr>
@@ -42,6 +47,7 @@
</td>
</tr>
</table>
+-->
<p>To enable fake bonuses:</p>
<steps>
diff --git a/help/C/index.page b/help/C/index.page
index 1556d16..0096c63 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -8,22 +8,22 @@
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
<credit type="author">
- <name>Aruna Sankaranarayanan</name>
- <email>safincrazy gmail com</email>
+ <name>Aruna Sankaranarayanan</name>
+ <email>safincrazy gmail com</email>
</credit>
<desc>Index</desc>
</info>
<title><media type="image" src="figures/nibbles.png" width="22" height="22">
- </media><app>Nibbles</app></title>
+ </media> Nibbles</title>
<p><app>Nibbles</app> is a Snake game for GNOME. The aim of the game is to
swallow as many objects as you can while avoiding maze walls and other worms.
You have to complete 26 levels to finish the game.</p>
<section id="play" style="2column">
- <title>Play</title>
+ <title>Game play</title>
</section>
<section id="preferences" style="2column">
diff --git a/help/C/multi-player.page b/help/C/multi-player.page
index d6b1fd4..4a50c5d 100644
--- a/help/C/multi-player.page
+++ b/help/C/multi-player.page
@@ -7,43 +7,50 @@
<revision pkgversion="3.8" version="0.1" date="2013-03-05" status="review"/>
+ <link type="seealso" xref="controls-change"/>
+
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
<credit type="author">
- <name>Aruna Sankaranarayanan</name>
- <email>safincrazy gmail com</email>
+ <name>Aruna Sankaranarayanan</name>
+ <email>safincrazy gmail com</email>
+ </credit>
+ <credit type="editor">
+ <name>Ekaterina Gerasimova</name>
+ <email>kittykat3756 gmail com</email>
</credit>
<desc>Play <app>Nibbles</app> with additional players.</desc>
</info>
<title>Multi-player games</title>
- <p><app>Nibbles</app> can involve up to six players. While a player controls
- <gui>Worm 1</gui> in a single-player game, players can additionally control
- <gui>Worm 2</gui> - <gui>Worm 6</gui> in a multi-player game. A two-player
- game allows you to control <gui>Worm 1</gui> and <gui>Worm 2</gui>, a three
- player game allows you to control <gui>Worm 1</gui>, <gui>Worm 2</gui> and
- <gui>Worm 3</gui> and so on.</p>
+
+ <p><app>Nibbles</app> can be played with up to six players. While a player
+ controls <gui>Worm 1</gui> in a single-player game, players can additionally
+ control <gui>Worm 2</gui> to <gui>Worm 6</gui> in a multi-player game. A
+ two-player game allows you to control <gui>Worm 1</gui> and <gui>Worm
+ 2</gui>, a three player game allows you to control <gui>Worm 1</gui>,
+ <gui>Worm 2</gui> and <gui>Worm 3</gui> and so on.</p>
<section id="number-of-players">
- <title>Choosing the number of players</title>
+ <title>Choose the number of players</title>
<p><app>Nibbles</app> can be played by up to six players. To set the number
of players:</p>
- <steps>
- <item>
- <p>Select <guiseq><gui style="menu">Settings</gui>
- <gui style="menuitem">Preferences</gui></guiseq>.</p>
- </item>
- <item>
- <p>On your right side, set the
- <gui style="input">Number of human players</gui>
- to the required number, a maximum of 6. You can do this
- by using the <gui style="button">+</gui> or <gui style="button">-</gui>
- buttons or by entering the number of players from the keyboard in the
- space provided.</p>
- </item>
- </steps>
+
+ <steps>
+ <item>
+ <p>Select <guiseq><gui style="menu">Settings</gui>
+ <gui style="menuitem">Preferences</gui></guiseq>.</p>
+ </item>
+ <item>
+ <p>Set the <gui style="input">Number of human players</gui> to the
+ required number, a maximum of 6. You can do this by using the
+ <gui style="button">+</gui> or <gui style="button">-</gui> buttons or by
+ entering the number of players from the keyboard in the space
+ provided.</p>
+ </item>
+ </steps>
<note style="info">
<p>You can watch a <app>Nibbles</app> game without participating. To
@@ -54,9 +61,4 @@
</section>
- <note style="tip">
- <p>You may have to <link xref="change-controls">change</link> the default
- keys for multi-player games.</p>
- </note>
-
</page>
diff --git a/help/C/preferences.page b/help/C/preferences.page
index 31805c4..e5389cd 100644
--- a/help/C/preferences.page
+++ b/help/C/preferences.page
@@ -10,14 +10,19 @@
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
<credit type="author">
- <name>Aruna Sankaranarayanan</name>
- <email>safincrazy gmail com</email>
+ <name>Aruna Sankaranarayanan</name>
+ <email>safincrazy gmail com</email>
+ </credit>
+ <credit type="editor">
+ <name>Ekaterina Gerasimova</name>
+ <email>kittykat3756 gmail com</email>
</credit>
- <desc>Change default speed and worm color.</desc>
+ <desc>Change default speed, worm color, level order and sound settings.</desc>
</info>
- <title>Change general preferences</title>
+ <title>Edit general preferences</title>
+
<p>The general preferences for <app>Nibbles</app> can be changed by
selecting <guiseq><gui style="menu">Settings</gui>
<gui style="menuitem">Preferences</gui></guiseq>.</p>
@@ -25,14 +30,15 @@
<section id="speed">
<title>Speed</title>
- <p>There are four available speeds on <app>Nibbles</app>. These are, in
+ <p>There are four available speeds in <app>Nibbles</app>. These are, in
increasing order:</p>
+
<list>
<item>
<p>Nibbles Newbie</p>
</item>
<item>
- <p>My Second Day</p>
+ <p>My second day</p>
</item>
<item>
<p>Not too shabby</p>
@@ -52,6 +58,7 @@
<title>Change worm colors</title>
<p>There are seven available worm colors:</p>
+
<list>
<item>
<p><media type="image" src="figures/snake-red.svg" height="20"
@@ -85,16 +92,16 @@
<p>These can be changed in <guiseq><gui style="menu">Settings</gui>
<gui style="menuitem">Preferences</gui></guiseq>.</p>
+
<steps>
<item>
- <p>Select any of the <gui>Worm</gui> tabs to choose the worm whose
- colour you want to change.</p>
+ <p>Select any of the <gui>Worm</gui> tabs to choose the worm that you
+ wish to edit.</p>
</item>
<item>
<p>On your left hand side you will see
- <gui style="group">Worm color</gui>. Pick a color out of the
- available colors in the
- drop-down menu to change the appearance of the worm.</p>
+ <gui style="group">Worm color</gui>. Pick a color out of the available
+ colors in the drop-down menu to change the appearance of the worm.</p>
</item>
</steps>
@@ -106,8 +113,7 @@
<p>You can enable or disable sounds in <app>Nibbles</app> by checking or
unchecking the <gui style="checkbox">Enable sounds</gui> checkbox in
<guiseq><gui style="menu">Settings</gui>
- <gui style="menuitem">Preferences</gui></guiseq>.
- This is checked by default.</p>
+ <gui style="menuitem">Preferences</gui></guiseq>.</p>
</section>
@@ -117,8 +123,7 @@
<p>Check or uncheck the <gui style="checkbox">Play levels in random
order</gui> checkbox in <guiseq><gui style="menu">Settings</gui>
<gui style="menuitem">Preferences</gui></guiseq>
- to play the different levels in <app>Nibbles</app> in random order.
- This is unchecked by default.</p>
+ to play the different levels in <app>Nibbles</app> in random order.</p>
</section>
diff --git a/help/C/rel-movement.page b/help/C/rel-movement.page
index ebcb4b7..fc9ef13 100644
--- a/help/C/rel-movement.page
+++ b/help/C/rel-movement.page
@@ -10,77 +10,75 @@
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
<credit type="author">
- <name>Aruna Sankaranarayanan</name>
- <email>safincrazy gmail com</email>
+ <name>Aruna Sankaranarayanan</name>
+ <email>safincrazy gmail com</email>
+ </credit>
+ <credit type="editor">
+ <name>Ekaterina Gerasimova</name>
+ <email>kittykat3756 gmail com</email>
</credit>
<desc>Enable relative movement.</desc>
</info>
-
<title>Relative movement</title>
- <p>When relative movement is enabled, the worm is manouvered using just the
- default <key>Left</key> and <key>Right</key> keys or other
- <link xref="change-controls">customized keys</link> that control the
- leftward
- and rightward movement of a worm. When the <key>Left</key> key is pressed,
- the worm turns left, instead of moving towards the left of the screen.
- Similarly, when the <key>Right</key> key is pressed, the worm turns right
- instead of moving towards the right of the screen. The worm's upward and
- downward movement are also controlled using the <key>Left</key> and
- <key>Right</key> keys.</p>
-
- <section id="rel-table">
- <title>What happens when relative movement is enabled</title>
+ <p>When relative movement is enabled, the worm is manouvered using just the
+ default <key>Left</key> and <key>Right</key> keys or other
+ <link xref="controls-change">customized keys</link> that control the leftward
+ and rightward movement of a worm. When the <key>Left</key> key is pressed,
+ the worm turns left, instead of moving towards the left of the screen.
+ Similarly, when the <key>Right</key> key is pressed, the worm turns right
+ instead of moving towards the right of the screen.</p>
- <table frame="all">
- <tr>
- <td>
- <figure>
- <title>Before :</title>
- <desc>The worm's location before you decide to move it.</desc>
- <media type="image" height="148" width="175" src="figures/before-rel.png"/>
- </figure>
- </td>
- <td>
- <figure>
- <title>On pressing the <key>Right</key> key :</title>
- <desc>The worm turns right and begins to move downwards.</desc>
- <media type="image" height="148" width="175" src="figures/after-rel.png"/>
- </figure>
- </td>
- </tr>
- <tr>
- <td colspan="2">
- <note style="info">
- <p>If relative movement was not enabled, you would press the
- <key>Down</key> key to achieve the above result.</p>
- </note>
- </td>
- </tr>
- </table>
+<!--
+ <table frame="all">
+ <tr>
+ <td>
+ <figure>
+ <title>Starting postion:</title>
+ <desc>The location of the worm before you decide to move it.</desc>
+ <media type="image" src="figures/before-rel.png"/>
+ </figure>
+ </td>
+ <td>
+ <figure>
+ <title>On pressing the <key>Right</key> key:</title>
+ <desc>The worm turns right and begins to move downwards.</desc>
+ <media type="image" src="figures/after-rel.png"/>
+ </figure>
+ </td>
+ </tr>
+ <tr>
+ <td colspan="2">
+ <note style="info">
+ <p>If relative movement was not enabled, you would press the
+ <key>Down</key> key to achieve the above result.</p>
+ </note>
+ </td>
+ </tr>
+ </table>
+-->
- <p>To enable relative movement:</p>
- <steps>
- <item>
- <p>Select <guiseq><gui style="menu">Settings</gui>
- <gui style="menuitem">Preferences</gui></guiseq>.</p>
- </item>
- <item>
- <p>Select the worm for which relative movement has to be enabled by
- clicking the appropriate <gui>Worm</gui> tab.</p>
- </item>
- <item>
- <p>Check the <gui style="checkbox">Use relative movement</gui>
- checkbox if it is unchecked.</p>
- </item>
- <item>
- <p>Click <gui style="button">Close</gui>.</p>
- </item>
- </steps>
+ <p>To enable relative movement:</p>
- </section>
+ <steps>
+ <item>
+ <p>Select <guiseq><gui style="menu">Settings</gui>
+ <gui style="menuitem">Preferences</gui></guiseq>.</p>
+ </item>
+ <item>
+ <p>Select the worm for which relative movement has to be enabled by
+ clicking the appropriate <gui>Worm</gui> tab.</p>
+ </item>
+ <item>
+ <p>Check the <gui style="checkbox">Use relative movement</gui> checkbox
+ if it is unchecked.</p>
+ </item>
+ <item>
+ <p>Click <gui style="button">Close</gui>.</p>
+ </item>
+ </steps>
</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index a6d01a2..451ea72 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -21,14 +21,14 @@ HELP_MEDIA = \
HELP_FILES = \
basics.page \
- change-controls.page \
+ controls-change.page \
+ controls-default.page \
fake-bonus.page \
- preferences.page \
index.page \
- controls.page \
multi-player.page \
- scores.page \
+ preferences.page \
rel-movement.page \
+ scores.page \
legal.xml
HELP_LINGUAS = ca cs 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]
