~neon/kdegames/trunk

« back to all changes in this revision

Viewing changes to knetwalk/doc/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:
 
1
<?xml version="1.0" ?>
 
2
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
 
3
<!ENTITY kappname "&knetwalk;">
 
4
<!ENTITY package "kdegames">
 
5
<!ENTITY % English "INCLUDE"> 
 
6
<!ENTITY % addindex "IGNORE">
 
7
]>
 
8
 
 
9
<book lang="&language;">
 
10
<bookinfo>
 
11
<title>The &knetwalk; Handbook</title>
 
12
 
 
13
<authorgroup>
 
14
<author>
 
15
<firstname>Fela</firstname>
 
16
<surname>Winkelmolen</surname>
 
17
<affiliation>
 
18
<address><email>fela.kde@gmail.com</email></address></affiliation>
 
19
</author>
 
20
<author>
 
21
<firstname>Eugene</firstname><surname>Trounev</surname>
 
22
<affiliation><address><email>eugene.trounev@gmail.com</email></address></affiliation>
 
23
</author>
 
24
<!-- TRANS:ROLES_OF_TRANSLATORS -->
 
25
</authorgroup>
 
26
 
 
27
<copyright>
 
28
<year>2007</year>
 
29
<holder>Fela Winkelmolen</holder>
 
30
</copyright>
 
31
    
 
32
<legalnotice>&FDLNotice;</legalnotice>
 
33
 
 
34
<date>2007-11-13</date>
 
35
<releaseinfo>3.0.0</releaseinfo>
 
36
 
 
37
<abstract>
 
38
<para>
 
39
&knetwalk;, a game for system administrators.</para>
 
40
</abstract>
 
41
 
 
42
<keywordset>
 
43
<keyword>KDE</keyword>
 
44
<keyword>kdegames</keyword>
 
45
<keyword>game</keyword>
 
46
<keyword>logic game</keyword>
 
47
<keyword>knetwalk</keyword>
 
48
</keywordset>
 
49
</bookinfo>
 
50
 
 
51
<chapter id="introduction">
 
52
<title>Introduction</title>
 
53
 
 
54
<para>
 
55
&knetwalk; is a single player logic game.
 
56
</para>
 
57
 
 
58
<para>
 
59
The object of the game is to start the LAN, connecting all the terminals to the server, in as few turns as possible.
 
60
</para>
 
61
</chapter>
 
62
 
 
63
<chapter id="how-to-play">
 
64
<title>How to Play</title>
 
65
 
 
66
<para>
 
67
The player is presented with a rectangular grid containing a server, several terminals, and pieces of wire.  The object of the game is to rotate these elements until every client is connected  to  the server, and no wires are left unconnected.  Optionally, you can try to get a high score by minimizing the number of rotations needed.
 
68
</para>
 
69
 
 
70
<para>
 
71
Left clicking on a square rotates it counterclockwise, while right clicking  rotates  it  clockwise. Middle clicking on a square marks it as blocked and prevents it from being rotated unless it gets unblocked by another middle click; this can be very useful for  marking  squares  which are known to be in the correct orientation. The status bar displays the number of clicks so far.
 
72
</para>
 
73
 
 
74
</chapter>
 
75
 
 
76
<chapter id="rules-strategies-tips">
 
77
<title>Game Rules, Strategies and Tips</title>
 
78
 
 
79
<sect1 id="rules">
 
80
<title>Rules</title>
 
81
<itemizedlist>
 
82
<listitem><para>There is only one possible correct solution for every game.</para></listitem>
 
83
<listitem><para>When playing the <guilabel>Very hard</guilabel> difficulty level connections can wrap from left to right and from top to bottom.</para></listitem>
 
84
<listitem><para>The game ends when every terminal and every wire is connected to the server.</para></listitem>
 
85
<listitem><para>The score represents the number of clicks it took to complete the game. The lower the score the better.</para></listitem>
 
86
</itemizedlist>
 
87
</sect1>
 
88
 
 
89
<sect1 id="stategies-and-tips">
 
90
<title>Strategies and Tips</title>
 
91
<itemizedlist>
 
92
<listitem><para>Start seeking for squares which orientation can be easily determined.</para></listitem>
 
93
<listitem><para>Once you are sure of the orientation of a square you can mark it using the &MMB;. This is particularly usefull in harder games.</para></listitem>
 
94
<listitem><para>Look for I-shaped and T-shaped wires near the borders, and L-shaped wires near the edges. The position of these squares can be easily determined, unless you are playing the <guilabel>Very hard</guilabel> difficulty level.</para></listitem>
 
