← Back to branch summary

~neon/kdegames/trunk

« back to all changes in this revision

Viewing changes to doc/kreversi/index.docbook

  • Committer: aacid
  • Date: 2012-08-18 14:19:55 UTC
  • Revision ID: svn-v4:283d02a7-25f6-0310-bc7c-ecb5cbfe19da:trunk/KDE/kdegames:1311445
move the doc folders inside of each of the apps, will ease git migration

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/kreversi/index.docbook
1
 
<?xml version="1.0" ?>
2
 
<!--IMPORTANT: please note that'do not change this!' notice does not apply to translators -->
3
 
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
4
 
  <!ENTITY kappname "&kreversi;">
5
 
  <!ENTITY kappversion "2.0"><!--Applicaion version. Use this variable everywhere it's needed.-->
6
 
  <!ENTITY package "kdegames">  <!-- do not change this! -->
7
 
  <!ENTITY % English "INCLUDE" > <!-- change language only here -->
8
 
  <!ENTITY % addindex "IGNORE"> <!-- do not change this! -->
9
 
]>
10
 
 
11
 
<book lang="&language;"> <!-- do not change this! -->
12
 
<bookinfo>
13
 
        <title>The &kappname; Handbook</title> <!-- This is the title of the docbook. Leave as is unless change is necessary.-->
14
 
<!-- List of immidiate authors begins here. -->
15
 
<!--INPORTANT! - All other contributors: [to be determined] -->
16
 
<authorgroup>
17
 
<author>
18
 
<firstname>Clay</firstname>
19
 
<surname>Pradarits</surname>
20
 
<affiliation>
21
 
<address>&Clay.Pradarits.mail;</address>
22
 
</affiliation>
23
 
</author>
24
 
 
25
 
<othercredit role="developer">
26
 
<firstname>Mario</firstname>
27
 
<surname>Weilguni</surname>
28
 
<affiliation>
29
 
<address>&Mario.Weilguni.mail;</address></affiliation>
30
 
<contrib>Developer</contrib>
31
 
</othercredit>
32
 
 
33
 
<othercredit role="reviewer">
34
 
<firstname>Lauri</firstname>
35
 
<surname>Watts</surname>
36
 
<contrib>Reviewer</contrib>
37
 
<affiliation><address>
38
 
&Lauri.Watts.mail;
39
 
</address></affiliation>
40
 
</othercredit>
41
 
<!-- TRANS:ROLES_OF_TRANSLATORS -->
42
 
</authorgroup>
43
 
<legalnotice>&FDLNotice;</legalnotice>
44
 
<date>2012-08-06</date><!-- Date of (re)writing, or update.-->
45
 
<releaseinfo>&kappversion; (&kde; 4.9)</releaseinfo><!-- Application version number. Use the variable definitions within header to change this value.-->
46
 
 
47
 
<!--Short description of this document. Do not change unless necessary!-->
48
 
<abstract>
49
 
        <para>This documentation describes the game of &kappname; version &kappversion;</para>
50
 
</abstract>
51
 
 
52
 
<!--List of relevan keywords-->
53
 
<keywordset>
54
 
        <keyword>KDE</keyword> <!-- do not change this! -->
55
 
        <keyword>kdegames</keyword> <!-- do not change this! -->
56
 
        <keyword>game</keyword> <!-- do not change this! -->
57
 
        <keyword>Kreversi</keyword><!--Application name goes here-->
58
 
<!-- Game genre. Use as many as necessary. Available game types are: Arcade, Board, Card, Dice, Toys, Logic, Strategy.-->
59
 
        <keyword>board</keyword>
60
 
        <keyword>arcade</keyword>
61
 
        <keyword>GO</keyword>
62
 
        <keyword>reversi</keyword>
63
 
<!--Number of possible players. It can be: One, Two,..., Multiplayer-->
64
 
        <keyword>one player</keyword>
65
 
<!--All other relevant keywords-->
66
 
        <keyword>stones</keyword>
67
 
        <keyword>white</keyword>
68
 
        <keyword>black</keyword>
69
 
</keywordset>
70
 
</bookinfo>
71
 
<!--Content begins here: -->
72
 
