[gnome-user-docs: 2/19] Added template for games help files

[Shaun McCance <shaunm src gnome org>]

commit d8c368a22fa92ca073217e18733e5b8634b0ff6a
Author: Phil Bull <philbull gmail com>
Date:   Thu Jun 24 17:04:53 2010 +0100

    Added template for games help files

 gnome-help/C/templates/games/GENERIC.page.stub     |   37 ++++++++++++++
 gnome-help/C/templates/games/README                |   11 ++++
 .../C/templates/games/controls-changing.page.stub  |   26 ++++++++++
 gnome-help/C/templates/games/controls.page.stub    |   46 +++++++++++++++++
 gnome-help/C/templates/games/gameplay.page.stub    |   53 ++++++++++++++++++++
 gnome-help/C/templates/games/index.page            |   19 +++++++
 gnome-help/C/templates/games/multiplayer.page.stub |   36 +++++++++++++
 gnome-help/C/templates/games/strategy.page.stub    |   39 ++++++++++++++
 gnome-help/C/templates/games/tips.page.stub        |   32 ++++++++++++
 9 files changed, 299 insertions(+), 0 deletions(-)
---
diff --git a/gnome-help/C/templates/games/GENERIC.page.stub b/gnome-help/C/templates/games/GENERIC.page.stub
new file mode 100644
index 0000000..d5eea61
--- /dev/null
+++ b/gnome-help/C/templates/games/GENERIC.page.stub
@@ -0,0 +1,37 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" id="XXXXX">
+
+<info>
+ <desc>XXXXX</desc>
+
+ <revision pkgversion="1.0" version="1.0" date="YYYY-MM-DD" status="stub"/>
+ <!--<link type="guide" xref="index" />-->
+ <!--<link type="seealso" xref="YYYYY" />-->
+ 
+ <credit type="author">
+  <name>Your Name</name>
+  <email>you example com</email>
+ </credit>
+ <license><p>Creative Commons Share Alike 3.0</p></license>
+</info>
+
+<title>XXXXX</title>
+
+<p></p>
+
+<section>
+ <title></title>
+ <p></p>
+</section>
+
+<list>
+ <item><p></p></item>
+</list>
+
+<comment>
+ <title>Purpose of document</title>
+ <cite date="YYYY-MM-DD" href="mailto:you example com">Your Name</cite>
+ <p></p>
+</comment>
+
+</page>
diff --git a/gnome-help/C/templates/games/README b/gnome-help/C/templates/games/README
new file mode 100644
index 0000000..0a6e0f2
--- /dev/null
+++ b/gnome-help/C/templates/games/README
@@ -0,0 +1,11 @@
+This is a template Mallard document for application help for games.
+
+Each template topic has a comment which explains how it should be used.
+
+GENERIC.page.stub can be used as a generic topic page. Just make a copy, rename it, and edit the file to create a new topic. There are a few useful bits of Mallard markup in there already to save on typing.
+
+Rename the pages from ".page.stub" to ".page" when you have edited them.
+
+Contact the GNOME Documentation Team (gnome-doc-list gnome org) for help with this template.
+
+(Original author: Phil Bull <philbull gmail com>, 24-Jun-2010. The license for this template is Public Domain. You may relicense it as you wish.)
diff --git a/gnome-help/C/templates/games/controls-changing.page.stub b/gnome-help/C/templates/games/controls-changing.page.stub
new file mode 100644
index 0000000..9269ced
--- /dev/null
+++ b/gnome-help/C/templates/games/controls-changing.page.stub
@@ -0,0 +1,26 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" id="controls-changing">
+
+<info>
+ <desc>Customize the game controls and keyboard shortcuts.</desc>
+
+ <revision pkgversion="1.0" version="1.0" date="YYYY-MM-DD" status="stub"/>
+ <link type="guide" xref="index" />
+ 
+ <credit type="author">
+  <name>Your Name</name>
+  <email>you example com</email>
+ </credit>
+ <license><p>Creative Commons Share Alike 3.0</p></license>
+</info>
+
+<title>Changing the controls</title>
+
+<comment>
+ <title>Purpose of document</title>
+ <cite date="2010-06-24" href="mailto:gnome-doc-list gnome org">GNOME Documentation Project</cite>
+ <p>Use this topic to explain how the game controls can be changed.</p>
+ <p>This topic is linked to from <cmd>controls</cmd>.</p>
+</comment>
+
+</page>
diff --git a/gnome-help/C/templates/games/controls.page.stub b/gnome-help/C/templates/games/controls.page.stub
new file mode 100644
index 0000000..83cd1ec
--- /dev/null
+++ b/gnome-help/C/templates/games/controls.page.stub
@@ -0,0 +1,46 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" id="controls">
+
+<info>
+ <desc>A list of all the controls that can be used in the game.</desc>
+
+ <revision pkgversion="1.0" version="1.0" date="YYYY-MM-DD" status="stub"/>
+ <link type="guide" xref="index" />
+ 
+ <credit type="author">
+  <name>Your Name</name>
+  <email>you example com</email>
+ </credit>
+ <license><p>Creative Commons Share Alike 3.0</p></license>
+</info>
+
+<title>Controlling the game</title>
+
+<comment>
+ <title>Purpose of document</title>
+ <cite date="2010-06-24" href="mailto:gnome-doc-list gnome org">GNOME Documentation Project</cite>
+ <p>Use this topic to provide a full list of controls of the game.</p>
+ <p>Players can use this topic for reference.</p>
+ <p>Try to group controls in a logical manner. Use sections to group similar controls.</p>
+ <p>There is a link to a topic on changing controls in the second paragraph. Edit this paragraph so that it makes sense for your game.</p>
+</comment>
+
+<p>This is a complete list of all the controls that you can use in the game.</p>
+
+<p>You can <link xref="controls-changing">change the controls</link> by clicking <guiseq><gui>Edit</gui><gui>Preferences</gui></guiseq> and changing the options under the <gui>Controls</gui> tab.</p>
+
+<section>
+ <title>Moving around</title>
+ <terms>
+  <item>
+   <title>Jump</title>
+   <p>Press the right mouse button, or press <keyseq><key>Ctrl</key><key>j</key></keyseq>.</p>
+  </item>
+  <item>
+   <title>Run faster</title>
+   <p>Hold down the <key>spacebar</key>.</p>
+  </item>
+ </terms>
+</section>
+
+</page>
diff --git a/gnome-help/C/templates/games/gameplay.page.stub b/gnome-help/C/templates/games/gameplay.page.stub
new file mode 100644
index 0000000..829f301
--- /dev/null
+++ b/gnome-help/C/templates/games/gameplay.page.stub
@@ -0,0 +1,53 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" id="gameplay">
+
+<info>
+ <desc>Learn the basic rules and controls of the game.</desc>
+
+ <revision pkgversion="1.0" version="1.0" date="YYYY-MM-DD" status="stub"/>
+ <link type="guide" xref="index" />
+ 
+ <credit type="author">
+  <name>Your Name</name>
+  <email>you example com</email>
+ </credit>
+ <license><p>Creative Commons Share Alike 3.0</p></license>
+</info>
+
+<title>Playing the game</title>
+
+<comment>
+ <title>Purpose of document</title>
+ <cite date="2010-06-24" href="mailto:gnome-doc-list gnome org">GNOME Documentation Project</cite>
+ <p>Use this topic to explain the fundamentals of how to play the game.</p>
+ <p>It should be a quick-start guide, which aims to get the user playing the game at a basic level as quickly as possible.</p>
+ <p>Only mention the more basic controls and rules. Link to other topics to explain things in more detail.</p>
+ <p>Make sure you state what the aim of the game is, and how you can win.</p>
+ <p>The level of this section should be quite basic. You should explain, in simple terms, how to make the basic moves of the game.</p>
+ <p>Use a new section for each major element of the game introduction. Which sections you have will depend on the game in question, but the following topics are likely to be quite common:</p>
+ <list>
+  <item><p>Aim of the game</p></item>
+  <item><p>Starting the game</p></item>
+  <item><p>Basic rules</p></item>
+  <item><p>Moving around/Making a move</p></item>
+  <item><p>Winning the game</p></item>
+ </list>
+ <p>A good way of deciding which sections to include in this topic is to watch a someone who has never played before try to play the game. The Documentation Team can help you with user testing of this sort.</p>
+</comment>
+
+<section>
+ <title>Aim of the game</title>
+ <p></p>
+</section>
+
+<section>
+ <title>Starting a new game</title>
+ <p></p>
+</section>
+
+<section>
+ <title>Moving around</title>
+ <p></p>
+</section>
+
+</page>
diff --git a/gnome-help/C/templates/games/index.page b/gnome-help/C/templates/games/index.page
new file mode 100644
index 0000000..66c3648
--- /dev/null
+++ b/gnome-help/C/templates/games/index.page
@@ -0,0 +1,19 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide" id="index">
+
+<info>
+ <desc>A Game</desc>
+
+ <revision pkgversion="1.0" version="1.0" date="YYYY-MM-DD" status="stub"/>
+ <link type="guide" xref="index" />
+ 
+ <credit type="author">
+  <name>Your Name</name>
+  <email>you example com</email>
+ </credit>
+ <license><p>Creative Commons Share Alike 3.0</p></license>
+</info>
+
+<title>A Game</title>
+
+</page>
diff --git a/gnome-help/C/templates/games/multiplayer.page.stub b/gnome-help/C/templates/games/multiplayer.page.stub
new file mode 100644
index 0000000..ce3cbc8
--- /dev/null
+++ b/gnome-help/C/templates/games/multiplayer.page.stub
@@ -0,0 +1,36 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide" id="multiplayer">
+
+<info>
+ <desc>Play against other people on the same computer, or online.</desc>
+
+ <revision pkgversion="1.0" version="1.0" date="YYYY-MM-DD" status="stub"/>
+ <link type="guide" xref="index" />
+ 
+ <credit type="author">
+  <name>Your Name</name>
+  <email>you example com</email>
+ </credit>
+ <license><p>Creative Commons Share Alike 3.0</p></license>
+</info>
+
+<title>Playing against other people (multiplayer)</title>
+
+<comment>
+ <title>Purpose of document</title>
+ <cite date="2010-06-24" href="mailto:gnome-doc-list gnome org">GNOME Documentation Project</cite>
+ <p>Use this guide page to collect topics which cover setting-up, joining, and playing multiplayer games.</p>
+ <p>Some games don't have multiplayer modes, and so won't need this page.</p>
+ <p>For consistency, consider starting the names of all multiplayer topics with "multiplayer-", e.g. "multiplayer-starting.page".</p>
+ <p>You should probably cover some of the following topics:</p>
+ <list>
+  <item><p>Starting a multiplayer game</p></item>
+  <item><p>Changing the controls for other players</p></item>
+  <item><p>Leaving a multiplayer game</p></item>
+  <item><p>Problems connecting to an online game</p></item>
+  <item><p>Joining an online game</p></item>
+  <item><p>Starting your own online multiplayer game</p></item>
+ </list>
+</comment>
+
+</page>
diff --git a/gnome-help/C/templates/games/strategy.page.stub b/gnome-help/C/templates/games/strategy.page.stub
new file mode 100644
index 0000000..5e230a0
--- /dev/null
+++ b/gnome-help/C/templates/games/strategy.page.stub
@@ -0,0 +1,39 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" id="strategy">
+
+<info>
+ <desc>Find ways of playing that increase your chances of success.</desc>
+
+ <revision pkgversion="1.0" version="1.0" date="YYYY-MM-DD" status="stub"/>
+ <link type="guide" xref="index" />
+ 
+ <credit type="author">
+  <name>Your Name</name>
+  <email>you example com</email>
+ </credit>
+ <license><p>Creative Commons Share Alike 3.0</p></license>
+</info>
+
+<title>Strategies</title>
+
+<comment>
+ <title>Purpose of document</title>
+ <cite date="2010-06-24" href="mailto:gnome-doc-list gnome org">GNOME Documentation Project</cite>
+ <p>Use this topic page to describe strategies that the user might be able to use to win the game. Use a new section for each major strategy.</p>
+ <p>The idea behind this topic is to give the user some hints on how they could improve their success rate in the game. Lots of games have useful (but not obvious) strategies; for example, Chess has the "castling" manoeuvre.</p>
+ <p>If possible, don't be too specific about how effective each strategy is. Telling the user which is the best strategy may make it too easy for them to win, and could spoil the game.</p>
+ <p>Don't mention particularly basic strategies that users will quickly discover for themselves anyway.</p>
+ <p>If the strategy sections are quite long or involved, convert this page into a guide page and put each strategy into its own topic page.</p>
+</comment>
+
+<section>
+ <title>WWW the XXX</title>
+ <p></p>
+</section>
+
+<section>
+ <title>When YYY, ZZZ</title>
+ <p></p>
+</section>
+
+</page>
diff --git a/gnome-help/C/templates/games/tips.page.stub b/gnome-help/C/templates/games/tips.page.stub
new file mode 100644
index 0000000..68dd966
--- /dev/null
+++ b/gnome-help/C/templates/games/tips.page.stub
@@ -0,0 +1,32 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="guide" id="tips">
+
+<info>
+ <desc>Tips to help you get the most out of the game.</desc>
+
+ <revision pkgversion="1.0" version="1.0" date="YYYY-MM-DD" status="stub"/>
+ <link type="guide" xref="index" />
+ 
+ <credit type="author">
+  <name>Your Name</name>
+  <email>you example com</email>
+ </credit>
+ <license><p>Creative Commons Share Alike 3.0</p></license>
+</info>
+
+<title>Tip and Tricks</title>
+
+<comment>
+ <title>Purpose of document</title>
+ <cite date="2010-06-24" href="mailto:gnome-doc-list gnome org">GNOME Documentation Project</cite>
+ <p>Use this guide page to collect topics which provide useful tips on how to play the game.</p>
+ <p>Tips and tricks are information that help the user play the game in a more satisfying or efficient way. These might include:</p>
+ <list>
+  <item><p>Ways of controlling the game that aren't obvious, like shortcut keys or certain mouse gestures</p></item>
+  <item><p>Simple strategies that the user can try to have more chance of winning the game</p></item>
+  <item><p>Things to try when faced with certain situations</p></item>
+  <item><p>Sensible options to take in certain situations</p></item>
+ </list>
+</comment>
+
+</page>