~keith-penguin/kdegames/trunk

« back to all changes in this revision

Viewing changes to doc/kmahjongg/index.docbook

  • Committer: Keith Worrell
  • Date: 2009-03-18 05:35:28 UTC
  • Revision ID: keith.worrell@gmail.com-20090318053528-mx6x9c0ngmg0kg6p
imported project

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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 "&kmahjongg;"> 
 
5
  <!ENTITY kappversion "0.8.0"><!--Applicaion version. Use this variable everywhere it's needed.-->
 
6
  <!ENTITY docversion "1.0"><!--Document version. Use this variable everywhere it's needed.-->
 
7
  <!ENTITY docupdate "2007-10-11"><!--Document version. Use this variable everywhere it's needed.-->
 
8
  <!ENTITY package "kdegames">  <!-- do not change this! -->
 
9
  <!ENTITY % English "INCLUDE" > <!-- change language only here -->
 
10
  <!ENTITY % addindex "IGNORE"> <!-- do not change this! -->
 
11
]>
 
12
 
 
13
<book lang="&language;"> <!-- do not change this! -->
 
14
<bookinfo>
 
15
        <title>The &kappname; Handbook</title> <!-- This is the title of this docbook. -->
 
16
<!-- List of immidiate authors begins here. -->
 
17
<!--INPORTANT! - All other contributors: [to be determined] -->
 
18
<authorgroup>
 
19
<author>
 
20
        <personname>
 
21
                <firstname>John</firstname>
 
22
                <surname>Hayes</surname>
 
23
        </personname>
 
24
                <email>justlinux@bellsouth.net</email>
 
25
</author>
 
26
<author>
 
27
<firstname>Eugene</firstname><surname>Trounev</surname>
 
28
<affiliation><address><email>eugene.trounev@gmail.com</email></address></affiliation>
 
29
</author>
 
30
<!-- TRANS:ROLES_OF_TRANSLATORS -->
 
31
</authorgroup>
 
32
 
 
33
 
 
34
<date>&docupdate;</date><!-- Date of (re)writing, ro update. Use the variable definitions within header to change this value.-->
 
35
<releaseinfo>&docversion;</releaseinfo><!-- Application version number. Use the variable definitions within header to change this value.-->
 
36
 
 
37
<!--Short description of this document. Do not change unless necessary!-->
 
38
<abstract>
 
39
        <para>This documentation describes the game of &kappname; version &kappversion;</para>
 
40
</abstract>
 
41
 
 
42
<!--List of relevan keywords-->
 
43
<keywordset>
 
44
        <keyword>KDE</keyword> <!-- do not change this! -->
 
45
        <keyword>kdegames</keyword> <!-- do not change this! -->
 
46
        <keyword>game</keyword> <!-- do not change this! -->
 
47
        <keyword>KMahjongg</keyword><!--Application name goes here-->
 
48
<!-- Game genre. use as many as necessary.Available game types are: Arcade, Board, Card, Dice, Toys, Logic, Strategy.-->
 
49
        <keyword>board</keyword>
 
50
        <keyword>arcade</keyword>
 
51
        <keyword>tile game</keyword>
 
52
        <keyword>tiles</keyword>
 
53
<!--Number of possible players. It can be: One, Two,..., Multiplayer-->
 
54
        <keyword>one player</keyword>
 
55
<!--All other relevant keywords-->
 
56
</keywordset>
 
57
</bookinfo>
 
58
<!--Content begins here: -->
 
59
<chapter id="introduction"><title>Introduction</title> <!-- do not change this! -->
 
60
        <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.-->
 
61
        <note><title>Number of possible players:</title><para>One</para></note><!--Number of possible players. It can be: One, Two,..., Multiplayer-->
 
62
        <para>
 
63
                &kmahjongg; is a fun board game created after the famous oriental game of Mahjong (from Chinese <foreignphrase lang="zh">麻將</foreignphrase>). Unlike the original however, &kmahjongg; is a tile matching game for one or two players, a variation usually known as Mahjong Solitaire.
 
64
        </para>
 
65
        <para>
 
66
                In &kmahjongg; the tiles are scrambled and stacked on top of each other to resemble a certain shape. The player is then expected to remove all the tiles off the game board by locating each tile's matching pair.
 
67
        </para>
 
68
</chapter>
 
69
 
 
70
<chapter id="howto"><title>How to play</title> <!-- do not change this! -->
 
71
<!--IMPORTANT: If the game has no defined objective, please remove the below line.-->
 
72
        <note><title>Objective:</title><para>Remove all tiles from the game board by locating each tile's matching pair as fast as possible.</para></note><!--Describe the objective of the game.-->
 
73
<!--How to play description. Don't be to specific on rules as they have a separate section in this document-->
 
74
        <para>
 
75
                &kappname; will load a default layout automatically once
 
76
                you start the game and you can start playing right away.                
 
77
        </para>
 
78
        <note><title>Note:</title><para>The game timer will start immediately if the game is started.</para></note>
 
79
        <para>
 
80
                You should carefully study the stack of tiles laid out on the game board and find two tiles matching exactly. When you have found such a pair use your mouse to select these.
 
81
        </para>
 
82
        <note><title>Note:</title>
 
83
                <para>Bear in mind that you can only select the tiles which are <quote>Open</quote>. 
 
84
                        Tiles are considered <quote>Blocked</quote> when they
 
85
                        are positioned behind other tiles, and when both the
 
86
                        right and left sides of the tile are filled by others.
 
87
                        If at least one of the lateral sides is empty then the
 
