GNOME.org
 

[gnome-klotski/wip/mallard-help-merge: 7/33] help: Add initial help pages

commit 54e4de38bbb3c01be59d9a635f08149e4055abb9
Author: Rashi Aswani <aswanirashi19 gmail com>
Date:   Fri May 23 00:18:41 2014 +0530

    help: Add initial help pages
    
    Also adds logo images, legal.xml and Makefile.am

 help/C/figures/logo.png       |  Bin 0 -> 649 bytes
 help/C/figures/logo32.png     |  Bin 0 -> 2537 bytes
 help/C/game-introduction.page |   26 ++++++++++
 help/C/index.page             |   41 +++++++++++++++
 help/C/legal.xml              |    5 ++
 help/C/moves.page             |   34 ++++++++++++
 help/C/puzzles-moves.page     |  112 +++++++++++++++++++++++++++++++++++++++++
 help/C/puzzles.page           |   38 ++++++++++++++
 help/C/rules.page             |   45 ++++++++++++++++
 help/C/scores.page            |   33 ++++++++++++
 help/C/shortcuts.page         |   35 +++++++++++++
 help/C/start-game.page        |   41 +++++++++++++++
 help/Makefile.am              |   22 ++++++++
 13 files changed, 432 insertions(+), 0 deletions(-)