<chapter id="introduction"><title>Introduction</title> <!-- do not change this! -->
73
 
        <note><title>Gametype:</title><para>Board, Arcade</para></note><!-- Game genre. Use as many as necessary. Available game types are: Arcade, Board, Card, Dice, Toys, Logic, Strategy.-->
74
 
        <note><title>Number of possible players:</title><para>One</para></note><!--Number of possible players. It can be: One, Two,..., Multiplayer-->
75
 
 
76
 
<!--Short game description starts here. 3-4 sentences (paragraphs)-->
77
 
<para>&kappname; is a simple one player strategy game played against the
78
 
computer. The playing field is an 8 by 8 square board divided into 64
79
 
squares. The game pieces used are two sided stones, where each side has its own, distinctive color.
80
 
 If a piece is captured by an opposing player, that piece is turned over
81
 
to reveal the color of that player. A winner is declared when one player has
82
 
more pieces of his own color on the board and there are no more possible
83
 
moves.</para>
84
 
</chapter>
85
 
 
86
 
<chapter id="howto"><title>How to Play</title> <!-- do not change this! -->
87
 
<!--IMPORTANT: If the game has no defined objective, please remove the below line.-->
88
 
        <note><title>Objective:</title><para>Get control over the majority of squares on the board.</para></note><!--Describe the objective of the game.-->
89
 
<!--How to play description. Don't be to specific on rules as they have a separate section in this document-->
90
 
        <para>
91
 
        &kappname; loads directly into the game play mode. As a first player you have the right to move first.</para>
92
 
<note><title>Note:</title><para>By default the human player always has a right to the first move.</para></note>
93
 
<para>Now, imagine yourself that with each move your stone has to hop (jump) over the enemy's one (or ones, as there might be more than one stone). Yet, your stone does not relocate after the move, instead a new stone is placed on the board onto where your stone would have appeared if it indeed could jump. Once the move is done, all the enemy stones that you jump over, become yours and change their color respectively.</para>
94
 
<para>Every single move you do in &kappname; has to be done in this manner. And you can jump your stones vertically, horizontally and diagonally. But, in case there is nowhere to jump, your turn will automatically skip.</para>
95
 
<note><title>Note:</title><para>The same rule applies to your enemy. If there is no possibility to make a move the turn is skipped.</para></note>
96
 
<para>The idea here is to fill the board with the stones of your own color. The player who manages to conquer the most of the game board is announced the winner.
97
 
        </para>
98
 
</chapter>
99
 
 
100
 
<chapter id="rules_and_tips"><title>Game Rules, Strategies and Tips</title> <!-- do not change this! -->
101
 
        <!--This section has to do with game rules. Please give a detailed description of those using lists or paragraphs.-->
102
 
<sect1 id="basics">                 
103
 
<title>Game Basics</title>
104
 
 
105
 
<para>A move consists  of outflanking your opponents stone(s),  then flipping the
106
 
outflanked stone(s)  to reveal  your color.  A move is  performed by  placing the
107
 
mouse pointer over the desired square then &LMB; click.</para>
108
 
 
109
 
<para>To outflank means to place a stone on the board so that your opponent's
110
 
row(s) of stone(s) is bordered at each end by a stone of your color. A row may be
111
 
made up of one or more stones.</para>
112
 
 
113
 
<para>The game starts with each player having two stones automatically placed
114
 
in the center four squares of the board in the following pattern:</para>
115
 
 
116
 
<screenshot>
117
 
<screeninfo>&kappname; opening position</screeninfo>
118
 
<mediaobject>
119
 
<imageobject><imagedata fileref="kreversi1.png" format="PNG"/></imageobject>
120
 
<textobject><phrase>&kappname; opening position</phrase></textobject>
121
 
<caption><para>Board Layout</para></caption>
122
 
</mediaobject>
123
 
</screenshot>
124
 
 
125
 
<variablelist>
126
 
<varlistentry>
127
 
<term><interface>Menu Bar</interface></term>
128
 
<listitem>
129
 
<para>The <interface>Menu Bar</interface> contains several choices of
130
 
drop-down menus. These are <link
131
 
linkend="game-menu"><guimenu>Game</guimenu></link>, <link
132
 