95
<listitem><para>When playing the <guilabel>Very hard</guilabel> difficulty level a good place to start looking is near empty squares, if present, and near regions containing many terminals grouped together.</para></listitem>
 
96
<listitem><para>Even when playing with the same difficulty level some games are easier than others, restart the game if you want to get a different board.</para></listitem>
 
97
<listitem><para>If you want to get a good score, only do a move when you are sure.</para></listitem>
 
98
</itemizedlist>
 
99
</sect1>
 
100
 
 
101
</chapter>
 
102
 
 
103
<chapter id="interface-overview">
 
104
<title>Interface Overview</title>
 
105
 
 
106
<sect1 id="game-menu">
 
107
<title><guimenu>Game</guimenu> Menu</title>
 
108
 
 
109
<variablelist>
 
110
<varlistentry>
 
111
<term><menuchoice>
 
112
<shortcut>
 
113
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
 
114
</shortcut>
 
115
<guimenu>Game</guimenu>
 
116
<guimenuitem>New</guimenuitem>
 
117
</menuchoice></term>
 
118
<listitem>
 
119
<para>
 
120
Starts a new game. It creates a random board using the current difficulty level.
 
121
</para>
 
122
</listitem>
 
123
</varlistentry>
 
124
 
 
125
<varlistentry>
 
126
<term><menuchoice>
 
127
<shortcut>
 
128
<keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo>
 
129
</shortcut>
 
130
<guimenu>Game</guimenu>
 
131
<guimenuitem>Show High Scores</guimenuitem></menuchoice></term>
 
132
<listitem>
 
133
<para>
 
134
Shows a dialog containing the High Scores for the various difficulty levels.
 
135
</para>
 
136
</listitem>
 
137
</varlistentry>
 
138
 
 
139
<varlistentry>
 
140
<term><menuchoice>
 
141
<shortcut>
 
142
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
 
143
</shortcut>
 
144
<guimenu>Game</guimenu>
 
145
<guimenuitem>Quit</guimenuitem>
 
146
</menuchoice></term>
 
147
<listitem>
 
148
<para>
 
149
Quits the program.
 
150
</para>
 
151
</listitem>
 
152
</varlistentry>
 
153
</variablelist>
 
154
 
 
155
</sect1>
 
156
 
 
157
 
 
158
 
 
159
 
 
160
<sect1 id="settings-menu">
 
161
<title><guimenu>Settings</guimenu> Menu</title>
 
162
 
 
163
<variablelist>
 
164
 
 
165
 
 
166
<varlistentry>
 
167
<term><menuchoice>
 
168
<guimenu>Settings</guimenu>
 
169
<guimenuitem>Show Toolbar</guimenuitem>
 
170
</menuchoice></term>
 
171
<listitem>
 
172
<para>
 
173
Toggles on and off the display of the toolbar.
 
174
</para>
 
175
</listitem>
 
176
</varlistentry>
 
177
 
 
178
<varlistentry>
 
179
<term><menuchoice>
 
180
<guimenu>Settings</guimenu>
 
181
<guimenuitem>Show Statusbar</guimenuitem>
 
182
</menuchoice></term>
 
183
<listitem>
 
184
<para>
 
185
Toggles on and off the display of the statusbar.
 
186
</para>
 
187
</listitem>
 
188
</varlistentry>
 
189
 
 
190
<!--
 
191
<varlistentry>
 
192
<term><menuchoice>
 
193
<guimenu>Settings</guimenu>
 
194
<guimenuitem>Themes</guimenuitem>
 
195
</menuchoice></term>
 
196
<listitem><para>
 
197
<action>Choose a graphical theme for the game. Which themes are available depends on the current installation.</action>
 
198
</para></listitem>
 
199
</varlistentry>
 
200
-->
 
201
 
 
202
<varlistentry>
 
203
<term><menuchoice>
 
204
<guimenu>Settings</guimenu>
 
205
<guisubmenu>Difficulty</guisubmenu>
 
206
</menuchoice></term>
 
207
<listitem>
 
208
<para>Lets you set the difficulty level from a sub-menu.</para>
 
209
<para>There are four levels of difficulty:
 
210
<itemizedlist>
 
211
<listitem><para><guimenuitem>Easy</guimenuitem>: 5 rows, 5 columns, without wrapping.</para></listitem>
 
212
<listitem><para><guimenuitem>Medium</guimenuitem>: 7 rows, 7 columns, without wrapping.</para></listitem>
 
213
<listitem><para><guimenuitem>Hard</guimenuitem>: 9 rows, 9 columns, without wrapping.</para></listitem>
 
