GNOME.org
 

[iagno] Rework help main pages.

commit 28446a69beadccceb4ffa8edc5b9e13418689027
Author: Arnaud Bonatti <arnaud bonatti gmail com>
Date:   Sun Feb 2 05:09:08 2020 +0100

    Rework help main pages.

 help/C/2player.page        | 30 ++++++++++++++++++------------
 help/C/ai-game.page        | 31 ++++++++++++++++++-------------
 help/C/ai-level.page       | 31 +++++++++++++++++++++++++++++++
 help/C/change-color.page   | 26 --------------------------
 help/C/configure.page      | 31 +++++++++++++++++++++++++++++++
 help/C/index.page          |  2 +-
 help/C/select-game.page    | 33 +++++++++++++++++++++++++++++++++
 help/C/start-position.page |  4 ++--
 help/meson.build           |  4 +++-
 9 files changed, 137 insertions(+), 55 deletions(-)
---
diff --git a/help/C/2player.page b/help/C/2player.page
index 820e36d..6d22844 100644
--- a/help/C/2player.page
+++ b/help/C/2player.page
@@ -1,23 +1,29 @@
 <page xmlns="http://projectmallard.org/1.0/";
       type="topic" style="task"
       id="2player">
+
   <info>
-    <link type="guide" xref="index#play" />
-    <revision version="0.1" date="2012-03-08" status="final"/>
-    <revision pkgversion="3.34" version="0.2" date="2020-01-03" status="final"/>
+    <link type="guide" xref="index#play"/>
+    <revision pkgversion="3.36" version="0.2" date="2020-02-02" status="final"/>
 
     <credit type="author copyright">
-      <name>Brian Grohe</name>
-      <email>grohe43 gmail com</email>
-      <years>2012</years>
-    </credit>
-    <credit type="editor">
-     <name>Tiffany Antopolski</name>
-     <email>tiffany antopolski gmail com</email>
+      <name>Arnaud Bonatti</name>
+      <email>arnaud bonatti gmail com</email>
+      <years>2020</years>
     </credit>
+
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
   </info>
 
-  <title>Two-player mode</title>
-  <p>Two player mode allows you to play against another human rather than a computer. To enable this, select 
<gui>Two</gui> under <gui>Players</gui> on the <gui>New Game</gui> screen.</p>
+  <title>Play with another player</title>
+
+  <p><app>Reversi</app> allows you to play against another human, instead of against the computer.</p>
+
+  <p>When <link xref="configure">configuring a new game</link>, have a look to the first button with a down 
arrow; it should either be labelled <gui>Color: Dark</gui>, <gui>Color: Light</gui> or <gui>Two 
players</gui>. In the latter case, <app>Reversi</app> is already configured to start a two-player game, else 
it would start a game against the computer.</p>
+
+  <p>If the button does not indicate <gui>Two players</gui>, select it, and in the menu that appears, select 
<gui>Two players</gui>. The button will change its label to <gui>Two players</gui>. You can then select the 
<gui>Start Game</gui> button to launch your game and <link xref="play">play</link>.</p>
 
+  <p>If you asked the game to <link xref="start-position">vary start position</link> and start a two-player 
game, you will start the game with a special <link xref="start-position#human-overture">two-player game 
overture</link>.</p>
 </page>
diff --git a/help/C/ai-game.page b/help/C/ai-game.page
index c9b6a83..5d7595a 100644
--- a/help/C/ai-game.page
+++ b/help/C/ai-game.page
@@ -1,26 +1,31 @@
 <page xmlns="http://projectmallard.org/1.0/";
       type="topic" style="task"
       id="ai-game">
+
   <info>
-    <link type="guide" xref="index#play" />
-    <revision version="0.1" date="2012-03-08" status="final"/>
-    <revision pkgversion="3.34" version="0.2" date="2020-01-03" status="final"/>
+    <link type="guide" xref="index#play"/>
+    <revision pkgversion="3.36" version="0.2" date="2020-02-02" status="final"/>
 
     <credit type="author copyright">
-      <name>Brian Grohe</name>
-      <email>grohe43 gmail com</email>
-      <years>2012</years>
-    </credit>
-   <credit type="editor">
-     <name>Tiffany Antopolski</name>
-     <email>tiffany antopolski gmail com</email>
+      <name>Arnaud Bonatti</name>
+      <email>arnaud bonatti gmail com</email>
+      <years>2020</years>
     </credit>
 
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
   </info>
 
   <title>Play against the computer</title>
-   <p>The computer has different levels of difficulty: <gui>Easy</gui>, <gui>Medium</gui>, and 
<gui>Hard</gui>.
-   To change this setting, choose a different setting under <gui>Difficulty</gui>
-   on the <gui>New Game</gui> screen.</p>
 