linkend="move-menu"><guimenu>Move</guimenu></link>, <link
133
 
linkend="view-menu"><guimenu>View</guimenu></link>, <link
134
 
linkend="settings-menu"><guimenu>Settings</guimenu></link>, and <link
135
 
linkend="help-menu"><guimenu>Help</guimenu></link>. Click with the &LMB; or
136
 
<keycombo action="simul">&Alt;<keycap>the underlined
137
 
letter</keycap></keycombo> to show the drop-down menu.</para>
138
 
</listitem>
139
 
</varlistentry>
140
 
</variablelist>
141
 
 
142
 
<variablelist>
143
 
<varlistentry>
144
 
<term><interface>Toolbar</interface></term>
145
 
<listitem><para>Provides the player with icon shortcuts for commonly
146
 
used actions. These are <guiicon>New</guiicon>,
147
 
<guiicon>Undo</guiicon>, <guiicon>Hint</guiicon>, <guiicon>Demo</guiicon>,
148
 
<guiicon>Show Last Move</guiicon>, and <guiicon>Show Legal Moves</guiicon>.
149
 
Place the mouse pointer over any of these icons and click with the &LMB; to
150
 
activate.</para></listitem>
151
 
</varlistentry>
152
 
</variablelist>
153
 
 
154
 
<variablelist>
155
 
<varlistentry>
156
 
<term><interface>Game Board</interface></term>
157
 
<listitem><para>The game board consists of a 8 by 8 square board
158
 
divided into 64 squares.</para></listitem>
159
 
</varlistentry>
160
 
</variablelist>
161
 
 
162
 
<variablelist>
163
 
<varlistentry>
164
 
<term><interface>Status Bar</interface></term>
165
 
<listitem><para>The status bar displays whose turn it is.</para></listitem>
166
 
</varlistentry>
167
 
</variablelist>
168
 
</sect1>
169
 
 
170
 
<sect1 id="Rules">
171
 
<title>Game Rules</title>
172
 
 
173
 
<para>You always move first.</para>
174
 
 
175
 
<para>If on your turn you cannot outflank and flip at least one
176
 
opposing stone, your turn is forfeited and your opponent moves
177
 
again. However, if a move is available to you, you may not forfeit
178
 
your turn.</para>
179
 
 
180
 
<para>A stone may outflank any number of stones in one or more rows in
181
 
any number of directions at the same time - horizontally, vertically
182
 
or diagonally. A row is defined as one or more stones in a continuous
183
 
straight line. </para>
184
 
 
185
 
<para>You may not skip over your own color stone to outflank an
186
 
opposing stone.</para>
187
 
 
188
 
<para>Stones may only be outflanked as a direct result of a move and
189
 
must fall in the direct line of the stone placed down.</para>
190
 
 
191
 
<para>All stones outflanked in any one move must be flipped, even if it
192
 
is to the player's advantage not to flip them.</para>
193
 
 
194
 
<para>Once a stone is placed on a square, it can never be moved to
195
 
another square later in the game.</para>
196
 
 
197
 
<para>When it is no longer possible for either player to move, the
198
 
game is over. Stones are then counted and the player with the majority
199
 
of his or her color discs on the board is declared the winner.</para>
200
 
 
201
 
<note><para>It is possible for a game to end before all 64 squares are
202
 
filled.</para></note>
203
 
 
204
 
</sect1>
205
 
 
206
 
<sect1 id="tips">
207
 
<title>Strategies and Tips</title>
208
 
 
209
 
<para>Try to place stones on the corners whenever possible. Your
210
 
opponent cannot outflank these stones.</para>
211
 
 
212
 
<para>Avoid placing stones on one of the three neighbor fields of a
213
 
corner unless you are absolutely sure that your opponent will not be
214
 
able to put a stone on a corner.</para>
215
 
 
216
 
<para>Sometimes it is better to offer some stones to your
217
 
opponent.</para>
218
 
 
219
 
<para>Try to put stones on fields which prevent your opponent from
220
 
moving.</para>
221
 
 
222
 
<para>Try to force your opponent to put a stone in a neighboring field
223
 
of a corner.</para>
224
 
 
225
 