88
                        tile is considered 'Open', and can be
 
89
                        removed.
 
90
        </para></note>
 
91
        <para>
 
92
                Once you have selected the right pair of tiles they will vanish off the game board, thus revealing the tiles previously located underneath, and opening the tiles adjacent to them.
 
93
        </para>
 
94
        <para>
 
95
                Find as many matches as possible to remove all the tiles from the game board.
 
96
        </para>
 
97
</chapter>
 
98
 
 
99
<chapter id="rules_and_tips"><title>Game Rules, Strategies and Tips</title> <!-- do not change this! -->
 
100
        <!--This section has to do with game rules. Please give a detailed description of those using lists or paragraphs.-->
 
101
        <sect1 id="game-screen">
 
102
                <title>The Game Screen</title>
 
103
                <para>
 
104
                        <screenshot>
 
105
                                <screeninfo>A screenshot of &kmahjongg;</screeninfo>
 
106
                                <mediaobject>
 
107
                                        <imageobject>
 
108
                                                <imagedata fileref="gamescreen.png" format="PNG"/>
 
109
                                        </imageobject>
 
110
                                        <textobject><phrase>Screenshot</phrase></textobject>
 
111
                                </mediaobject>
 
112
                        </screenshot>
 
113
                        A quick explanation of the parts of the game screen.
 
114
                </para>
 
115
        <variablelist>
 
116
                <varlistentry>
 
117
                        <term>Game Screen</term>
 
118
                        <listitem><para>
 
119
                                The Game screen is in the center of the screen and is the largest section of the window. The background is populated with the game tiles.
 
120
                        </para></listitem>
 
121
                </varlistentry>
 
122
                <varlistentry>
 
123
                        <term>Statusbar</term>
 
124
                        <listitem><para>
 
125
                                The Status bar is located at the bottom of the screen, and contains four panes. The first pane lists the removed/total tiles and the number of matching tiles that have free sides. The second pane gives the sequence number of the game you are playing. The third pane lets the player know when the game is ready, and the last pane displays the game timer, which keeps track of the elapsed time from the start of the game until the game is finished.
 
126
                        </para></listitem>
 
127
                </varlistentry>
 
128
        </variablelist>
 
129
        </sect1>
 
130
        <sect1 id="rules">
 
131
                <title>Rules</title>
 
132
                <para>
 
133
                        Standard Mahjong set of tiles includes:
 
134
                        <informaltable>
 
135
                                <tgroup cols="3">
 
136
                                <tbody>
 
137
                                        <row><entry>Group name</entry><entry>Tile name</entry><entry>Quantity in a set</entry></row>
 
138
                                        <row><entry>Dots</entry><entry></entry><entry></entry></row>
 
139
                                        <row><entry></entry><entry>1 of Dots</entry><entry>4</entry></row>
 
140
                                        <row><entry></entry><entry>2 of Dots</entry><entry>4</entry></row>
 
141
                                        <row><entry></entry><entry>3 of Dots</entry><entry>4</entry></row>
 
142
                                        <row><entry></entry><entry>4 of Dots</entry><entry>4</entry></row>
 
143
                                        <row><entry></entry><entry>5 of Dots</entry><entry>4</entry></row>
 
144
                                        <row><entry></entry><entry>6 of Dots</entry><entry>4</entry></row>
 
145
                                        <row><entry></entry><entry>7 of Dots</entry><entry>4</entry></row>
 
146
                                        <row><entry></entry><entry>8 of Dots</entry><entry>4</entry></row>
 
147
                                        <row><entry></entry><entry>9 of Dots</entry><entry>4</entry></row>
 
148
                                        <row><entry>Bamboos</entry><entry></entry><entry></entry></row>
 
149
                                        <row><entry></entry><entry>1 of Bamboos</entry><entry>4</entry></row>
 
150
                                        <row><entry></entry><entry>2 of Bamboos</entry><entry>4</entry></row>
 
151
                                        <row><entry></entry><entry>3 of Bamboos</entry><entry>4</entry></row>
 
152
                                        <row><entry></entry><entry>4 of Bamboos</entry><entry>4</entry></row>
 
153
                                        <row><entry></entry><entry>5 of Bamboos</entry><entry>4</entry></row>
 
154
                                        <row><entry></entry><entry>6 of Bamboos</entry><entry>4</entry></row>
 
155
                                        <row><entry></entry><entry>7 of Bamboos</entry><entry>4</entry></row>
 
156
                                        <row><entry></entry><entry>8 of Bamboos</entry><entry>4</entry></row>
 
157
                                        <row><entry></entry><entry>9 of Bamboos</entry><entry>4</entry></row>
 
158
                                        <row><entry>Characters</entry><entry></entry><entry></entry></row>
 
159
                                        <row><entry></entry><entry>1 of Characters</entry><entry>4</entry></row>
 
160
                                        <row><entry></entry><entry>2 of Characters</entry><entry>4</entry></row>
 
161
                                        <row><entry></entry><entry>3 of Characters</entry><entry>4</entry></row>
 
162
                                        <row><entry></entry><entry>4 of Characters</entry><entry>4</entry></row>
 
163
                                        <row><entry></entry><entry>5 of Characters</entry><entry>4</entry></row>
 
164
                                        <row><entry></entry><entry>6 of Characters</entry><entry>4</entry></row>
 
165
                                        <row><entry></entry><entry>7 of Characters</entry><entry>4</entry></row>
 
166
                                        <row><entry></entry><entry>8 of Characters</entry><entry>4</entry></row>
 
