GNOME.org
 

[hitori] Convert documentation to Mallard

commit 135ec43dadddb5c9b0f7922a40ee29e526ba1d84
Author: Philip Withnall <philip tecnocode co uk>
Date:   Wed Jul 14 21:54:26 2010 +0100

    Convert documentation to Mallard

 help/C/customization.page |   13 ++++
 help/C/game.page          |   25 +++++++
 help/C/hitori.xml         |  167 ---------------------------------------------
 help/C/index.page         |   20 ++++++
 help/C/legal.xml          |   67 ------------------
 help/C/license.page       |   59 ++++++++++++++++
 help/C/playing.page       |   23 ++++++
 help/Makefile.am          |   12 ++-
 help/hitori.omf.in        |    4 +-
 9 files changed, 150 insertions(+), 240 deletions(-)
---
diff --git a/help/C/customization.page b/help/C/customization.page
new file mode 100644
index 0000000..73f4e37
--- /dev/null
+++ b/help/C/customization.page
@@ -0,0 +1,13 @@
+<?xml version="1.0"?>
+<page xmlns="http://projectmallard.org/1.0/"; type="topic" id="game">
+	<info>
+		<link type="guide" xref="index#play"/>
+		<desc>Changing how the game appears and plays.</desc>
+	</info>
+	<title>Customizing the Game</title>
+
+	<p>The game can be customized by changing the board size â?? boards from 5â??10 cells square are allowed.</p>
+	<p>To change the board size, choose an option from <guiseq><gui style="menu">Game</gui><gui style="menuitem">Board Size</gui></guiseq>.
+		<app>Hitori</app> will ask if you want to stop the current game if you're in the middle of one, then start a new game with the
+		requested board size.</p>
+</page>
diff --git a/help/C/game.page b/help/C/game.page
new file mode 100644
index 0000000..64369c7
--- /dev/null
+++ b/help/C/game.page
@@ -0,0 +1,25 @@
+<?xml version="1.0"?>
+<page xmlns="http://projectmallard.org/1.0/"; type="topic" id="game">
+	<info>
+		<link type="guide" xref="index#play"/>
+		<desc>Introduction to the game of Hitori.</desc>
+	</info>
+	<title>Hitori the Game</title>
+
+	<p>Hitori is a small logic puzzle in a similar vein to the more popular Sudoku. In the game, the player starts with a square board of numbers,
+		and has to <em>paint out</em> cells until there are no duplicate numbers in each row and column. The following rules apply:</p>
+	<list>
+		<item><p>There must only be one of each number in the unpainted cells in each row and column.</p></item>
+		<item><p>No painted cell may be adjacent to another, vertically or horizontally.</p></item>
+		<item><p>All the unpainted cells must be joined together vertically and horizontally in one group.</p></item>
+	</list>
+	<p>These are the only three rules of the game, and so there may well be multiple solutions to a Hitori puzzle board.</p>
+
+	<figure>
+		<title>Main game window</title>
+		<desc><app>Hitori</app> main window</desc>
+		<media type="image" src="figures/hitori_main_window.png" mime="image/png" style="center">
+			<p><app>Hitori</app> main window.</p>
+		</media>
+	</figure>
+</page>
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..5759ebc
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<page xmlns="http://projectmallard.org/1.0/"; type="guide" id="index">
+	<info>
+		<revision pkgversion="0.2.4" version="0.2" date="2010-07-14" status="final"/>
+		<credit type="author copyright">
+			<name>Philip Withnall</name>
+			<email>philip tecnocode co uk</email>
+			<years>2008â??2010</years>
+		</credit>
+		<license 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-Share
+				Alike 3.0 Unported License</link>.</p>
+		</license>
+	</info>
+	<title>Hitori Help</title>
+
+	<section id="play" style="2column">
+		<title>Basic Gameplay &amp; Usage</title>
+	</section>
+</page>
diff --git a/help/C/license.page b/help/C/license.page
new file mode 100644
index 0000000..312b6cf
--- /dev/null
+++ b/help/C/license.page
@@ -0,0 +1,59 @@
+<page xmlns="http://projectmallard.org/1.0/";
+  type="topic"
+  id="license">
+  
+  <info>
+    <link type="seealso" xref="index"/>
+    <revision pkgversion="2.30" version="0.1" date="2009-12-28" status="draft"/>
+    <desc>Legal information.</desc>
+  </info>
+
+  <title>License</title>
+  <p>
+    <!-- 
+    Translators: try to use the same translation as the one provided by the CreativeCommons website. 
+    If there is no translation for your language, consider providing one to CreativeCommons.
+    -->
+    This work is distributed under a CreativeCommons Attribution-Share Alike
+    3.0 Unported license.
+  </p>
+  <p>
+    You are free:
+  </p>
+  <terms>
+    <item>
+      <title><em>To share</em></title>
+      <p>To copy, distribute and transmit the work.</p>
+    </item>
+    <item>
+      <title><em>To remix</em></title>
+      <p>To adapt the work.</p> 
+    </item>
+  </terms>
+  <p>
+    Under the following conditions:
+  </p>
+  <terms>
+    <item>
+      <title><em>Attribution</em></title>
+      <p>
+        You must attribute the work in the manner specified by the author or 
+        licensor (but not in any way that suggests that they endorse you or 
+        your use of the work).  
+      </p>
+    </item>
+    <item>
+      <title><em>Share Alike</em></title>
+      <p>
+        If you alter, transform, or build upon this work, you may distribute the 
+        resulting work only under the same, similar or a compatible license.  
+      </p>
+    </item>
+  </terms>
+  <p>
+    <!-- Translators: there are no official localized versions of the legal code, only the deed is localized. -->
+    For the full text of the license, see the 
+    <link href="http://creativecommons.org/licenses/by-sa/3.0/legalcode";>CreativeCommons website</link>, 
+    or read the full <link href="http://creativecommons.org/licenses/by-sa/3.0/";>Commons Deed</link>. 
+  </p>
+</page>
diff --git a/help/C/playing.page b/help/C/playing.page
new file mode 100644
index 0000000..735d1da
--- /dev/null
+++ b/help/C/playing.page
@@ -0,0 +1,23 @@
+<?xml version="1.0"?>
+<page xmlns="http://projectmallard.org/1.0/"; type="topic" id="game">
+	<info>
+		<link type="guide" xref="index#play"/>
+		<desc>Using <app>Hitori</app> to play a game.</desc>
+	</info>
+	<title>Playing a Game</title>
+
+	<p>To start a new game, choose <guiseq><gui style="menu">Game</gui><gui style="menuitem">New Game</gui></guiseq>. If you are already playing a
+		game, <app>Hitori</app> will ask if you want to stop the current game.</p>
+	<p>To paint a cell, click on it; to unpaint it again, click on it again. When cells are painted such that none
+		of the three rules are broken, the game will end and the board may no longer be manipulated.</p>
+	<p><app>Hitori</app> also allows you to highlight cells for your own reference when solving a board. This can be achieved by holding
+		<key>Ctrl</key> or <key>Shift</key> and clicking on a cell. They both highlight cells differently, and cells can be highlighted in
+		both manners at the same time. Highlighted cells can be de-highlighted by clicking on them again while holding either <key>Ctrl</key>
+		or <key>Shift</key> again.</p>
+	<p>To undo or redo a move, choose <guiseq><gui style="menu">Game</gui><gui style="menuitem">Undo</gui></guiseq> or
+		<guiseq><gui style="menu">Game</gui><gui style="menuitem">Redo</gui></guiseq>. You may undo or redo as many moves as you like without
+		restriction.</p>
+	<p>To get a hint on which cells to paint out, choose <guiseq><gui style="menu">Game</gui><gui style="menuitem">Hint</gui></guiseq>. A cell
+		will be highlighted with a flashing red outline. This shows that the current status of the cell (painted or unpainted) is incorrect,
+		and should be changed for the game to be won.</p>
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index 9a77ee1..52a2cf8 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -1,11 +1,15 @@
 include $(top_srcdir)/gnome-doc-utils.make
 dist-hook: doc-dist-hook
 
-DOC_MODULE = hitori
-DOC_ENTITIES = 
-DOC_INCLUDES = legal.xml
-DOC_FIGURES = figures/hitori_main_window.png
+DOC_ID = hitori
 DOC_LINGUAS = cs da de en_GB es sv zh_CN
+DOC_FIGURES = figures/hitori_main_window.png
+DOC_PAGES = \
+	customization.page \
+	game.page \
+	index.page \
+	license.page \
+	playing.page
 
 EXTRA_DIST = ChangeLog.pre-0-2-2
 
diff --git a/help/hitori.omf.in b/help/hitori.omf.in
index a9a910e..703137d 100644
--- a/help/hitori.omf.in
+++ b/help/hitori.omf.in
@@ -4,6 +4,6 @@
 		<subject category="Applications|Games|Puzzles"/>
 		<type>user's guide</type>
 		<relation seriesid="fb047f58-45d4-46d8-a8c4-16cfb8f322c2"/>
-		<rights type="GNU FDL" license.version="1.2" holder="Philip Withnall"/>
-	</resource>        
+		<rights type="cc-by-sa" license.version="3.0" holder="Philip Withnall"/>
+	</resource>
 </omf>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]