</sect1>
226
 
</chapter>
227
 
  
228
 
<chapter id="interface"><title>Interface Overview</title> <!-- do not change this! -->
229
 
<!-- This section has to do with menubar. Describe every single entry in order. Use <variablelist> and <varlistentry>. Split the chapter into sections using <sect1(2,3)> for better viewing.-->
230
 
 <sect1 id="game-menu">
231
 
<title><guimenu>Game</guimenu> Menu</title>
232
 
 
233
 
<variablelist>
234
 
<varlistentry>
235
 
<term><menuchoice><shortcut><keycombo 
236
 
action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut>
237
 
<guimenu>Game</guimenu><guimenuitem>New</guimenuitem></menuchoice></term>
238
 
<listitem><para>Starts a new game.
239
 
</para></listitem>
240
 
</varlistentry>
241
 
 
242
 
<varlistentry>
243
 
<term><menuchoice><shortcut><keycombo 
244
 
action="simul">&Ctrl;<keycap>H</keycap></keycombo></shortcut>
245
 
<guimenu>Game</guimenu><guimenuitem>Show High Scores</guimenuitem></menuchoice></term>
246
 
<listitem><para>Opens a dialog that displays different high score tables. 
247
 
<guibutton>Export...</guibutton> the high scores into a file or click on 
248
 
<guibutton>Configure...</guibutton> to open a dialog to customize your 
249
 
<guilabel>Nickname</guilabel> and add a <guilabel>Comment</guilabel>.</para></listitem>
250
 
</varlistentry>
251
 
<!--
252
 
<varlistentry>
253
 
<term><menuchoice><shortcut><keycap>S</keycap></shortcut>
254
 
<guimenu>Game</guimenu><guimenuitem>Players and Seats</guimenuitem></menuchoice></term>
255
 
<listitem><para>Option is currently disabled.</para></listitem>
256
 
</varlistentry>
257
 
-->
258
 
<varlistentry>
259
 
<term><menuchoice><shortcut><keycombo 
260
 
action="simul">&Ctrl;<keycap>Q</keycap></keycombo></shortcut>
261
 
<guimenu>Game</guimenu><guimenuitem>Quit</guimenuitem></menuchoice></term>
262
 
<listitem><para>Exit &kappname;
263
 
</para></listitem>
264
 
</varlistentry>
265
 
 
266
 
</variablelist>
267
 
</sect1>
268
 
 
269
 
<sect1 id="move-menu">
270
 
<title><guimenu>Move</guimenu> Menu</title>
271
 
 
272
 
<variablelist>
273
 
<varlistentry>
274
 
<term><menuchoice><shortcut><keycombo 
275
 
action="simul">&Ctrl;<keycap>Z</keycap></keycombo></shortcut>
276
 
<guimenu>Move</guimenu><guimenuitem>Undo</guimenuitem></menuchoice></term>
277
 
<listitem><para>Removes your last move as well as the computer's last 
278
 
move from the board.
279
 
</para></listitem>
280
 
</varlistentry>
281
 
 
282
 
<varlistentry>
283
 
<term><menuchoice><shortcut><keycap>H</keycap></shortcut><guimenu>Move</guimenu><guimenuitem>Hint</guimenuitem>
284
 
</menuchoice></term>
285
 
<listitem><para>The computer will provide a hint for your next 
286
 
move.</para></listitem>
287
 
</varlistentry>
288
 
 
289
 
<varlistentry>
290
 
<term><menuchoice><shortcut><keycap>D</keycap></shortcut>
291
 
<guimenu>Move</guimenu><guimenuitem>Demo</guimenuitem></menuchoice></term>
292
 
<listitem><para>Start/Stop the demo mode.</para></listitem>
293
 
</varlistentry>
294
 
 
295
 
</variablelist>
296
 
</sect1>
297
 
 
298
 
<sect1 id="view-menu">
299
 
<title><guimenu>View</guimenu> Menu</title>
300
 
  <variablelist>
301
 
    <varlistentry>
302
 
      <term><menuchoice>
303
 
        <guimenu>View</guimenu><guimenuitem>Show Last Move</guimenuitem>