+  <p><app>Reversi</app> allows you to play against the computer, with three different levels of difficulty. 
You can also decide which player, between the computer and you, will start.</p>
+
+  <p>When <link xref="configure">configuring a new game</link>, have a look to the first button with a down 
arrow; it should either be labelled <gui>Color: Dark</gui>, <gui>Color: Light</gui> or <gui>Two 
players</gui>. In the two first cases, <app>Reversi</app> is already configured to start a game against the 
computer, else it would start a two-player game.</p>
+
+  <p>If the button is labelled <gui>Color: Dark</gui>, that means that you will do the first move. Of 
course, <gui>Color: Light</gui> means that it will be the computer.</p>
+
+  <p>If the button indicates <gui>Two players</gui>, select it, and in the menu that appears, select 
<gui>Play first (Dark)</gui> if you want to start the game, or <gui>Play second (Light)</gui> if you want the 
computer to start. The button will change its label to <gui>Color: Dark</gui> in the former case, and to 
<gui>Color: Light</gui> in the latter.</p>
+
+  <p>Once you have configured <app>Reversi</app> to play a game against the computer, you may <link 
xref="ai-level">change the computer level</link>.</p>
 </page>
diff --git a/help/C/ai-level.page b/help/C/ai-level.page
new file mode 100644
index 0000000..ace7bad
--- /dev/null
+++ b/help/C/ai-level.page
@@ -0,0 +1,31 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="ai-level">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+    <revision pkgversion="3.36" version="0.1" date="2020-02-02" status="final"/>
+
+    <credit type="author copyright">
+      <name>Arnaud Bonatti</name>
+      <email>arnaud bonatti gmail com</email>
+      <years>2020</years>
+    </credit>
+
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+  <title>Change the computer level</title>
+
+  <p><app>Reversi</app> offers you three level of difficulty if you want to play against the computer.</p>
+
+  <p>These levels are called: <em>Easy</em>, <em>Medium</em>, and <em>Hard</em>. The first one is suitable 
for beginners, the second for casual players, and the last one should please regular players.</p>
+
+  <p>When <link xref="configure">configuring a new game</link>, have a look to the second button with a down 
arrow; it should either be labelled <gui>Difficulty: Easy</gui>, <gui>Difficulty: Medium</gui>, 
<gui>Difficulty: Hard</gui> or <gui>More options</gui>. The first three possibilities indicate which one of 
the three levels would be used if starting a new game. In the latter case, <app>Reversi</app> is currently 
configured for a two-player game, and you should first configure that you want to <link xref="ai-game">play 
against the computer</link>.</p>
+
+  <p>Once that is done, if the indicated level is not the one you want, select the button, and in the menu 
that appears, select <gui>Easy</gui>, <gui>Medium</gui> or <gui>Hard</gui>, as you prefer. The button will 
change its label accordingly.</p>
+
+  <p>When the indicated level is good for your, you can select the <gui>Start Game</gui> button to launch 
your game and <link xref="play">play</link>.</p>
+</page>
diff --git a/help/C/configure.page b/help/C/configure.page
new file mode 100644
index 0000000..5271a30
--- /dev/null
+++ b/help/C/configure.page
@@ -0,0 +1,31 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="configure">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+    <revision pkgversion="3.36" version="0.1" date="2020-02-02" status="final"/>
+
+    <credit type="author copyright">
+      <name>Arnaud Bonatti</name>
+      <email>arnaud bonatti gmail com</email>
+      <years>2020</years>
+    </credit>
+
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+  <title>Configure a new game</title>
+
+  <p>When <app>Reversi</app> is opened, it displays a screen that allows you to configure a new game and to 
launch it.</p>
+
+  <p>This screen notably allows to select if you want to play <link xref="select-game"><em>Classic 
Reversi</em> or <em>Reverse Reversi</em></link>, to choose if you are going to play <link 
xref="ai-game">against the computer</link> or <link xref="2player">with another player</link>, and in the 
former case to <link xref="ai-level">change the computer level</link>.</p>
+
+  <p>If you are opening the application for the first time, <app>Reversi</app> defaults on an easy 
<em>Classic Reversi</em> against the computer. Else, it will have remembered you previous settings.</p>
+
+  <p>For launching a game from here, just click on the <gui>Start Game</gui> button. A game can also be 
launched with the <keyseq><key>Shift</key><key>Ctrl</key><key>N</key></keyseq> <link 
xref="shortcuts#game-selection">keyboard shortcut</link>.</p>
+
+  <p>Once a game has been launched, you can always go back to this screen by clicking on the <gui>New 
Game</gui> button, or using the <keyseq><key>Ctrl</key><key>N</key></keyseq> <link 
xref="shortcuts#during-game">keyboard shortcut</link>.</p>
+</page>
diff --git a/help/C/index.page b/help/C/index.page
index 7a77811..0b7e482 100644
--- a/help/C/index.page
+++ b/help/C/index.page
@@ -28,7 +28,7 @@
 
   <p><app>Reversi</app> is a boardgame played with pieces dark on one side and light on the other. 
<em>Dark</em> and <em>Light</em> play one after each other by adding on an empty tile a new piece of their 
color, trapping at least one opponent row of pieces; when pieces are captured that way, they are turned over 
to join the capturing player's forces. See <link xref="rules">reversi rules</link> to discover more about the 
game.</p>
 