167
                                        <row><entry></entry><entry>9 of Characters</entry><entry>4</entry></row>
 
168
                                        <row><entry>Winds</entry><entry></entry><entry></entry></row>
 
169
                                        <row><entry></entry><entry>East Wind</entry><entry>4</entry></row>
 
170
                                        <row><entry></entry><entry>South Wind</entry><entry>4</entry></row>
 
171
                                        <row><entry></entry><entry>West Wind</entry><entry>4</entry></row>
 
172
                                        <row><entry></entry><entry>North Wind</entry><entry>4</entry></row>
 
173
                                        <row><entry>Dragons</entry><entry></entry><entry></entry></row>
 
174
                                        <row><entry></entry><entry>Red Dragon</entry><entry>4</entry></row>
 
175
                                        <row><entry></entry><entry>Green Dragon</entry><entry>4</entry></row>
 
176
                                        <row><entry></entry><entry>White Dragon</entry><entry>4</entry></row>
 
177
                                        <row><entry>Flowers</entry><entry></entry><entry></entry></row>
 
178
                                        <row><entry></entry><entry>Plum (1)</entry><entry>1</entry></row>
 
179
                                        <row><entry></entry><entry>Lily (2)</entry><entry>1</entry></row>
 
180
                                        <row><entry></entry><entry>Chrysanthemum (3)</entry><entry>1</entry></row>
 
181
                                        <row><entry></entry><entry>Bamboo (4)</entry><entry>1</entry></row>
 
182
                                        <row><entry>Seasons</entry><entry></entry><entry></entry></row>
 
183
                                        <row><entry></entry><entry>Spring (1)</entry><entry>1</entry></row>
 
184
                                        <row><entry></entry><entry>Summer (2)</entry><entry>1</entry></row>
 
185
                                        <row><entry></entry><entry>Autumn (3)</entry><entry>1</entry></row>
 
186
                                        <row><entry></entry><entry>Winter (4)</entry><entry>1</entry></row>
 
187
                                </tbody>
 
188
                                </tgroup>
 
189
                        </informaltable>
 
190
                </para>
 
191
                <itemizedlist>
 
192
                        <listitem><para>Only the <quote>open</quote> tiles can be selected.</para></listitem>
 
193
                        <listitem><para><quote>Open</quote> tile is the tile which has one of the tile's lateral sides open, meaning that no other tiles are located immediately next to it.</para></listitem>
 
194
                        <listitem><para>Only when matching, open tiles can be removed from the game board.</para></listitem>
 
195
                        <listitem><para>Matching tiles are those where the face pictograms match.</para></listitem>
 
196
                </itemizedlist>                 
 
197
                <note><title>Note:</title><para>There are exceptions to this rule! In the traditional game of Mahjong each tile has a matching one except for the <quote>Flowers</quote> and <quote>Seasons</quote> tiles. </para></note>
 
198
                <itemizedlist>
 
199
                        <listitem><para>The <quote>Flowers</quote> tiles have no doubles in the set and can be matched directly to each-other.</para></listitem>
 
200
                        <listitem><para>The <quote>Seasons</quote> tiles have no doubles in the set and can be matched directly to each-other.  </para></listitem>
 
201
                        <listitem><para>Not every &kmahjongg; game can be finished. Sometimes the tiles are mixed in such a way that it may not be possible to find all the matches. This problem can be avoided. Please refer to <link linkend="general-options">this section</link> of the configuration dialog.</para></listitem>
 
202
                        <listitem><para>To be eligible for a place amongst the high scores the player has to complete a game instance within the shortest period of time possible.</para></listitem>
 
203
                </itemizedlist>
 
204
                <note><title>Note:</title><para>If the player uses the <quote>Hint</quote> feature the record will not be considered as a high score.</para></note>
 
205
 
 
206
        </sect1>
 
207
</chapter>
 
208
 
 
209
 
 
210
<chapter id="interface"><title>Interface Overview</title> <!-- do not change this! -->
 
211
<!-- 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.-->
 
212
 
 
213
 <sect1 id="game-menu">
 
214
        <title>The <guimenu>Game</guimenu> Menu</title>
 
215
                <variablelist>
 
216
                        <varlistentry id="game-menu-new">
 
217
                                <term><menuchoice>
 
218
                                        <shortcut><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut>
 
219
                                        <guimenu>Game</guimenu>
 
220
                                        <guimenuitem>New</guimenuitem>
 
221
                                </menuchoice></term>
 
222
                                <listitem><para><action>Starts a new game.</action></para></listitem>
 
223
                        </varlistentry>
 
224
                        <varlistentry  id="game-menu-load">
 
225
                                <term><menuchoice>
 
226
                                        <shortcut><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></shortcut>
 
227
                                        <guimenu>Game</guimenu>
 
228
                                        <guimenuitem>Load...</guimenuitem>
 
229
                                </menuchoice></term>
 
230
                                <listitem><para><action>Loads a saved game.</action></para></listitem>
 
231
                        </varlistentry>
 
232
                        <varlistentry id="game-menu-restart">
 
233
                                <term><menuchoice>
 
234
                                        <shortcut><keycap>F5</keycap></shortcut>
 
235
                                        <guimenu>Game</guimenu>
 
236
                                        <guimenuitem>Restart Game</guimenuitem>
 
237
                                </menuchoice></term>
 
238
                                <listitem><para><action>Restarts the current game.</action></para></listitem>
 
239
                        </varlistentry>
 
240
                        <varlistentry>
 
241
                                <term><menuchoice>
 
242
                                        <guimenu>Game</guimenu>
 