304
 
      </menuchoice></term>
305
 
      <listitem><para>Highlights your opponent's last move.</para></listitem>
306
 
    </varlistentry>
307
 
    <varlistentry>
308
 
      <term><menuchoice>
309
 
        <guimenu>View</guimenu><guimenuitem>Show Legal Moves</guimenuitem>
310
 
      </menuchoice></term>
311
 
      <listitem><para>Highlights all the moves available for your current move.</para></listitem>
312
 
    </varlistentry>
313
 
    <varlistentry>
314
 
      <term><menuchoice>
315
 
        <guimenu>View</guimenu><guimenuitem>Show Move History</guimenuitem>
316
 
      </menuchoice></term>
317
 
      <listitem><para>Enables/Disables the move history sidebar.</para></listitem>
318
 
    </varlistentry>
319
 
  </variablelist>
320
 
</sect1>
321
 
 
322
 
<sect1 id="settings-menu">
323
 
<title><guimenu>Settings</guimenu> Menu</title>
324
 
<variablelist>
325
 
  <varlistentry>
326
 
    <term><menuchoice>
327
 
      <guimenu>Settings</guimenu><guisubmenu>Animation Speed</guisubmenu><guimenuitem>Slow</guimenuitem>
328
 
    </menuchoice></term>
329
 
    <listitem><para>Set the game animation speed from <guimenuitem>Slow</guimenuitem> to <guimenuitem>Fast</guimenuitem>.</para></listitem>
330
 
  </varlistentry>
331
 
  <varlistentry>
332
 
    <term><menuchoice>
333
 
      <guimenu>Settings</guimenu><guimenuitem>Use Colored Chips</guimenuitem>
334
 
    </menuchoice></term>
335
 
    <listitem><para><action>Toggle</action> the color of the stones between black and white (default), and red and blue.</para></listitem>
336
 
  </varlistentry>
337
 
  <varlistentry>
338
 
    <term><menuchoice>
339
 
      <guimenu>Settings</guimenu><guimenuitem>Show Toolbar</guimenuitem>
340
 
    </menuchoice></term>
341
 
    <listitem><para><action>Toggle</action> the toolbar on and off.</para></listitem>
342
 
  </varlistentry>
343
 
  <varlistentry>
344
 
    <term><menuchoice>
345
 
      <guimenu>Settings</guimenu><guimenuitem>Show Statusbar</guimenuitem>
346
 
    </menuchoice></term>
347
 
    <listitem><para><action>Toggle</action> the status bar on and off.</para></listitem>
348
 
  </varlistentry>
349
 
  <varlistentry>
350
 
    <term><menuchoice>
351
 
      <guimenu>Settings</guimenu><guisubmenu>Difficulty</guisubmenu>
352
 
    </menuchoice></term>
353
 
    <listitem><para>Set the difficulty to be <guimenuitem>Very Easy</guimenuitem> up to <guimenuitem>Impossible</guimenuitem>.</para></listitem>
354
 
  </varlistentry>
355
 
  <varlistentry>
356
 
    <term><menuchoice>
357
 
      <guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts...</guimenuitem>
358
 
    </menuchoice></term>
359
 
    <listitem><para>Opens a dialog which lets you configure all the keyboard shortcuts which are available in &kappname;.</para></listitem>
360
 
  </varlistentry>
361
 
  <varlistentry>
362
 
    <term><menuchoice>
363
 
      <guimenu>Settings</guimenu><guimenuitem>Configure Toolbars...</guimenuitem>
364
 
    </menuchoice></term>
365
 
    <listitem><para><action>Open a dialog where you can configure the toolbars</action> for &kappname;.</para></listitem>
366
 
  </varlistentry>
367
 
</variablelist>
368
 
</sect1>
369
 
 
370
 
<sect1 id="help-menu"><!--This is a standard Help menubar entry. Only change if needed.-->
371
 
<title><guimenu>Help</guimenu> Menu</title>
372
 
&help.menu.documentation;
373
 
</sect1>
374
 
</chapter>
375
 
 
376
 
 <chapter id="faq"><title>Frequently asked questions</title> <!-- do not change this! -->
377
 