-  <p><app>Reversi</app> allows you to play both the Classic version of reversi, where you try to dominate 
the board at the end, and the Reverse one, where the goal is to finish with <em>less</em> pieces than your 
opponent. You can play both either <link xref="ai-game">against the computer</link> or <link 
xref="2player">with another player</link>. Have fun!</p>
+  <p><app>Reversi</app> allows you to play <link xref="select-game">two variations of the reversi 
game</link>: the classic version of reversi, where you try to dominate the board at the end, and the 
<em>Reverse Reversi</em>, where the goal is to finish with <em>less</em> pieces than your opponent. You can 
play both either <link xref="ai-game">against the computer</link> or <link xref="2player">with another 
player</link>. Check these options when you <link xref="configure">configure a new game</link>. Have fun!</p>
 
   <section id="play" style="2column">
     <title>Game Play</title>
diff --git a/help/C/select-game.page b/help/C/select-game.page
new file mode 100644
index 0000000..677fece
--- /dev/null
+++ b/help/C/select-game.page
@@ -0,0 +1,33 @@
+<page xmlns="http://projectmallard.org/1.0/";
+      type="topic" style="task"
+      id="select-game">
+
+  <info>
+    <link type="guide" xref="index#play"/>
+    <revision pkgversion="3.36" version="0.1" date="2020-02-02" status="final"/>
+
+    <credit type="author copyright">
+      <name>Arnaud Bonatti</name>
+      <email>arnaud bonatti gmail com</email>
+      <years>2020</years>
+    </credit>
+
+    <license>
+      <p>Creative Commons Share Alike 3.0</p>
+    </license>
+  </info>
+
+  <title><em>Classic Reversi</em> or <em>Reverse Reversi</em></title>
+
+  <p><app>Reversi</app> allows you to play two variants of the same game: <em>Classic Reversi</em> and 
<em>Reverse Reversi</em>.</p>
+
+  <p>When <link xref="configure">configuring a new game</link>, just choose the game you want to play by 
selecting the <gui>Classic Reversi</gui> or <gui>Reverse Reversi</gui> buttons.</p>
+
+  <p>As you can imagine with its name, the <em>Classic Reversi</em> game is the reversi as it is known 
around the world.</p>
+
+  <p>Both games are in fact using the same rules; only the end goal differs between them: in <em>Classic 
Reversi</em>, the goal is to finish with <em>more</em> pieces than the opponent; while in <em>Reverse 
Reversi</em>, it is to finish with <em>less</em> pieces.</p>
+
+  <p>This variation in the goal makes <em>Reverse Reversi</em> a quite interesting game, as you have to 
elaborate a different <link xref="strategy">strategy</link> to win. Try it!</p>
+
+  <p>If you want to try other variations of the reversi game, you can also choose to <link 
xref="start-position">vary start position</link>.</p>
+</page>
diff --git a/help/C/start-position.page b/help/C/start-position.page
index 996b796..a0650c4 100644
--- a/help/C/start-position.page
+++ b/help/C/start-position.page
@@ -29,7 +29,7 @@
 
     <p>If you are playing a <link xref="ai-game">game against the computer</link>, enabling this option will 
start new games with a random position in the six <link xref="#start-positions">possible start 
positions</link>.</p>
 
-    <p>If you are playing a <link xref="2player">two-player game</link>, enabling this option will start new 
games with the <link xref="#human-overture">two-player game overture</link>.</p>
+    <p>If you are <link xref="2player">playing with another player</link>, enabling this option will start 
new games with the <link xref="#human-overture">two-player game overture</link>.</p>
 
     <p>If the option is disabled, then the usual position of the reversi game family is always used for new 
games. See its description in the list of <link xref="#start-positions">possible start positions</link>.</p>
   </section>
@@ -95,7 +95,7 @@
   <section id="human-overture">
     <title>Two-player game overture</title>
 
-    <p>When playing a <link xref="2player">two-player game</link> with the the <link 
xref="#varying-start-position"><gui>Vary start position</gui></link> option enabled, new games will start 
with a special two-player game overture.</p>
+    <p>When <link xref="2player">playing with another player</link> with the the <link 
xref="#varying-start-position"><gui>Vary start position</gui></link> option enabled, new games will start 
with a special two-player game overture.</p>
 
     <p>The board is started empty. The two players are going to place the four initial pieces before 
starting the game.</p>
 
diff --git a/help/meson.build b/help/meson.build
index d0e6331..f72498f 100644
--- a/help/meson.build
+++ b/help/meson.build
@@ -17,8 +17,9 @@ help_media = [
 help_files = [
     '2player.page',
     'ai-game.page',
+    'ai-level.page',
     'bug-filing.page',
-    'change-color.page',
+    'configure.page',
     'develop.page',
     'documentation.page',
     'example.page',
@@ -28,6 +29,7 @@ help_files = [
     'license.page',
     'play.page',
     'rules.page',
+    'select-game.page',
     'shortcuts.page',
     'sound.page',
     'start-position.page',
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]