243
                                        <guimenuitem>New Numbered Game...</guimenuitem>
 
244
                                </menuchoice></term>
 
245
                                <listitem><para><action>Starts a specifically numbered game.</action>
 
246
                                <screenshot>
 
247
                                        <screeninfo>Start a Numbered Game Dialog</screeninfo>
 
248
                                        <mediaobject>
 
249
                                                <imageobject><imagedata fileref="numbered.png" format="PNG"/></imageobject>
 
250
                                                <textobject><phrase>Start a Numbered Game Dialog</phrase></textobject>
 
251
                                        </mediaobject>
 
252
                                </screenshot>
 
253
                                </para></listitem>
 
254
                        </varlistentry>
 
255
                        <varlistentry id="game-menu-save">
 
256
                                <term><menuchoice>
 
257
                                        <shortcut><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut>
 
258
                                        <guimenu>Game</guimenu>
 
259
                                        <guimenuitem>Save</guimenuitem>
 
260
                                </menuchoice></term>
 
261
                                <listitem><para><action>Saves</action> the current game.</para></listitem>
 
262
                        </varlistentry>
 
263
                        <varlistentry id="game-menu-pause">
 
264
                                <term><menuchoice>
 
265
                                        <shortcut><keycap>P</keycap></shortcut>
 
266
                                        <guimenu>Game</guimenu>
 
267
                                        <guimenuitem>Pause</guimenuitem>
 
268
                                </menuchoice></term>
 
269
                                <listitem><para><action>Pauses or resumes the game. While the game is paused, all tiles are hidden.</action></para></listitem>
 
270
                        </varlistentry>
 
271
                        <varlistentry id="game-menu-highscores">
 
272
                                <term><menuchoice>
 
273
                                        <shortcut><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></shortcut>
 
274
                                        <guimenu>Game</guimenu>
 
275
                                        <guimenuitem>Show High Scores</guimenuitem>
 
276
                                </menuchoice></term>
 
277
                                <listitem><para><action>Shows the high score list.</action>
 
278
                                <screenshot>
 
279
                                        <screeninfo>Show High scores</screeninfo>
 
280
                                        <mediaobject>
 
281
                                                <imageobject><imagedata fileref="highscore.png" format="PNG"/></imageobject>
 
282
                                                <textobject><phrase>Show High scores</phrase></textobject>
 
283
                                        </mediaobject>
 
284
                                </screenshot>
 
285
                                </para>
 
286
                                <para>
 
287
                                        When your game scores exceed the top ten scores listed, you are prompted to enter your name.
 
288
                                </para> </listitem>
 
289
                        </varlistentry>
 
290
                        <varlistentry>
 
291
                                <term><menuchoice>
 
292
                                        <shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></shortcut>
 
293
                                        <guimenu>Game</guimenu>
 
294
                                        <guimenuitem>Quit</guimenuitem>
 
295
                                </menuchoice></term>
 
296
                                <listitem><para><action>Quits</action> &kappname;.</para></listitem>
 
297
                        </varlistentry>
 
298
                </variablelist>
 
299
</sect1>
 
300
<sect1 id="move-menu">
 
301
        <title>The <guimenu>Move</guimenu> Menu</title>
 
302
                <variablelist>
 
303
                        <varlistentry id="move-menu-undo">
 
304
                                <term><menuchoice>
 
305
                                        <shortcut><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></shortcut>
 
306
                                        <guimenu>Move</guimenu>
 
307
                                        <guimenuitem>Undo</guimenuitem>
 
308
                                </menuchoice></term>
 
309
                                <listitem><para><action>Undo</action> your last move.</para></listitem>
 
310
                        </varlistentry>
 
311
                        <varlistentry id="move-menu-redo">
 
312
                                <term><menuchoice>
 
313
                                        <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></shortcut>
 
314
                                        <guimenu>Move</guimenu>
 
315
                                        <guimenuitem>Redo</guimenuitem>
 
316
                                </menuchoice></term>
 
317
                                <listitem><para><action>Redo</action> a move that was undone.</para></listitem>
 
318
                        </varlistentry>
 
319
                        <varlistentry id="move-menu-hint">
 
320
                                <term><menuchoice>
 
321
                                        <shortcut><keycap>H</keycap></shortcut>
 
322
                                        <guimenu>Move</guimenu>
 
323
                                        <guimenuitem>Hint</guimenuitem>
 
324
                                </menuchoice></term>
 
325
                                <listitem><para><action>Gives a Hint</action> by flashing a matching pair of tiles.</para></listitem>
 
326
                        </varlistentry>
 
327
                        <varlistentry id="move-menu-demo">
 
328
                                <term><menuchoice>
 
329
                                        <shortcut><keycap>D</keycap></shortcut>
 
330
                                        <guimenu>Move</guimenu>
 
331
                                        <guimenuitem>Demo</guimenuitem>
 
332
                                </menuchoice></term>
 
333
                                <listitem><para><action>Starts the game Demo</action> mode.</para></listitem>
 
334
                        </varlistentry>
 
335
                        <varlistentry id="move-menu-shuffle">
 
336
                                <term><menuchoice>
 
337
                                        <guimenu>Move</guimenu>
 
338
                                        <guimenuitem>Shuffle</guimenuitem>
 
339
                                </menuchoice></term>
 
340
                                <listitem><para><action>Shuffles the tiles</action> on the board.</para></listitem>
 
341
                        </varlistentry>
 
342
                </variablelist>
 
343
</sect1>
 
344
<sect1 id="view-menu">
 