<!--This chapter is for frequently asked questions. Please use <qandaset> <qandaentry> only!-->
378
 
<qandaset>
379
 
<!--Following is a standard list of FAQ questions.-->
380
 
<qandaentry>
381
 
 <question><para>I want to change the way this game looks. Can I? </para></question>
382
 
 <answer><para>The only part of the game that can be changed is the color of the stones. To change the color of the stones use <menuchoice>
383
 
<guimenu>Settings</guimenu>
384
 
<guimenuitem>Use Colored Chips</guimenuitem>
385
 
</menuchoice> on the menubar.</para></answer>
386
 
</qandaentry>
387
 
<qandaentry>
388
 
 <question><para>Can I use the keyboard to play the game?</para></question>
389
 
 <answer><para>No. &kappname; does not provide for the keyboard play.</para></answer>
390
 
</qandaentry>
391
 
<qandaentry>
392
 
 <question><para>I have to quit the game now, but I am not finished yet. Can I save my progress?</para></question>
393
 
  <answer><para>No. &kappname; does not have a save feature.</para></answer>
394
 
</qandaentry>
395
 
<!--Please add more Q&As if needed-->
396
 
 
397
 
</qandaset>
398
 
</chapter>
399
 
 
400
 
<chapter id="configuration"><title>Game Configuration</title> <!-- do not change this! -->
401
 
<sect1 id="multiplayer">
402
 
<title>Multiplayer Support</title>
403
 
 
404
 
<para>
405
 
&kappname; can be played online on any GGZ Gaming Zone site. You can
406
 
find other players there, and compete against them. Just enter one
407
 
of the available Reversi rooms with any GGZ core client, such as
408
 
kggz, and &kappname; will be offered to you as your favourite
409
 
game client. If a GGZ core client is installed, you can try
410
 
out GGZ by visiting the <ulink url="ggz://live.ggzgamingzone.org/#Reversi">community site</ulink>.
411
 
</para>
412
 
 
413
 
<para>
414
 
Remember that when playing online, the opponent might be either a
415
 
human player or a computer player. The latter one might behave
416
 
differently from the computer player included in &kappname;.
417
 
</para>
418
 
 
419
 
</sect1>
420
 
</chapter>
421
 
 
422
 
<chapter id="credits"><title>Credits and License</title> <!-- do not change this! -->
423
 
<!--This chapter is for credits and licenses.-->
424
 
 
425
 
<para>
426
 
&kappname;  <!-- do not change this! -->
427
 
</para>
428
 
 
429
 
<para>Program Copyright 1998-2000 &Mario.Weilguni;</para>
430
 
<para>Mats Luthman - Designer of the move engine.</para>
431
 
 
432
 
<para>Original documentation by &Mario.Weilguni;</para>
433
 
<para>Edited by Robert Williams</para>
434
 
 
435
 
<para>Documentation re-written and updated for &kde; &kappversion; by &Clay.Pradarits;
436
 
&Clay.Pradarits.mail;</para>
437
 
 
438
 
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
439
 
 
440
 
 
441
 
&underFDL;
442
 
&underGPL;
443
 
 
444
 
</chapter>
445
 
 
446
 
<appendix id="installation">
447
 
<title>Installation</title>
448
 
 
449
 
&install.intro.documentation;
450
 
 
451
 
 
452
 
<sect1 id="Compilation">
453
 
<title>Compilation and Installation</title>
454
 
 
455
 
&install.compile.documentation;
456
 
 
457
 
</sect1>
458
 
</appendix>
459
 
 
460
 
&documentation.index; 
461
 
</book>
462
 
<!--
463
 
Local Variables:
464
 
mode: sgml
465
 
sgml-minimize-attributes:nil
466
 
sgml-general-insert-case:lower
467
 
sgml-omittag:t
468
 
sgml-shorttag:t
469
 
sgml-namecase-general:t
470
 
sgml-always-quote-attributes:t
471
 
sgml-indent-step:0
472
 
sgml-indent-data:nil
473
 
sgml-parent-document:nil
474
 
sgml-exposed-tags:nil
475
 
sgml-local-catalogs:nil
476
 
sgml-local-ecat-files:nil
477
 
End:
478
 
-->