---
diff --git a/help/C/figures/logo.png b/help/C/figures/logo.png
new file mode 100644
index 0000000..73d60f3
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..e6d4903
Binary files /dev/null and b/help/C/figures/logo32.png differ
diff --git a/help/C/game-introduction.page b/help/C/game-introduction.page
new file mode 100644
index 0000000..0d8a2f6
--- /dev/null
+++ b/help/C/game-introduction.page
@@ -0,0 +1,26 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="game-introduction">
+
+  <info>
+    <link type="guide" xref="index"/>
+    <revision version="3.12" date="2014-06-02" 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>Introduction</title>
+
+  <p><app>The Klotski</app> application is same as the Klotski game. The
+  objective of the game is to move the patterned block to the area bordered by
+  the green markers in the minimum number of moves. You can achieve this by
+  sliding the blocks horizontally or vertically.</p>
+
+</page>
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..3a3696c
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,41 @@
+<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">Klotski</title>
+    <title type="text">Klotski</title>
+    <desc>GNOME Klotski help.</desc>
+    <revision version="3.12" date="2014-05-22" 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">
+  Klotski logo</media> Klotski</title>
+  <p>Slide blocks to solve the puzzle. You can visit
+  <link xref="game-introduction">Game introduction</link> to know more about
+  the game. Other help topics are grouped together into sections below.</p>
+
+
+  <section id="play" style="2column">
+    <title>Playing Klotski</title>
+  </section>
+
+  <section id="tips" style="2column">
+    <title>Useful tips</title>
+  </section>
+
+  <section id="advanced" style="2column">
+    <title>Advanced</title>
+  </section>
+
+</page>
diff --git a/help/C/legal.xml b/help/C/legal.xml
new file mode 100644
index 0000000..cb5d83f
--- /dev/null
+++ b/help/C/legal.xml
@@ -0,0 +1,5 @@
+<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/moves.page b/help/C/moves.page
new file mode 100644
index 0000000..b6c5123
--- /dev/null
+++ b/help/C/moves.page
@@ -0,0 +1,34 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="moves">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+    <revision version="3.12" date="2014-05-24" 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>Moves</title>
+
+  <p>You can see your number of moves at the top of the game screen. The 
+  consecutive moves of a block are considered to be a single move. For example,
+  moving a block up one square then right two squares is considered one
+  move.</p>
+
+  <section id="patterned-block-moves">
+    <title>Goal piece moves</title>
+      <p>The goal location may be positioned slightly off the board and the
+      goal piece which is the patterned block is always permitted to move to
+      it. However, no other blocks are permitted to move off the board</p>
+  </section>
+ 
+</page>
diff --git a/help/C/puzzles-moves.page b/help/C/puzzles-moves.page
new file mode 100644
index 0000000..9c0778e
--- /dev/null
+++ b/help/C/puzzles-moves.page
@@ -0,0 +1,112 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="puzzles-moves">
+
+  <info>
+    <link type="guide" xref="index#tips"/>
+    <revision version="3.12" date="2014-05-24" 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>Minimum number of moves</title>
+
+  <p>Each puzzle is different from the other in the manner of, the minimum
+  number of moves to solve them and the various positions of the blocks in it.
+  You can find the minimum number of moves for the various puzzles below.</p>
+  
+  <table frame="all" rules="rows cols">
+    <tr>
+      <td><p>Puzzles</p></td> <td><p>Minimum number of moves</p></td>
+    </tr>
+    <tr>
+      <td><p>Only 18 Steps</p></td> <td><p>18</p></td>
+    </tr>
+    <tr>
+      <td><p>Daisy</p></td> <td><p>28</p></td>
+    </tr>
+    <tr>
+      <td><p>Violet</p></td> <td><p>27</p></td>
+    </tr>
+    <tr>
+      <td><p>Poppy</p></td> <td><p>40</p></td>
+    </tr>
+    <tr>
+      <td><p>Pansy</p></td> <td><p>28</p></td>
+    </tr>
+    <tr>
+      <td><p>Snowdrop</p></td> <td><p>46</p></td>
+    </tr>
+    <tr>
+      <td><p>Red Donkey</p></td> <td><p>81</p></td>
+    </tr>
+    <tr>
+      <td><p>Trail</p></td> <td><p>102</p></td>
+    </tr>
+    <tr>
+      <td><p>Ambush</p></td> <td><p>120</p></td>
+    </tr>
+    <tr>
+      <td><p>Agatka</p></td> <td><p>30</p></td>
+    </tr>
+    <tr>
+      <td><p>Success</p></td> <td><p>25</p></td>
+    </tr>
+    <tr>
+      <td><p>Bone</p></td> <td><p>14</p></td>
+    </tr>
+    <tr>
+      <td><p>Fortune</p></td> <td><p>24</p></td>
+    </tr>
+    <tr>
+      <td><p>Fool</p></td> <td><p>29</p></td>
+    </tr>
+    <tr>
+      <td><p>Solomon</p></td> <td><p>29</p></td>
+    </tr>
+    <tr>
+      <td><p>Cleopatra</p></td> <td><p>31</p></td>
+    </tr>
+    <tr>
+      <td><p>Shark</p></td> <td><p>48</p></td>
+    </tr>
+    <tr>
+      <td><p>Rome</p></td> <td><p>38</p></td>
+    </tr>
+    <tr>
+      <td><p>Pennant Puzzle</p></td> <td><p>59</p></td>
+    </tr>
+    <tr>
+      <td><p>Ithaca</p></td> <td><p>?</p></td>
+    </tr>
+    <tr>
+      <td><p>Pelopones</p></td> <td><p>25</p></td>
+    </tr>
+    <tr>
+      <td><p>Lodzianka</p></td> <td><p>21</p></td>
+    </tr>
+    <tr>
+      <td><p>Polonaise</p></td> <td><p>23</p></td>
+    </tr>
+    <tr>
+      <td><p>Baltic Sea</p></td> <td><p>42</p></td>
+    </tr>
+    <tr>
+      <td><p>American Pie</p></td> <td><p>?</p></td>
+    </tr>
+    <tr>
+      <td><p>Traffic Jam</p></td> <td><p>132</p></td>
+    </tr>
+    <tr>
+      <td><p>Sunshine</p></td> <td><p>345</p></td>
+    </tr>
+  </table>
+
+</page>
diff --git a/help/C/puzzles.page b/help/C/puzzles.page
new file mode 100644
index 0000000..947237e
--- /dev/null
+++ b/help/C/puzzles.page
@@ -0,0 +1,38 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="puzzles">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+    <revision version="3.12" date="2014-05-24" 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>Puzzles</title>
+  <p>Puzzles are divided into three categories namely, <gui>HuaRong
+  Trail</gui>, <gui>Challenge Pack</gui> and <gui>Skill Pack</gui> based on the
+  difficulty level of the game. While the first and the last each contains nine
+  puzzles, the second one provides ten beautiful puzzles to the user.</p>
+
+  <section id="navigate-puzzles">
+    <title>Navigate among puzzles</title>
+      <p>To navigate between the puzzles:</p>
+        <steps>
+          <item><p>Click on <gui style="button">View Puzzles</gui> in the
+          bottom right, choose a category. All the puzzles in the category will
+          be displayed</p></item>
+          <item><p>You can navigate sequentially among the puzzles with the
+          <gui style="button">Next Puzzle</gui> and <gui style="button">
+          Previous Puzzle</gui>.</p></item>
+        </steps>
+  </section>
+
+</page>
diff --git a/help/C/rules.page b/help/C/rules.page
new file mode 100644
index 0000000..8fcf97d
--- /dev/null
+++ b/help/C/rules.page
@@ -0,0 +1,45 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="rules">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+    <revision version="3.12" date="2014-05-23" 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 rules</title>
+
+  <p>You have to follow some rules while sliding the blocks in order to solve
+  <app>Klotski</app>. The rules are listed below:</p>
+
+  <section id="move-block">
+    <title>Move a block</title>
+      <steps>
+        <item><p>Click on the block to be moved.</p></item> 
+        <item><p>Move the block to the desired location with the help of
+        mouse.</p></item>
+        <item><p>Click on the block again.</p></item>
+      </steps>
+  </section>
+
+ <section id="rules">
+   <title>Rules to move a block</title>
+     <list>
+       <item><p>You can not move the green blocks and the boundary
+       blocks.</p></item>
+       <item><p>You can not move over a block with the exception that the
+       patterned block can move across the green blocks.</p></item>
+       <item><p>You can take more than one step in a single move.</p></item>
+    </list>
+ </section>
+
+</page>
diff --git a/help/C/scores.page b/help/C/scores.page
new file mode 100644
index 0000000..da6bb33
--- /dev/null
+++ b/help/C/scores.page
@@ -0,0 +1,33 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic"
+      id="scores">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+    <revision version="3.12" date="2014-05-26" 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 compare your performance by looking at the number of moves you
+  took in solving each puzzle in the previous games. To view your number of
+  moves:</p>
+    <steps>
+      <item><p>Select <guiseq><gui style="menu">Klotski</gui>
+      <gui style="menuitem">Scores</gui></guiseq>.</p></item>
+      <item><p> The dialog will display the <gui>Only 18 steps</gui> puzzle by
+      default, to view other puzzles, select them in the drop down menu at the
+      top of the dialog.</p></item>
+      <item><p>Click on <gui style="button">OK</gui> to close the scores dialog
+      box.</p></item>
+    </steps>
+</page>
diff --git a/help/C/shortcuts.page b/help/C/shortcuts.page
new file mode 100644
index 0000000..d0e2779
--- /dev/null
+++ b/help/C/shortcuts.page
@@ -0,0 +1,35 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="shortcuts">
+  <info>
+    <link type="guide" xref="index#advanced" />
+    <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>Some things can be done with a simple press of a key. Here are a few
+  Keyboard shortcuts for <app>Klotski</app>:</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/start-game.page b/help/C/start-game.page
new file mode 100644
index 0000000..aeba81f
--- /dev/null
+++ b/help/C/start-game.page
@@ -0,0 +1,41 @@
+<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-05-26" 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><app>Klotski</app> offers you a large collection of games, to play a new
+  game:</p>
+    <steps>
+      <item><p>Select <guiseq><gui style="menu">Klotski</gui>
+      <gui style="menuitem">New Game</gui></guiseq> from the application menu.
+      Alternatively, you can click the <gui style="button">Start Over</gui>
+      button in the bottom right. It will start a new game of the default
+      puzzle, <gui>Only 18 steps</gui>.</p></item>
+      <item><p>To play a different puzzle, click the <gui style="button">View
+      Puzzles</gui> button, choose a game category and start a new puzzle by
+      double clicking on it.</p></item>
+    </steps>
+ 
+  <section id="new-game-on-close">
+  <title>Start a new game on completion of a puzzle</title>
+
+  <p>On finishing a puzzle, you can start a new game of the same puzzle
+  directly. To start a new game, click on <gui>New Game</gui> in the appeared
+  dialog box.</p>
+  </section>
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
new file mode 100644
index 0000000..985e937
--- /dev/null
+++ b/help/Makefile.am
@@ -0,0 +1,22 @@
+ YELP_HELP_RULES@
+
+HELP_ID = tali
+HELP_MEDIA = \
+  figures/logo32.png \
+  figures/logo.png
+HELP_FILES = \
+  index.page \
+  rules.page \
+  puzzles.page \
+  start-game.page \
+  scores.page \
+  puzzles-moves.page \
+  moves.page \
+  scores.page \
+  game-introduction.page \
+  shortcuts.page \
+  legal.xml
+
+HELP_LINGUAS = 
+
+-include $(top_srcdir)/git.mk
\ No newline at end of file
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]