345
        <title>The <guimenu>View</guimenu> Menu</title>
 
346
                <variablelist>
 
347
                        <varlistentry id="view-menu-rotate-c">
 
348
                                <term><menuchoice>
 
349
                                        <shortcut><keycap>G</keycap></shortcut>
 
350
                                        <guimenu>View</guimenu>
 
351
                                        <guimenuitem>Rotate View Clockwise</guimenuitem>
 
352
                                </menuchoice></term>
 
353
                                <listitem><para><action>Rotates</action> the tile viewing angle clockwise.</para></listitem>
 
354
                        </varlistentry>
 
355
                        <varlistentry id="view-menu-rotate-cc">
 
356
                                <term><menuchoice>
 
357
                                        <shortcut><keycap>F</keycap></shortcut>
 
358
                                        <guimenu>View</guimenu>
 
359
                                        <guimenuitem>Rotate View Counter Clockwise</guimenuitem>
 
360
                                </menuchoice></term>
 
361
                                <listitem><para><action>Rotates</action> the tile viewing angle counter clockwise.</para></listitem>
 
362
                        </varlistentry>
 
363
                </variablelist>
 
364
</sect1>
 
365
<sect1 id="settings-menu">
 
366
        <title>The <guimenu>Settings</guimenu> Menu</title>
 
367
                <variablelist>
 
368
                        <varlistentry>
 
369
                                <term><menuchoice>
 
370
                                        <guimenu>Settings</guimenu>
 
371
                                        <guimenuitem>Show Toolbar</guimenuitem>
 
372
                                </menuchoice></term>
 
373
                                <listitem><para>Shows or hides the Toolbar.</para></listitem>
 
374
                        </varlistentry>
 
375
                        <varlistentry id="settings-menu-statusbar">
 
376
                                <term><menuchoice>
 
377
                                        <guimenu>Settings</guimenu>
 
378
                                        <guimenuitem>Show Statusbar</guimenuitem>
 
379
                                </menuchoice></term>
 
380
                                <listitem><para>Shows or hides the Statusbar.</para></listitem>
 
381
                        </varlistentry>
 
382
                        <!--varlistentry id="settings-menu-hide-matching">
 
383
                                <term><menuchoice>
 
384
                                        <guimenu>Settings</guimenu>
 
385
                                        <guimenuitem>Show/Hide Matching Tiles</guimenuitem>
 
386
                                </menuchoice></term>
 
387
                                <listitem><para>Shows or hides matching tiles by not flashing the matching free tiles when a corresponding tile is selected.</para></listitem>
 
388
                        </varlistentry-->
 
389
                        <varlistentry id="settings-menu-shortcuts">
 
390
                                <term><menuchoice>
 
391
                                        <guimenu>Settings</guimenu>
 
392
                                        <guimenuitem>Configure Shortcuts...</guimenuitem>
 
393
                                </menuchoice></term>
 
394
                                <listitem><para><action>Displays a standard &kde; shortcut configuration dialog</action> to change the <link linkend="default-keybindings">keyboard shortcuts</link> for &kappname;.</para></listitem>
 
395
                        </varlistentry>
 
396
                        <varlistentry id="settings-menu-toolbar">
 
397
                                <term><menuchoice>
 
398
                                        <guimenu>Settings</guimenu>
 
399
                                        <guimenuitem>Configure Toolbars...</guimenuitem>
 
400
                                </menuchoice></term>
 
401
                                <listitem><para>Displays a standard &kde; dialog where you can configure the toolbar icons.</para></listitem>
 
402
                        </varlistentry>
 
403
                        <varlistentry id="settings-menu-settings">
 
404
                                <term><menuchoice>
 
405
                                        <guimenu>Settings</guimenu>
 
406
                                        <guimenuitem>Configure &kappname;...</guimenuitem>
 
407
                                </menuchoice></term>
 
408
                                <listitem><para><action>Opens a dialog to configure &kappname;.</action> For details, see <link linkend="configuration">here</link>.</para></listitem>
 
409
                        </varlistentry>
 
410
                </variablelist>
 
411
</sect1>
 
412
 <sect1 id="help"><!--This is a standard Help menubar entry. Only change if needed.-->
 
413
<title>The <guimenu>Help</guimenu> Menu</title>
 
414
&help.menu.documentation;
 
415
</sect1>
 
416
</chapter>
 
417
 
 
418
 
 
419
<chapter id="faq"><title>Frequently asked questions</title> <!-- do not change this! -->
 
420
<!--This chapter is for frequently asked questions. Please use <qandaset> <qandaentry> only!-->
 
421
<qandaset>
 
422
<!--Following is a standard list of FAQ questions.-->
 
423
        <qandaentry>
 
424
                <question><para>Who made this game?</para></question>
 
425
                 <answer><para>The kdegames team. You can find their website <ulink url="http://games.kde.org">here</ulink>.</para></answer>
 
426
        </qandaentry>
 
427
        <qandaentry>
 
428
                 <question><para>Where can I get cheatcodes?</para></question>
 
429
                 <answer><para>You cannot get cheatcodes for &kde; games.</para></answer>
 
430
        </qandaentry>
 
431
        <qandaentry>
 
432
                 <question><para>How do I start a new game?</para></question>
 
433
                   <answer><para>You can start a new game using the <guibutton>New</guibutton> button on the toolbar, the <menuchoice><guimenu>Game</guimenu><guimenuitem>New</guimenuitem></menuchoice> menu entry on the menubar or using the default shortcut <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>.</para></answer>
 
434
        </qandaentry>
 
435
        <qandaentry>
 