214
<listitem><para><guimenuitem>Very hard</guimenuitem>: 9 rows, 9 columns, with wrapping.</para></listitem>
 
215
</itemizedlist>
 
216
</para></listitem>
 
217
</varlistentry>
 
218
 
 
219
<varlistentry>
 
220
<term><menuchoice>
 
221
<guimenu>Settings</guimenu>
 
222
<guimenuitem>Configure Shortcuts...</guimenuitem>
 
223
</menuchoice></term>
 
224
<listitem><para>
 
225
<action>Opens a dialog which lets you redefine all the keyboard shortcuts.</action>
 
226
</para></listitem>
 
227
</varlistentry>
 
228
 
 
229
<varlistentry>
 
230
<term><menuchoice>
 
231
<guimenu>Settings</guimenu>
 
232
<guimenuitem>Configure Toolbars...</guimenuitem>
 
233
</menuchoice></term>
 
234
<listitem><para>Displays a &kde; standard dialog where you can configure the toolbar icons.</para></listitem>
 
235
</varlistentry>
 
236
 
 
237
<varlistentry>
 
238
<term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
 
239
Notifications...</guimenuitem></menuchoice></term>
 
240
<listitem><para>This item displays a standard &kde; notifications configuration
 
241
dialog, where you can change the notifications (sounds, visible messages,
 
242
&etc;) used by &knetwalk;.</para></listitem>
 
243
</varlistentry>
 
244
 
 
245
</variablelist>
 
246
</sect1>
 
247
 
 
248
<sect1 id="help">
 
249
<title><guimenu>Help</guimenu> Menu</title>
 
250
 
 
251
&help.menu.documentation;
 
252
 
 
253
</sect1>
 
254
 
 
255
<sect1 id="keybindings">
 
256
<title id="keybindings-title">Shortcuts</title>
 
257
 
 
258
<para>The default shortcuts are:</para>
 
259
 
 
260
<table>
 
261
<title>Shortcuts</title>
 
262
<tgroup cols="2">
 
263
<tbody>
 
264
<row>
 
265
<entry>Start a new game</entry>
 
266
<entry>
 
267
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
 
268
</entry>
 
269
</row>
 
270
<row>
 
271
<entry>Show High Scores</entry>
 
272
<entry>
 
273
<keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo>
 
274
</entry>
 
275
</row>
 
276
<row>
 
277
<entry>Quit</entry>
 
278
<entry>
 
279
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
 
280
</entry>
 
281
</row>
 
282
<row>
 
283
<entry>Help</entry>
 
284
<entry><keycap>F1</keycap></entry>
 
285
</row>
 
286
<row>
 
287
<entry>What's this?</entry>
 
288
<entry>
 
289
<keycombo action="simul">&Shift;<keycap>F1</keycap></keycombo>
 
290
</entry>
 
291
</row>
 
292
</tbody>
 
293
</tgroup>
 
294
</table>
 
295
 
 
296
</sect1>
 
297
</chapter>
 
298
 
 
299
 
 
300
<chapter id="credits">
 
301
<title>Credits and License</title>
 
302
 
 
303
<para>
 
304
&knetwalk;
 
305
</para>
 
306
<para>
 
307
Program copyright 2004 - 2007 by Andi Peredri, Thomas Nagy and Fela Winkelmolen <email>fela.kde@gmail.com</email>
 
308
</para>
 
309
<para>
 
310
Documentation copyright 2007 by Fela Winkelmolen <email>fela.kde@gmail.com</email>
 
311
</para>
 
312
 
 
313
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
 
314
 
 
315
&underFDL;
 
316
&underGPL;
 
317
 
 
318
</chapter>
 
319
 
 
320
<appendix id="installation">
 
321
<title>Installation</title>
 
322
 
 
323
<sect1 id="getting-knetwalk">
 
324
<title>How to obtain &knetwalk;</title>
 
325
 
 
326
&install.intro.documentation;
 
327
 
 
328
</sect1>
 
329
 
 
330
<sect1 id="compilation">
 
331
<title>Compilation and Installation</title>
 
332
 
 
333
&install.compile.documentation;
 
334
 
 
335
</sect1>
 
336
</appendix>
 
337
 
 
338
 
 
339
&documentation.index; 
 
340
</book>
 
341
<!--
 
342
Local Variables:
 
343
mode: sgml
 
344
sgml-minimize-attributes:nil
 
345
sgml-general-insert-case:lower
 
346
sgml-always-quote-attributes:t
 
347
sgml-indent-step:0
 
348
sgml-indent-data:t
 
349
End:
 
350
-->
 
351