436
                 <question><para>I did something very wrong! Can I restart the game? </para></question>
 
437
                 <answer><para>Yes. To restart the current game you can either use a <link linkend="game-menu-restart">shortcut key</link>, or a <link linkend="game-menu-restart">menubar</link> option.</para></answer>
 
438
        </qandaentry>
 
439
        <qandaentry>
 
440
                 <question><para>How do I pause the game?</para></question>
 
441
                 <answer><para>To pause the current game you may either use the <link linkend="game-menu-pause">toolbar</link>, a <link linkend="game-menu-pause">shortcut key</link>, or a <link linkend="game-menu-pause">menubar</link> option.</para></answer>
 
442
        </qandaentry>
 
443
        <qandaentry>
 
444
                 <question><para>I want to change the way this game looks. Can I? </para></question>
 
445
                 <answer><para>Yes. To change the way &kappname; looks use the <link linkend="settings-menu-settings">menubar</link> to open the <link linkend="configuration">configuration utility</link>.</para></answer>
 
446
        </qandaentry>
 
447
        <qandaentry>
 
448
                 <question><para>I have made a mistake. Can I undo?</para></question>
 
449
                 <answer><para>Yes. To undo your move you can either use a <link linkend="move-menu-undo">shortcut key</link>, or a <link linkend="move-menu-undo">menubar</link> option.</para></answer>
 
450
        </qandaentry>
 
451
        <qandaentry>
 
452
                 <question><para>I have mistakenly undone a good move, can I redo it?</para></question>
 
453
                 <answer><para>Yes. To Redo your move you can either use a <link linkend="move-menu-redo">shortcut key</link>, or a <link linkend="move-menu-redo">menubar</link> option.</para></answer>
 
454
        </qandaentry>
 
455
        <qandaentry>
 
456
                 <question><para>Can I use keyboard?</para></question>
 
457
                 <answer><para>No. This game does not feature a keyboard play mode yet.</para></answer>
 
458
        </qandaentry>
 
459
        <qandaentry>
 
460
                 <question><para>I cannot figure out what to do here! Are there hints? </para></question>
 
461
                 <answer><para>Yes. To use &kappname; hint feature can either use a <link linkend="move-menu-hint">shortcut key</link>, or a <link linkend="move-menu-hint">menubar</link> option.</para></answer>
 
462
        </qandaentry>
 
463
        <qandaentry>
 
464
                 <question><para>I have to quit the game now, but I am not finished yet. Can I save my progress?</para></question>
 
465
                  <answer><para>Yes. To save your game progress either use a <link linkend="game-menu-save">shortcut key</link>, or a <link linkend="game-menu-save">menubar</link> option.</para></answer>
 
466
        </qandaentry>
 
467
        <qandaentry>
 
468
                 <question><para>Where are the high scores?</para></question>
 
469
                 <answer><para>To open the high scores dialog you can either use a <link linkend="game-menu-highscores">shortcut key</link>, or a <link linkend="game-menu-highscores">menubar</link> option.</para></answer>
 
470
        </qandaentry>
 
471
        <qandaentry>
 
472
                 <question><para>I want to change the game configuration. Where do I go?</para></question>
 
473
                 <answer><para>To open the <link linkend="configuration">configuration utility</link> use the <link linkend="settings-menu-settings">Settings</link> menu.</para></answer><!--IMPORTANT!: this link has to send user to 'Interface Overview' section. So please setup the link structure accordingly.-->
 
474
        </qandaentry>
 
475
        <qandaentry>
 
476
                 <question><para>I want to change the toolbar layout. What do I do?</para></question>
 
477
                 <answer><para>To change the default toolbar layout use the <link linkend="settings-menu-toolbar"> <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Toolbars...</guimenuitem></menuchoice></link> menu.</para></answer><!--IMPORTANT!: this link has to send user to 'Interface Overview' section. So please setup the link structure accordingly.-->
 
478
        </qandaentry>
 
479
<!--Please add more Q&As if needed-->
 
480
 
 
481
</qandaset>
 
482
</chapter>
 
483
 
 
484
<chapter id="configuration"><title>Game Configuration</title> <!-- do not change this! -->
 
485
<!--This section describes configuration &GUI;. If your game is configured using menubar exclusively, please remove this section.-->
 
486
<screenshot>
 
487
<screeninfo>Configure Dialog</screeninfo>
 
488
        <mediaobject>
 
489
          <imageobject>
 
490
            <imagedata fileref="config.png" format="PNG"/>
 
491
          </imageobject>
 
492
          <textobject>
 
493
            <phrase>Configure Dialog</phrase>
 
494
          </textobject>
 
495
        </mediaobject>
 
496
</screenshot>
 
497
 
 
498
<para><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kappname;...</guimenuitem></menuchoice> opens the <guilabel>Configure - &kappname;</guilabel> dialog.</para>
 
499
 
 
500
<sect1 id="general-options"><title><guilabel>General</guilabel> options</title>
 
501
        <variablelist>
 
502
                <varlistentry>
 
503
                        <term><guilabel>Blink matching tiles when first one is selected</guilabel></term>
 
504
                        <listitem><para>
 
505
                                This setting will make the game highlight the selected tile on mouse click, and flash any matching tiles that have a free side at each move. No additional tiles will be highlighted if there are no matching tiles with a free side.
 
506
                        </para></listitem>
 
507
                </varlistentry>
 
508
                <varlistentry>
 
509
                        <term><guilabel>Generate solvable games</guilabel></term>
 
510
                        <listitem><para>
 
511
                                Selects only games that can be solved when you start a new game.
 
512
                        </para></listitem>
 
513
                </varlistentry>
 
514
        </variablelist>
 
515
</sect1>
 
516
 
 
517
<sect1 id="layout-options"><title><guilabel>Board layout</guilabel> options</title>
 
518
        <variablelist>
 
519
                <varlistentry>
 
520
                        <term><guilabel>Board Layout</guilabel> selector</term>
 
521
                        <listitem><para>
 
522
                                Use the <guilabel>Board Layout</guilabel> selector to pick a gameboard to play. Different boards provide variable difficulty, depending on the number of tiles and their position.
 
523
                        </para>
 
524
                        <screenshot>
 
525
                                <screeninfo>Board Layout selector</screeninfo>
 
526
                                <mediaobject>
 
527
                                        <imageobject>
 
528
                                                <imagedata fileref="config_layout.png" format="PNG"/>
 
529
                                        </imageobject>
 
530
                                        <textobject><phrase>Board Layout selector</phrase></textobject>
 
531
                                </mediaobject>
 
532
                        </screenshot>
 
533
                        </listitem>
 
534
                </varlistentry>
 
535
        </variablelist>
 
536
</sect1>
 
537
 
 
538
<sect1 id="tiles-options"><title><guilabel>Tiles</guilabel> options</title>
 
539
        <variablelist>
 
540
                <varlistentry>
 
541
                        <term><guilabel>Tiles</guilabel> selector</term>
 
542
                        <listitem><para>
 
543
                                Use the <guilabel>Tiles</guilabel> selector to choose graphics for the tiles.
 
544
                        </para>
 
545
                        <screenshot>
 
546
                                <screeninfo>Tile selector</screeninfo>
 
547
                                <mediaobject>
 
548
                                        <imageobject>
 
549
                                                <imagedata fileref="config_tiles.png" format="PNG"/>
 
550
                                        </imageobject>
 
551
                                        <textobject><phrase>Tiles selector</phrase></textobject>
 
552
                                </mediaobject>
 
553
                        </screenshot>
 
554
                        </listitem>
 
555
                </varlistentry>
 
556
        </variablelist>
 
557
</sect1>
 
558
 
 
559
<sect1 id="background-options"><title><guilabel>Background</guilabel> options</title>
 
560
        <variablelist>
 
561
                <varlistentry>
 
562
                        <term><guilabel>Background</guilabel> selector</term>
 
563
                        <listitem><para>
 
564
                                Use the <guilabel>Background</guilabel> selector to choose a background graphic for the game.
 
565
                        </para>
 
566
                        <screenshot>
 
567
                                <screeninfo>Background selector</screeninfo>
 
568
                                <mediaobject>
 
569
                                        <imageobject>
 
570
                                                <imagedata fileref="config_background.png" format="PNG"/>
 
571
                                        </imageobject>
 
572
                                        <textobject><phrase>Background selector</phrase></textobject>
 
573
                                </mediaobject>
 
574
                        </screenshot>
 
575
                        </listitem>
 
576
                </varlistentry>
 
577
        </variablelist>
 
578
</sect1>
 
579
 
 
580
<sect1 id="default-keybindings">
 
581
<title>Default Keybindings</title>
 
582
 
 
583
<para><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice> allows you to change the default keyboard bindings.</para>
 
584
 
 
585
<screenshot>
 
586
<screeninfo>Keybindings Configure Dialog</screeninfo>
 
587
        <mediaobject>
 
588
 
 
589
          <imageobject>
 
590
            <imagedata fileref="shortcuts.png" format="PNG"/>
 
591
          </imageobject>
 
592
          <textobject>
 
593
            <phrase>Keybindings Configure Dialog</phrase>
 
594
          </textobject>
 
595
        </mediaobject>
 
596
</screenshot>
 
597
 
 
598
<para>
 
599
The default kebindings are as follows:
 
600
</para>
 
601
 
 
602
<para>
 
603
<variablelist>
 
604
 
 
605
<varlistentry>
 
606
<term><keycap>D</keycap></term>
 
607
<listitem>
 
608
<para>
 
609
Playes the game in Demo mode.
 
610
</para>
 
611
</listitem>
 
612
</varlistentry>
 
613
 
 
614
<varlistentry>
 
615
<term><keycap>H</keycap></term>
 
616
<listitem>
 
617
<para>
 
618
Gives you a hint by flashing two matching tiles.
 
619
</para>
 
620
</listitem>
 
621
</varlistentry>
 
622
 
 
623
<varlistentry>
 
624
<term><keycap>F1</keycap></term>
 
625
<listitem>
 
626
<para>
 
627
Displays this handbook.
 
628
</para>
 
629
</listitem>
 
630
</varlistentry>
 
631
 
 
632
<varlistentry>
 
633
<term><keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></term>
 
634
<listitem>
 
635
<para>
 
636
Loads a previously saved game.
 
637
</para>
 
638
</listitem>
 
639
</varlistentry>
 
640
 
 
641
<varlistentry>
 
642
<term><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo></term>
 
643
<listitem>
 
644
<para>
 
645
Starts a new game.
 
646
</para>
 
647
</listitem>
 
648
</varlistentry>
 
649
 
 
650
<varlistentry>
 
651
<term><keycap>P</keycap></term>
 
652
<listitem>
 
653
<para>
 
654
Pauses or resumes a game.
 
655
</para>
 
656
</listitem>
 
657
</varlistentry>
 
658
 
 
659
<varlistentry>
 
660
<term><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></term>
 
661
<listitem>
 
662
<para>
 
663
Quits the game.
 
664
</para>
 
665
</listitem>
 
666
</varlistentry>
 
667
 
 
668
<varlistentry>
 
669
<term><keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></term>
 
670
<listitem>
 
671
<para>
 
672
Move redo.
 
673
</para>
 
674
</listitem>
 
675
</varlistentry>
 
676
 
 
677
<varlistentry>
 
678
<term><keycap>F5</keycap></term>
 
679
<listitem>
 
680
<para>
 
681
Restart the game.
 
682
</para>
 
683
</listitem>
 
684
</varlistentry>
 
685
 
 
686
<varlistentry>
 
687
<term><keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo></term>
 
688
<listitem>
 
689
<para>
 
690
Saves the game.
 
691
</para>
 
692
</listitem>
 
693
</varlistentry>
 
694
 
 
695
<varlistentry>
 
696
<term><keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo></term>
 
697
<listitem>
 
698
<para>
 
699
Show the highscores.
 
700
</para>
 
701
</listitem>
 
702
</varlistentry>
 
703
 
 
704
<varlistentry>
 
705
<term><keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo></term>
 
706
<listitem>
 
707
<para>
 
708
Move undo.
 
709
</para>
 
710
</listitem>
 
711
</varlistentry>
 
712
 
 
713
<varlistentry>
 
714
<term><keycap>F</keycap></term>
 
715
<listitem>
 
716
<para>
 
717
Rotate the view angle clockwise.
 
718
</para>
 
719
</listitem>
 
720
</varlistentry>
 
721
 
 
722
<varlistentry>
 
723
<term><keycap>G</keycap></term>
 
724
<listitem>
 
725
<para>
 
726
Rotate the view angle counter-clockwise.
 
727
</para>
 
728
</listitem>
 
729
</varlistentry>
 
730
 
 
731
<varlistentry>
 
732
<term><keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo></term>
 
733
<listitem>
 
734
<para>
 
735
What's this? Help
 
736
</para>
 
737
</listitem>
 
738
</varlistentry>
 
739
 
 
740
</variablelist>
 
741
</para>
 
742
 
 
743
</sect1>
 
744
</chapter>
 
745
 
 
746
<chapter id="credits"><title>Credits and License</title> <!-- do not change this! -->
 
747
<!--This chapter is for credits and licenses.-->
 
748
        <para>
 
749
                &kappname; for &kde;
 
750
        </para>
 
751
 
 
752
        <para>
 
753
                Program Copyright &copy; 1997 <personname><firstname>Mathias</firstname><surname>Mueller</surname></personname> <email>in5y158@public.uni-hamburg.de</email>
 
754
        </para>
 
755
        <para>
 
756
                Program Copyright &copy; 2007 <personname><firstname>Mauricio</firstname><surname>Piacentini</surname></personname> <email>piacentini@kde.org</email>
 
757
        </para>
 
758
        <para>
 
759
                Contributors:
 
760
                <itemizedlist>
 
761
                        <listitem><para><personname><firstname>David</firstname><surname>Black</surname></personname> <email>david.black@lutris.com</email></para></listitem>
 
762
                        <listitem><para><personname><firstname>Michael</firstname><surname>Haertjens</surname></personname> <email>mhaertjens@modusoperandi.com</email></para></listitem>
 
763
                        <listitem><para><personname><firstname>Osvaldo</firstname><surname>Stark</surname></personname> <email>starko@dnet.it</email></para></listitem>
 
764
                        <listitem><para><personname><firstname>Benjamin</firstname><surname>Meyer</surname></personname> <email>ben+kmahjongg@meyerhome.net</email></para></listitem>
 
765
                        <listitem><para><personname><firstname>Albert</firstname><othername>Astals</othername><surname>Cid</surname></personname> <email>astals11@terra.es</email></para></listitem>
 
766
                        <listitem><para><personname><firstname>Raquel</firstname><surname>Ravanini</surname></personname> <email>raquel@tabuleiro.com</email></para></listitem>
 
767
                </itemizedlist>
 
768
        </para>
 
769
        <para>
 
770
                Documentation Copyright &copy; 2005 <personname><firstname>John</firstname><surname>Hayes</surname></personname> <email>justlinux@bellsouth.net</email>
 
771
        </para>
 
772
 
 
773
<!-- !!!do not change ANYTHING after this line!!!! -->
 
774
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
 
775
&underFDL;
 
776
&underGPL;
 
777
 
 
778
</chapter>
 
779
 
 
780
 
 
781
<appendix id="installation">
 
782
<title>Installation</title>
 
783
 
 
784
&install.intro.documentation;
 
785
 
 
786
 
 
787
<sect1 id="Compilation">
 
788
<title>Compilation and Installation</title>
 
789
 
 
790
&install.compile.documentation;
 
791
 
 
792
</sect1>
 
793
</appendix>
 
794
 
 
795
&documentation.index; 
 
796
</book>
 
797
<!--
 
798
Local Variables:
 
799
mode: sgml
 
800
sgml-minimize-attributes:nil
 
801
sgml-general-insert-case:lower
 
802
sgml-omittag:t
 
803
sgml-shorttag:t
 
804
sgml-namecase-general:t
 
805
sgml-always-quote-attributes:t
 
806
sgml-indent-step:0
 
807
sgml-indent-data:nil
 
808
sgml-parent-document:nil
 
809
sgml-exposed-tags:nil
 
810
sgml-local-catalogs:nil
 
811
sgml-local-ecat-files:nil
 
812
End:
 
813
-->