index.docbook 49.9 KB
Newer Older
Håvard Frøiland's avatar
Håvard Frøiland committed
1
<?xml version="1.0" ?>
2
3
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
 "dtd/kdedbx45.dtd" [
4
5
<!ENTITY i18n-ktouch "<application>Typewriting Trainer</application>">
<!ENTITY kappname "&i18n-ktouch;"><!-- replace kapp here -->
Håvard Frøiland's avatar
Håvard Frøiland committed
6
7
8
9
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE"><!-- change language only here -->
]>

10
<book id="ktouch" lang="&language;">
Håvard Frøiland's avatar
Håvard Frøiland committed
11

12
<bookinfo>
13
<title>The &i18n-ktouch; Handbook</title>
Håvard Frøiland's avatar
Håvard Frøiland committed
14
15

<authorgroup>
16

17
<author>
18
<firstname>Håvard</firstname><surname>Frøiland</surname>
19
<affiliation>
20
<address>&Haavard.Froeiland.mail;</address>
21
22
</affiliation>
</author>
Håvard Frøiland's avatar
Håvard Frøiland committed
23

24
25
26
<author>
<firstname>Andreas</firstname><surname>Nicolai</surname>
<affiliation>
27
<address><email>Andreas.nicolai@gmx.net</email></address>
28
29
</affiliation>
</author>
Håvard Frøiland's avatar
Håvard Frøiland committed
30

31
32
33
34
35
36
37
<author>
<firstname>Sebastian</firstname><surname>Gottfried</surname>
<affiliation>
<address><email>sebastiangottfried@web.de</email></address>
</affiliation>
</author>

38
39
<!-- TRANS:ROLES_OF_TRANSLATORS -->

40
41
</authorgroup>

42

Håvard Frøiland's avatar
Håvard Frøiland committed
43
<copyright>
44
<year>1999-2007</year>
45
<holder>Håvard Frøiland, Andreas Nicolai</holder>
Håvard Frøiland's avatar
Håvard Frøiland committed
46
</copyright>
47
<copyright>
48
<year>2011-2019</year>
49
50
<holder>Sebastian Gottfried</holder>
</copyright>
Håvard Frøiland's avatar
Håvard Frøiland committed
51
52
53

<legalnotice>&FDLNotice;</legalnotice>

54
55
<date>2019-07-05</date>
<releaseinfo>Applications 19.08</releaseinfo>
Håvard Frøiland's avatar
Håvard Frøiland committed
56
57

<abstract>
58
<para>&i18n-ktouch; is a program for learning to touch type.  &i18n-ktouch;
59
60
provides you with text to train on and adjusts to different levels
depending on how good you are. It displays which key to press next 
61
and the correct finger to use.</para>
62

Håvard Frøiland's avatar
Håvard Frøiland committed
63
64
65
66
67
68
69
</abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>touchwriting</keyword>
<keyword>touchtyping</keyword>
<keyword>typing</keyword>
Malcolm Hunter's avatar
Malcolm Hunter committed
70
<keyword>typewriting</keyword>
Håvard Frøiland's avatar
Håvard Frøiland committed
71
<keyword>education</keyword>
72
73
74
<keyword>ktouch</keyword>
<keyword>touch</keyword>
<keyword>type</keyword>
Håvard Frøiland's avatar
Håvard Frøiland committed
75
76
77
78
</keywordset>

</bookinfo>

79
80
<chapter id="learning">
<title>Learning touch typing with &i18n-ktouch;</title>
81
82

<sect1 id="introduction">
Håvard Frøiland's avatar
Håvard Frøiland committed
83
84
<title>Introduction</title>

85
<sect2>
86
87
88
<title>What is &i18n-ktouch;?</title>
<para>&i18n-ktouch; is a program for learning to touch type.</para>
<para>&i18n-ktouch; provides you with text to train on and adjusts to
89
90
different levels depending on how good you are. It shows your keyboard 
and indicates which key to press next and the correct finger to use.</para>
Håvard Frøiland's avatar
Håvard Frøiland committed
91
92

<screenshot>
93
<screeninfo>The main screen of &i18n-ktouch;</screeninfo>
94
95
<mediaobject>
<imageobject>
96
<imagedata fileref="main_screen_default_color.png" format="PNG"/>
97
98
</imageobject>
<textobject>
99
<phrase>The main screen of &i18n-ktouch;</phrase>
100
101
</textobject>
</mediaobject>
Håvard Frøiland's avatar
Håvard Frøiland committed
102
103
</screenshot>

104
105
<para>&i18n-ktouch; is a touch typing tutor aimed mostly at personal use. You learn
typing with all fingers, step by step, without having to look down 
106
at the keyboard all the time to find the right keys which slows you down a lot.
107
108
</para>
</sect2>
109

110
<sect2>
111
<title>Features</title>
112

113
<para>In its current version, &i18n-ktouch; has quite a number of
114
features, such as:</para>
115
<itemizedlist>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
116
117
<listitem><simpara>Ships with dozens different courses in many
languages and a comfortable course editor</simpara></listitem>
118
<listitem><simpara>Support for different keyboard layouts with the ability to
119
use and edit user-defined layouts</simpara></listitem>
Sebastian Gottfried's avatar
Sebastian Gottfried committed
120
121
<listitem><simpara>During your training session &i18n-ktouch; collects comprehensive statistical
information to help you or your teacher analyze your
122
progress</simpara></listitem>
123
124
</itemizedlist>
<para>
125
There are many more features which will be discussed in the appropriate
126
chapters of this manual.
127
128
129
130
131
</para>
</sect2>
</sect1>


132
133
<sect1 id="getting_started">
<title>Getting started</title>
134

135
136
<para>Here's another screenshot of &i18n-ktouch; in action, this time with a German
keyboard and training lesson:</para>
137

Håvard Frøiland's avatar
Håvard Frøiland committed
138
<screenshot>
139
<screeninfo>Main screen of &i18n-ktouch;</screeninfo>
140
141
<mediaobject>
<imageobject>
142
<imagedata fileref="main_window_german.png" format="PNG"/>
143
144
</imageobject>
<textobject>
145
<phrase>Main screen of &i18n-ktouch;</phrase>
146
147
</textobject>
</mediaobject>
Håvard Frøiland's avatar
Håvard Frøiland committed
148
149
</screenshot>

150
151
<para>Even though learning touch typing with &i18n-ktouch; and using the program
should be very simple we will look a bit closer at &i18n-ktouch; in the following
152
sections.</para>
Håvard Frøiland's avatar
Håvard Frøiland committed
153

154
155
156
157
158
159
160
161
162
<sect2 id="creating_profile">
<title>Creating your first profile</title>

<para>The first time you start &i18n-ktouch; it will open a special screen helping
you to create your first profile. You can choose the name of your profile and
the level of your typing skills.
</para>
<tip>
<para>
163
The level you choose determines the general operation of &i18n-ktouch;. In beginner
164
mode lessons are unlocked one by one after you pass them, for advanced typist
165
all lessons are available right from the beginning.
166
167
168
169
</para>
</tip>
<note>
<para>
170
171
Think about your choice, you won't able to change the type of a profile later. But you can always
create new profiles to revisit this decision.
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
</para>
</note>

<screenshot>
<screeninfo>Welcome screen of &i18n-ktouch;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="welcome_screen.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Welcome screen of &i18n-ktouch;</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
187
188
After pressing <guibutton>Start Training</guibutton> you will be taken to the
home screen. This screen will also be the first screen visible when you run &i18n-ktouch; the
189
190
191
192
193
194
195
196
next time.
</para>
</sect2>

<sect2 id="picking_a_lesson">
<title>Picking a lesson</title>

<para>
197
The home screen of &i18n-ktouch; consists of a toolbar and the course
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
selector. For more information see <xref linkend="training_preparation"/>.
</para>
<screenshot>
<screeninfo>Home screen of &i18n-ktouch;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="home_screen.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Home screen of &i18n-ktouch;</phrase>
</textobject>
</mediaobject>
</screenshot>

<para>
&i18n-ktouch; will show you the first course available for your current keyboard
layout.
</para>

217
<para>
218
You can switch between courses or choose <link linkend="custom_lessons">custom lessons</link> by clicking their thumbnails in the right part of the window.
219
220
</para>

221
222
<note>
<para>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
223
On some platforms, especially on &Microsoft; &Windows;, automatic keyboard layout
224
detection is not available. In that case you have to click on the <inlinemediaobject>
225
<imageobject> <imagedata fileref="Icon-configure.png" format="PNG"/>
226
</imageobject> </inlinemediaobject> button in the toolbar, select <guisubmenu>
227
Configure Keyboard...</guisubmenu> submenu and choose the name of keyboard
228
layout or some keyboard layout which is similar to yours. If your keyboard is
229
not included, you can define your own keyboard layout yourself, see <xref
230
231
232
233
234
235
236
linkend="create_layouts"/>.
</para>
</note>
<para>
Choose your lesson from the list on left of the window. You cannot choose
the locked lessons with <inlinemediaobject> <imageobject> <imagedata
fileref="Icon-object-locked.png" format="PNG"/> </imageobject>
237
</inlinemediaobject> as they are too difficult for your current skills. Pass lessons to unlock new ones. The
238
239
240
241
242
243
244
245
246
247
248
249
preview of the selected lesson will be shown on the right of lessons list.
</para>
<tip>
<para>
More information about the selected course can be shown and hidden again using
<inlinemediaobject>  <imageobject> <imagedata
fileref="Icon-dialog-information.png" format="PNG"/> </imageobject>
</inlinemediaobject> button next to the course title.
</para>
</tip>
<para>
When you finished with the selection click on <guibutton>Start
250
Training</guibutton> to go to the training &i18n-ktouch; screen.
251
252
</para>
</sect2>
Håvard Frøiland's avatar
Håvard Frøiland committed
253

254
255
256
257
<sect2 id="training">
<title>Training</title>
<para>
   The training window of &i18n-ktouch; shows three main sections:
258
259
</para>
<orderedlist>
Anne-Marie Mahfouf's avatar
Anne-Marie Mahfouf committed
260
<listitem><simpara>Some typing statistics in info boxes at the
261
top</simpara></listitem>
262
263
<listitem><simpara>The text you need to type</simpara></listitem>
<listitem><simpara>The keyboard visualization</simpara></listitem>
264
</orderedlist>
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
<screenshot>
<screeninfo>The training screen of &i18n-ktouch;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="main_screen_default_color.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>The training screen of &i18n-ktouch;</phrase>
</textobject>
</mediaobject>
</screenshot>
<note>
  <para>
    Visibility of training screen parts can be configured using <link
linkend="configuration_dialog">&i18n-ktouch; configuration dialog</link>.
  </para>
</note>

<para>
Place your two index fingers on the two keys on your keyboard with the two
little tactile markers near the center of the middle character row. With that
286
287
288
289
done your other fingers will find their intended keys almost automatically.
Your thumbs should rest above the space key, the only key you will ever use them
for when touch typing. The other fingers should be placed on the three keys
adjacent to the marked keys on the center row. Keys for the same finger are
Yuri Chornoivan's avatar
Yuri Chornoivan committed
290
grouped together through their color. Try to move your hands as little as
291
292
possible and always try to return your fingers to their resting positions
after you have typed a character.
293
</para>
294
<para>
Burkhard Lück's avatar
Burkhard Lück committed
295
Start typing the text in the middle of the screen. The next key you have
296
to press is always highlighted on the keyboard visualization. While you type
297
298
299
you may make mistakes and hit the wrong key. In that case the characters will
displayed in red and you have to hit &Backspace; as often as necessary to
erase the wrongly typed characters.
300
301
</para>
<para>
302
When you have successfully completed a line of text you need to press the
303
304
305
306
<keycap>Return</keycap> to advance to the next line.
</para>
<tip>
<para>
307
The key used to advance to the next line can be changed using <link
308
linkend="configuration_dialog">&i18n-ktouch; configuration dialog</link>
309
</para>
310
</tip>
311
</sect2>
Håvard Frøiland's avatar
Håvard Frøiland committed
312

313
314
<sect2 id="review_your_progress">
<title>Review your progress</title>
315
316
<para>When you have completed a lesson &i18n-ktouch;
will switch to the score screen. It displays your current training and lesson
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
statistics and shows a graphical history of previous training sessions.
</para>
<screenshot>
<screeninfo>Statistics dialog of &i18n-ktouch;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="statistics_dialog.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Statistics dialog of &i18n-ktouch;</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
In the statistics dialog you can select to show a particular lesson or
<guilabel>All Lessons</guilabel>. This is useful to distinguish between overall
performance and skill in certain lessons.
</para>
<para>
If you feel ready for the next lesson press <guibutton>Next lesson</guibutton>
button in the toolbar to continue with the next lesson of the current course or
<guibutton>Repeat lesson</guibutton> button to try your skills on the current
lesson again. The <guibutton>Next lesson</guibutton> button will be only
available if you have passed the lesson.
</para>
Håvard Frøiland's avatar
Håvard Frøiland committed
342
<para>
343
344
If you want to switch to some other lesson or course press <guibutton>Return to
Home Screen</guibutton>.
345
346
</para>
<para>
347
348
If you do not want to continue the training with &i18n-ktouch; just close the
application window.
349
350
</para>
</sect2>
351
</sect1>
Håvard Frøiland's avatar
Håvard Frøiland committed
352

353
354
<sect1 id="training_preparation">
<title>Training Preparation</title>
355
<para>
356
357
358
359
360
361
362
363
364
365
  Pretty much everything in the &i18n-ktouch; home screen should be self-explanatory.
The top toolbar is meant to be the place where you can view and
configure &i18n-ktouch; settings. The course selector can be used to view the
information about the courses and switch between them.
</para>

<sect2 id="toolbar">
  <title>&i18n-ktouch; toolbar</title>
<para>The toolbar of &i18n-ktouch; houses the profile button at the left and the
application menu button at the right.
366
</para>
367
368
369

<sect3 id="profile_management">
<title>Profile management</title>
370
<para>
371
372
  The profile button with the name of your profile at the left of home screen
toolbar can be used to manage &i18n-ktouch; profiles.
373
374
</para>

375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
<screenshot>
<screeninfo>Profile management in &i18n-ktouch;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="profiles.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Profile management in &i18n-ktouch;</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
  You can review the settings of the existing profiles, delete them or create a
new profile using <inlinemediaobject> <imageobject> <imagedata
fileref="Icon-list-add.png" format="PNG"/> </imageobject> </inlinemediaobject>
button.
</para>
<para>
  To switch to the review mode press <guibutton>Edit</guibutton>. To select a
profile and return to the home screen press <guibutton>Use Selected Profile
</guibutton>.
</para>
Håvard Frøiland's avatar
Håvard Frøiland committed
397

398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
<screenshot>
<screeninfo>Reviewing profile information</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="profiles1.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Reviewing profile information</phrase>
</textobject>
</mediaobject>
</screenshot>
</sect3>

<sect3 id="ktouch_menu">
<title>&i18n-ktouch; menu</title>
<para>&i18n-ktouch; menu can be opened using <inlinemediaobject>
<imageobject> <imagedata fileref="Icon-configure.png" format="PNG"/>
</imageobject> </inlinemediaobject> button in the toolbar of the home
screen.
417
</para>
Håvard Frøiland's avatar
Håvard Frøiland committed
418

419
<screenshot>
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
<screeninfo>&i18n-ktouch; menu</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="ktouch_menu.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&i18n-ktouch; menu</phrase>
</textobject>
</mediaobject>
</screenshot>

<para>
  You can find a list of the menu items with their short descriptions below.
</para>
<variablelist>
<varlistentry>
  <term><menuchoice><shortcut>
<keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo>
</shortcut>
<guimenuitem>Full Screen Mode</guimenuitem></menuchoice>
</term>
<listitem><para><action>Toggle</action> full screen mode of
&i18n-ktouch; on and off</para></listitem>
</varlistentry>

<varlistentry>
<term><guimenuitem>Course and Keyboard Layout Editor...</guimenuitem></term>
<listitem><para><action>Open</action> the &i18n-ktouch; <link
linkend="extending">editor window</link>
</para></listitem>
</varlistentry>

<varlistentry>
<term><guimenuitem>Configure Typewriting Trainer...</guimenuitem></term>
<listitem><para><action>Display</action> the &i18n-ktouch; <link
linkend="configuration_dialog">configuration dialog</link>
</para></listitem>
</varlistentry>

<varlistentry>
<term><guimenuitem>Configure Shortcuts...</guimenuitem></term>
<listitem><para><action>Configure</action> the shortcuts you want to associate
with some actions
</para></listitem>
</varlistentry>

<varlistentry>
467
<term><guimenuitem>Configure Keyboard...</guimenuitem></term>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
468
<listitem><para>A shortcut to the &systemsettings;
469
470
471
472
473
474
475
module to configure the keyboard settings. Useful to prepare for training on
a different keyboard layout.
</para>
<note>
<para>
On platforms lacking the support for detecting the keyboard layout
automatically, especially &Microsoft; &Windows;, this entry is replaced
Yuri Chornoivan's avatar
Yuri Chornoivan committed
476
with a submenu to select &i18n-ktouch;'s keyboard layout manually.
477
478
479
480
481
482
483
</para>
</note>
</listitem>
</varlistentry>

</variablelist>

484
485
<para>
&i18n-ktouch; has the common &kde; <guimenu>Help</guimenu> menu item, for more information read the section
486
about the <ulink url="help:/fundamentals/menus.html#menus-help">Help Menu</ulink> of the &kde; Fundamentals.
487
</para>
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
</sect3>

<sect3 id="configuration_dialog">
<title>Configuration dialog</title>

<para>You can customize &i18n-ktouch; quite a bit. The settings apply for all
profiles globally. Open the configuration dialog by pressing
<inlinemediaobject> <imageobject> <imagedata fileref="Icon-configure.png"
format="PNG"/> </imageobject> </inlinemediaobject> button at the right of the
top toolbar of the home screen then choosing <guimenuitem>Configure
Typewriting Trainer...</guimenuitem>.</para>

 <variablelist>
   <varlistentry>
     <term><guilabel>Training Settings</guilabel></term>
     <listitem>
       <para>In this dialog you can select the options that control tutor window
appearance and how &i18n-ktouch; behaves during training.</para>
<screenshot>
<screeninfo>Training options</screeninfo>
508
<mediaobject>
509
<imageobject><imagedata fileref="training_options.png"
510
format="PNG"/></imageobject>
511
<textobject><phrase>Training options</phrase></textobject>
512
513
</mediaobject>
</screenshot>
514
515
516
<para>
  The <guilabel>Enforce correction of typing errors</guilabel> check box can be used to control whether typing errors have to be corrected.
</para>
517
518
519
520
<para>
  You can control the visibility of statistics and keyboard panes during
training using <guilabel>Show keyboard</guilabel> and <guilabel>Show real-time
statistics</guilabel> check boxes.
Håvard Frøiland's avatar
Håvard Frøiland committed
521
</para>
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
<para>
  The keystroke to go to the next line of training text can be chosen from two
options, <keycap>Return</keycap> or <keycap>Space</keycap>.
</para>
<para>The <guilabel>Lesson unlocking limits</guilabel> can be used to choose
settings that control unlocking of higher level lessons. &i18n-ktouch; checks the
given limits at the end of each level and decides whether to
unlock the next lesson. If the typing speed in characters per minute and
correctness are <emphasis>both</emphasis> above or equal to the
<guilabel>Lesson unlocking limits</guilabel> &i18n-ktouch; will unlock the next
higher level lesson.
</para>
</listitem>
</varlistentry>

<varlistentry>
  <term><guilabel>Color Settings</guilabel></term>
  <listitem>
<para>In this dialog you can tweak the colors used by &i18n-ktouch;.</para>
<screenshot>
<screeninfo>Color settings</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="color_options.png"
format="PNG"/></imageobject>
<textobject><phrase>Color settings</phrase></textobject>
</mediaobject>
</screenshot>
<para>
You can select the background color for each finger keys.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect3>
556
557
</sect2>

558
559
560
561
562
563
564
565
566
567
568
569
570
571
<sect2 id="course_and_lessons_selection">
<title>Course and lesson selection</title>
<para>
&i18n-ktouch; automatically detects your keyboard layout and shows only the courses
optimized for this layout.
</para>
<note>
<para>
On some platforms, especially &Windows;, keyboard layout auto-detection is not
available. Use the application menu to select your keyboard layout manually.
</para>
</note>
<sect3 id="switching_courses">
<title>Switching courses</title>
572
573
<para>Should there are more than one course available for your keyboard layout
you can  choose your favorite one using <inlinemediaobject> <imageobject>
574
575
576
577
578
579
<imagedata fileref="Icon-arrow-left.png"
format="PNG"/> </imageobject> </inlinemediaobject> and <inlinemediaobject>
<imageobject> <imagedata fileref="Icon-arrow-right.png"
format="PNG"/> </imageobject> </inlinemediaobject> buttons to the right of the
label with course name. If there is only one course the buttons won't be
visible.
580
</para>
581
582
583
584
585
586
</sect3>
<sect3 id="unlocking_lessons">
<title>Unlocking lessons</title>
<para>
If you have chosen <guilabel>I have no or only very little experience in machine
typing</guilabel> during <link linkend="creating_profile">initial profile
587
creation</link> you will find that some lessons are locked. These items are marked
588
589
with <inlinemediaobject> <imageobject> <imagedata
fileref="Icon-object-locked.png" format="PNG"/> </imageobject>
590
</inlinemediaobject> icon and cannot be accessed until you pass the previous
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
lessons.
</para>
<note>
<para>
The settings to pass lessons can be changed using <link
linkend="configuration_dialog">&i18n-ktouch; configuration dialog</link>.
</para>
</note>
</sect3>
<sect3 id="training_on_a_different_keyboard_layout">
<title>Training on a different keyboard layout</title>
<para>
With &i18n-ktouch; it is possible to use any keyboard layout for training.
Just press the buttons that are highlighted by the trainer, regardless to the
labels on your physical keyboard.
</para>
<para>
Select <menuchoice><guimenu>Configure Keyboard...</guimenu></menuchoice> in
the application menu to select a different keyboard layout. After that &i18n-ktouch;
will adapt accordingly and present you its courses for this layout.
</para>
<note>
<para>
On platforms without keyboard layout auto-detection, especially &Microsoft;
615
616
617
&Windows;, you have first configure your operating system to use the layout
you want to train on and then select the same layout in &i18n-ktouch; via
the application menu.
618
619
620
</para>
</note>
</sect3>
621
</sect2>
622
</sect1>
623

624
625
626
627
628
629
630
631
632
633
634
635
636
637
<sect1 id="efficient_training">
<title>Efficient training</title>
<sect2 id="training_techniques">
<title>Training techniques</title>
<para>
Hereafter, you can find some general advice about techniques for learning
touch typing.
</para>
<sect3 id="steady_speed">
<title>Steady speed</title>
<para>
To be efficient when learning touch typing it is important not to simply try to
type as fast as possible but to keep a steady speed and find a natural rhythm
to press the keys.
638
</para>
639
640
641
</sect3>
<sect3 id="accuracy_is_a_king">
<title>Accuracy is a king</title>
Andreas Nicolai's avatar
Andreas Nicolai committed
642
<para>
643
644
645
646
647
648
The next important thing is to focus one's attention on accuracy. Only if you
mastered the use of the currently unlocked keys, which means you make only
very few errors with them still, you will have chance in the following lessons
with even more keys to handle. You will notice you become almost automatically
master if you make only very little errors and you will save precious time if
you don't have to correct that many errors.
Andreas Nicolai's avatar
Andreas Nicolai committed
649
</para>
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
<note>
<para>That is also the reason why the default accuracy level
to unlock the next lesson is at 98% while the speed requirements are pretty
moderate with just 180 characters per minute.
</para>
</note>
</sect3>
<sect3 id="correcting_mistakes">
<title>Correcting mistakes</title>
<para>
If you made mistakes it's important to correct them efficiently. Correcting
single characters is almost always slower than correcting the whole word. For
the latter you have just to press <keycombo>&Ctrl;&Backspace;</keycombo>,
and retype the word. The mental overhead for this is very small. For the first
you have to first locate the your mistake, delete precisely to the location of
the error, determine the missing part of the word re-type it. This requires
way more concentration when retyping the whole word.
</para>
</sect3>
</sect2>
<sect2 id="pausing_the_training_session">
<title>Pausing the training session</title>
<sect3 id="automatically_pausing">
<title>Automatically</title>
<para>
If you open any dialog or switch to different application while you are in a
training session the  training is paused and the timer is stopped until you
focus &i18n-ktouch; window again and hit any key.
</para>
<para>
The training session will also be paused if there will be no activity by the
user for five seconds.
</para>
</sect3>
<sect3 id="manually_pausing">
<title>Manually</title>
Andreas Nicolai's avatar
Andreas Nicolai committed
686
<para>
687
688
689
690
691
692
693
694
695
696
697
You can pause the current session manually using
<inlinemediaobject> <imageobject> <imagedata
fileref="Icon-media-playback-pause.png" format="PNG"/> </imageobject>
</inlinemediaobject> button in the toolbar.
</para>
<para>
If you click on <inlinemediaobject>
<imageobject> <imagedata fileref="Icon-go-home.png"
format="PNG"/> </imageobject> </inlinemediaobject> button in the toolbar
&i18n-ktouch; will pause the current
session  and show an overlay menu with some further actions.
Andreas Nicolai's avatar
Andreas Nicolai committed
698
699
</para>
<screenshot>
700
<screeninfo>&i18n-ktouch; menu on pausing</screeninfo>
Andreas Nicolai's avatar
Andreas Nicolai committed
701
<mediaobject>
702
<imageobject><imagedata fileref="pause_options.png"
703
format="PNG"/></imageobject>
704
<textobject><phrase>&i18n-ktouch; menu on pausing</phrase></textobject>
Andreas Nicolai's avatar
Andreas Nicolai committed
705
706
</mediaobject>
</screenshot>
707
</sect3>
708
709
</sect2>
</sect1>
Andreas Nicolai's avatar
Andreas Nicolai committed
710

711
<sect1 id="tracking_learning_progress">
712
<title>Tracking the learning progress</title>
713
714
715
<para>
After completing a lesson, you will not return immediately to the home screen.
Instead a special summary and statistics screen is shown.
Håvard Frøiland's avatar
Håvard Frøiland committed
716
</para>
717
718
<sect2 id="Speed_and_accuracy_statistics">
<title>Speed and accuracy statistics</title>
719
<screenshot>
720
<screeninfo>Score screen progress page</screeninfo>
721
<mediaobject>
722
<imageobject><imagedata fileref="score_screen.png"
723
format="PNG"/></imageobject>
724
<textobject><phrase>Score screen progress page</phrase></textobject>
725
726
</mediaobject>
</screenshot>
727
728
729
730
731
732
733
<sect3 id="filter_per_lesson">
<title>Filter per lesson</title>
<para>
With the help of the speed and accuracy statistics page you can review your
learning progress and identify your weaknesses.
</para>
<para>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
734
The statistics data can be filtered by lesson using drop down box next to the
735
736
737
<guilabel>Over</guilabel> label. This feature can be useful to control you
progress in the current lesson and compare this progress with the progress in
other lessons.
738
739
</para>
<screenshot>
740
<screeninfo>Statistics range drop down menu</screeninfo>
741
<mediaobject>
742
<imageobject><imagedata fileref="statistics_over.png"
743
format="PNG"/></imageobject>
744
<textobject><phrase>Statistics range drop down menu</phrase></textobject>
745
746
</mediaobject>
</screenshot>
747
748
749
750
<para>
Additional data about the session can be viewed in overlays. If you hover the
mouse cursor on a point on the graph &i18n-ktouch; will show the statistics of the
corresponding session.
751
752
</para>
<screenshot>
753
<screeninfo>Progress per lesson</screeninfo>
754
<mediaobject>
755
<imageobject><imagedata fileref="statistics_hovering.png"
756
format="PNG"/></imageobject>
757
<textobject><phrase>Progress per lesson</phrase></textobject>
758
759
</mediaobject>
</screenshot>
760
761
762
763
</sect3>
</sect2>
<sect2 id="errors_statistics">
<title>Errors statistics</title>
764
<para>
765
766
The score screen can be switched to show errors rate for each key using drop
down menu next to the <guilabel>Show</guilabel> label.
767
768
</para>
<screenshot>
769
<screeninfo>Switching the statistics mode</screeninfo>
770
<mediaobject>
771
<imageobject><imagedata fileref="statistics_show.png"
772
format="PNG"/></imageobject>
773
<textobject><phrase>Switching the statistics mode</phrase></textobject>
774
775
776
</mediaobject>
</screenshot>
<para>
777
778
In this mode, &i18n-ktouch; shows a bar diagram of errors for each key in the last
training session.
Burkhard Lück's avatar
Burkhard Lück committed
779
780
</para>
<screenshot>
781
<screeninfo>Errors chart by the keys</screeninfo>
Burkhard Lück's avatar
Burkhard Lück committed
782
<mediaobject>
783
<imageobject><imagedata fileref="score_screen_errors.png"
Burkhard Lück's avatar
Burkhard Lück committed
784
format="PNG"/></imageobject>
785
<textobject><phrase>Errors chart by the keys</phrase></textobject>
Burkhard Lück's avatar
Burkhard Lück committed
786
787
788
</mediaobject>
</screenshot>
<para>
789
790
791
792
793
794
795
You can switch back to the lessons graph using the same drop down menu next to
the <guilabel>Show</guilabel> label.
</para>
<para>
If you have passed the lesson you may choose to start training on the next
lesson right away by pressing <guibutton>Next lesson</guibutton> in the
toolbar.
Burkhard Lück's avatar
Burkhard Lück committed
796
Otherwise you can repeat the current lesson with <guibutton>Repeat
797
lesson</guibutton> or return to the home screen with the remaining button.
798
799
800
</para>
</sect2>
</sect1>
Håvard Frøiland's avatar
Håvard Frøiland committed
801
802
</chapter>

803
<chapter id="extending">
804
805
806
807
808
809
810
811
812
813
814
815
816
<title>Extending &i18n-ktouch;</title>

<sect1 id="create_courses">
<title>Creating courses</title>
<para>You can easily create your own training course using the built-in
&i18n-ktouch; course and keyboard layout editor. Press <inlinemediaobject>
<imageobject> <imagedata fileref="Icon-configure.png" format="PNG"/>
</imageobject> </inlinemediaobject> button at the right of the home screen
toolbar then choose <guimenuitem>Course and Keyboard Layout
Editor...</guimenuitem>. You can choose open a course file or create an empty
course from
scratch or using an existing course as a template.</para>
<important>
Andreas Nicolai's avatar
Andreas Nicolai committed
817
<para>
818
819
You cannot edit the built-in courses, even if you have the write access to the
installation directory.
Andreas Nicolai's avatar
Andreas Nicolai committed
820
</para>
821
</important>
Andreas Nicolai's avatar
Andreas Nicolai committed
822

823
824
825
826
827
828
829
830
831
832
833
<screenshot>
<screeninfo>Course and Keyboard Layout Editor main window</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="courses.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Course and Keyboard Layout Editor main window</phrase>
</textobject>
</mediaobject>
</screenshot>
Andreas Nicolai's avatar
Andreas Nicolai committed
834

835
836
<sect2 id="course_properties">
<title>Course properties</title>
Andreas Nicolai's avatar
Andreas Nicolai committed
837
<para>
838
839
840
841
842
The course properties can be chosen using &i18n-ktouch; course creation wizard. To
invoke this wizard you should press <inlinemediaobject>
<imageobject> <imagedata fileref="Icon-document-new.png" format="PNG"/>
</imageobject> </inlinemediaobject> button in the toolbar of <guilabel>Course
and Keyboard Layout Editor</guilabel> window.
Andreas Nicolai's avatar
Andreas Nicolai committed
843
844
</para>
<para>
845
846
The first page of creation &i18n-ktouch; wizard allows you to choose the type of the
data. Select <guilabel>Course</guilabel> and press <guibutton>Next</guibutton>.
Andreas Nicolai's avatar
Andreas Nicolai committed
847
</para>
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
<screenshot>
<screeninfo>Choosing the type</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="create.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Choosing the type</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
The second page of wizard allows you to choose the title, the keyboard layout
and the description of the course.
</para>
<screenshot>
<screeninfo>New course wizard second page</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="create_course1.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>New course wizard second page</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
The course title is important for the quick-select menu entry in the course list
and for the statistics.
</para>
<para>
The description should be used to include information
about the lesson author and source of lesson data if any. This description can
be shown by pressing <inlinemediaobject>
<imageobject> <imagedata fileref="Icon-dialog-information.png"
format="PNG"/> </imageobject> </inlinemediaobject> button in the home screen of
&i18n-ktouch;.
</para>
<para>
When you finished with entering appropriate values press
<guibutton>Next</guibutton>.
</para>
<screenshot>
<screeninfo>New course wizard third page</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="create_course2.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>New course wizard third page</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
902
903
Using the third page of wizard you can choose an other course as a template for
your course. Select the course from the list and press
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
<guibutton>Finish</guibutton>.
</para>
<screenshot>
<screeninfo>New course editing window</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="create_course3.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>New course editing window</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
&i18n-ktouch; will open the course editor window prepared to entering your course
data.
Andreas Nicolai's avatar
Andreas Nicolai committed
920
921
922
</para>
</sect2>

923
924
925
926
927
<sect2 id="adding_lessons">
<title>Adding lessons</title>
<para>
A course is an ordered set of lessons. To be efficient for learning touch
typing the content of the course should meet a few requirements.
928
</para>
929
<variablelist>
930
<varlistentry><term><emphasis role="bold">Choose a meaningful name for the
Yuri Chornoivan's avatar
Yuri Chornoivan committed
931
lesson</emphasis></term>
932
933
934
935
936
937
938
939
940
941
942
943
944
945
<listitem>
<para>
For each level you can specify the new characters/keys in the lesson. It is
worth to include the new characters in the lesson title. Click on a name label
in the <guilabel>Lessons</guilabel> list and enter some meaningful name.
</para>
<note>
<title>Rationale</title>
<para>The text you enter as a lesson title will be shown as lesson information
text in the home screen course list. It will be much easier for user to choose
the lesson if it has a meaningful title.
</para>
</note>
</listitem>
Burkhard Lück's avatar
Burkhard Lück committed
946
</varlistentry>
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
<varlistentry><term><emphasis role="bold">The first lesson should cover the
home keys</emphasis></term>
<listitem>
<para>
Usually a keyboard has two haptic markers for the keys on the second row
belonging to the index fingers. These two keys and the three adjacent keys
outwards are the home keys. That's <emphasis>asdfjkl;</emphasis> for the US
keyboard layout.
</para>
<note>
<title>Rationale</title>
<para>Those eight keys are the start position of each
finger. One must internalize the location of these keys first to successfully
learn touch typing.
</para>
</note>
</listitem>
964
</varlistentry>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
965
<varlistentry><term><emphasis role="bold">Introduce two new keys per lesson
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
</emphasis></term>
<listitem>
<para>The unlocking order of keys is not fixed, but usually keys are introduced
in pairs belonging to the same finger on both hands. Make your way from the home
keys to the ones further away.  Thus, the forth row should be introduced at
last. Prefer keys for important characters of your language, this may require to
bend the introduction pattern a bit. For example in French accents are really
important, this warrants a lesson early-on focusing on the accent key
alone.
</para>
<note>
<title>Rationale</title>
<para>
If more keys are introduced the trainee might
get overwhelmed by the difficulty of the lesson and loose his motivation.
Yuri Chornoivan's avatar
Yuri Chornoivan committed
981
Introduce keys for important keys first to able to form real words
982
983
984
985
earlier.
</para>
</note>
</listitem>
986
</varlistentry>
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
<varlistentry><term><emphasis role="bold">Extra emphasis on the new
keys</emphasis></term>
<listitem>
<para>
Make sure the characters belonging to the newly introduced keys are the most or
at least very frequently used characters in the lesson text.
</para>
<note>
<title>Rationale</title>
<para>
If the trainee passes a lesson he should have
mastered the new keys. This is only possible if the lesson contains a
significant amount of the new characters.
</para>
</note>
</listitem>
1003
</varlistentry>
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
<varlistentry><term><emphasis role="bold">Intersperse lessons with new keys
with repetition lessons</emphasis></term>
<listitem>
<para>
Every two to three lessons add a repetition lesson
without any new keys. These should have an even character mix covering all
already introduced characters.
</para>
<note>
<title>Rationale</title>
<para>
Such lessons help to strengthen the acquired
1016
skills and provide a way to check the overall training level. They are also
1017
1018
1019
1020
1021
better suited for repeated training to further improve one's general typing
skills.
</para>
</note>
</listitem>
Burkhard Lück's avatar
Burkhard Lück committed
1022
</varlistentry>
1023
1024
1025
1026
1027
1028
<varlistentry><term><emphasis role="bold">Dedicated lessons for
capitalization</emphasis></term>
<listitem>
<para>
There should be several lessons focusing sorely on
capitalization. Ideally capitalization is introduced in multiple steps: At first
Yuri Chornoivan's avatar
Yuri Chornoivan committed
1029
only the left &Shift; key, then the right, then both and followed by one or
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
more repetition lessons.
</para>
<note>
<title>Rationale</title>
<para>
Mastering capitalization is the most difficult
part of learning touch typing. Therefore extra effort must be spend on these
lessons.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry><term><emphasis role="bold">Cover the complete keyboard
layout</emphasis></term>
<listitem>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
1045
1046
<para>This includes characters and symbols accessible via other modifiers than
&Shift;. Ideally every character, number and symbol which is printed on a real
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
keyboard should be covered.
</para>
<note>
<title>Rationale</title>
<para>
The more complete a course is the more the
trainee can learn from it. It also keeps the course interesting for already
advanced typists.
</para>
</note>
</listitem>
1058
1059
</varlistentry>
</variablelist>
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
<para>
Use <inlinemediaobject>
<imageobject> <imagedata fileref="Icon-list-add.png"
format="PNG"/> </imageobject> </inlinemediaobject> button to add new lesson to
the course, <inlinemediaobject>
<imageobject> <imagedata fileref="Icon-list-remove.png"
format="PNG"/> </imageobject> </inlinemediaobject> button to remove selected
lesson from your course and <inlinemediaobject>
<imageobject> <imagedata fileref="Icon-arrow-up.png"
format="PNG"/> </imageobject> </inlinemediaobject>/<inlinemediaobject>
<imageobject> <imagedata fileref="Icon-arrow-down.png"
format="PNG"/> </imageobject> </inlinemediaobject> buttons to rearrange the
lessons in the course.
</para>
<important>
<para>
Delete lessons only with caution. Doing so may reset the unlocking progress
of the users of the course. If you are planning to revise a course thoroughly
it is usually better to use the existing course as a base for a new one.
</para>
</important>
<para>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
1082
The content of the lesson can be edited using bottom right edit field. You can
1083
1084
1085
1086
copy snippets of the text from your favorite text editor and paste them to this
field.
</para>
<para>
Sebastian Gottfried's avatar
Sebastian Gottfried committed
1087
Use the <inlinemediaobject>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
1088
<imageobject> <imagedata fileref="Icon-document-open.png"
Sebastian Gottfried's avatar
Sebastian Gottfried committed
1089
format="PNG"/> </imageobject> </inlinemediaobject> button to open a generic text file
Sebastian Gottfried's avatar
Sebastian Gottfried committed
1090
that will be loaded into the lesson text field.
Yuri Chornoivan's avatar
Yuri Chornoivan committed
1091
1092
1093
1094
</para>
<para>
The <inlinemediaobject>
<imageobject> <imagedata fileref="Icon-format-justify-fill.png"
Yuri Chornoivan's avatar
Yuri Chornoivan committed
1095
format="PNG"/> </imageobject> </inlinemediaobject> button can be used to wrap the lesson text.
1096
&i18n-ktouch; editor wraps text such that every line of the lesson does not 
Sebastian Gottfried's avatar
Sebastian Gottfried committed
1097
exceed the recommended 60 characters limit.
Yuri Chornoivan's avatar
Yuri Chornoivan committed
1098
1099
</para>
<para>
1100
1101
1102
Let's assume you want to add a new lesson. There are a few guidelines you
may want to consider:
</para>
1103
1104

<variablelist>
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
<varlistentry><term><emphasis role="bold">Give lessons a descriptive
title</emphasis></term>
<listitem>
<para>
Name the new characters if there are any or otherwise state what the lesson is
about.
</para>
<note>
<title>Rationale</title>
<para>
Good titles make it easier to find the right
course if one wants to train on something specific.
</para>
</note>
</listitem>
1120
</varlistentry>
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
<varlistentry><term><emphasis role="bold">The lesson text should be composed
out of real words and sentences</emphasis></term>
<listitem>
<para>
Optimally a lesson forms a comprehensible contiguous text on a freely chosen
subject.
</para>
<note>
<title>Rationale</title>
<para>Training with real words and sentences is more
effective than with arbitrary random character combinations since that is closer
to real typing. And it is more fun.
</para>
</note>
</listitem>
1136
</varlistentry>
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
<varlistentry><term><emphasis role="bold">Avoid non-word character
combinations</emphasis></term>
<listitem>
<para>
This may impossible in the very first lessons where only a few
characters are available, but as soon as possible only real words should be
used. Never use misspelled words.
</para>
<note>
<title>Rationale</title>
<para>
Random character combinations are hard to type and are seldom found in
day-to-day typing. Misspelled words on the other hand are confusing and have
even a negative learning value, since the trainee may memorize the wrong
spelling.
</para>
</note>
</listitem>
1155
</varlistentry>
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
<varlistentry><term><emphasis role="bold">Lesson text should be roughly 600
characters long</emphasis></term>
<listitem>
<para>
They may be longer, up to 1200 characters is okay, but shorter
lessons should be avoided. This is especially true for repetition
lessons.
</para>
<note>
<title>Rationale</title>
<para>
Keeping within this range ensures that a untrained
typist (~120 characters per minute) can finish a lesson in five to ten minutes.
Longer lessons get frustrating, shorter ones are ineffective.
</para>
</note>
</listitem>
1173
1174
1175
</varlistentry>
</variablelist>

1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
<sect3 id="quality_checks">
<title>Quality checks in the lesson text editor</title>
<screenshot>
<screeninfo>Quality check in the course editing window</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="quality_check.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Quality check in the course editing window</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
Above is a screenshot of the course editor with one of a problematic lesson
loaded showing one of the built-in quality-assurance checks: if a lesson
contains characters not available in that lesson, because they are not among the
configured new characters of this lesson or any previous one, they are
highlighted in red. There is also a check for too long lines resulting in a
1195
muted color for the characters behind the allowed column.
1196
1197
</para>
<para>
Yuri Chornoivan's avatar
Yuri Chornoivan committed
1198
On the left side there is a list over all data files &i18n-ktouch; knows about,
1199
1200
1201
1202
1203
built-in and user-created alike. If the user selects a built-in resource the
editor will degrade to a simple viewer, though. If the user selects a keyboard
layout the program will adapt appropriately.
</para>
</sect3>
1204
</sect2>
1205
</sect1>
1206

1207
1208
1209
<sect1 id="create_layouts">
<title>Creating keyboard layouts</title>
<para>You can create your own keyboard layouts using built-in &i18n-ktouch; editor.
1210
Usually it's best is to start with an existing layout close to the keyboard layout
1211
1212
you want to create, and use that as a base for own layout. That way you can avoid a
lot of work.</para>
1213

1214
1215
1216
<sect2 id="layout_properties">
<title>Keyboard layout properties</title>
<para>
1217
The keyboard layout properties can be chosen using &i18n-ktouch; keyboard layout creation
1218
wizard. To invoke this wizard you should press <inlinemediaobject>
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
<imageobject> <imagedata fileref="Icon-document-new.png" format="PNG"/>
</imageobject> </inlinemediaobject> button in the toolbar of <guilabel>Course
and Keyboard Layout Editor</guilabel> window.
</para>
<para>
The first page of creation &i18n-ktouch; wizard allows you to choose the type of the
data. Select <guilabel>Keyboard layout</guilabel> and press
<guibutton>Next</guibutton>.
</para>
<screenshot>
<screeninfo>Choosing the type</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="create.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Choosing the type</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
The second page of wizard allows you to choose the title and the name of the
layout.
</para>
<screenshot>
<screeninfo>New layout wizard second page</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="create_layout1.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>New layout wizard second page</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
The layout title is important for the quick-select menu entry in the layout list
of <link linkend="ktouch_menu">&i18n-ktouch; configuration menu</link> and for the
statistics.
</para>
<para>
The layout name will be used as a name of the layout by &i18n-ktouch; internally.
</para>
<screenshot>
<screeninfo>New layout wizard third page</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="create_layout2.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>New layout wizard third page</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
Using the third page of wizard you can choose other layout as a template for
1275
your layout. Select the course from the list and press
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
<guibutton>Finish</guibutton>.
</para>
<screenshot>
<screeninfo>New layout editing window</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="create_layout3.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>New layout editing window</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
1290
1291
&i18n-ktouch; will open the editor window prepared to entering your keyboard
layout data.
1292
1293
</para>
</sect2>
1294

1295
1296
1297
1298
1299
1300
1301
1302
1303
<sect2 id="adding_keys">
<title>Adding keys</title>
<para>
Use <inlinemediaobject>
<imageobject> <imagedata fileref="Icon-list-add.png"
format="PNG"/> </imageobject> </inlinemediaobject> <guilabel>Normal
Key</guilabel> button to add new normal key or <inlinemediaobject> <imageobject>
<imagedata fileref="Icon-list-add.png"
format="PNG"/> </imageobject> </inlinemediaobject> <guilabel>Special
1304
Key</guilabel> button to add new special key (modifier keys, <keycap>Space</keycap>,
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
&Backspace;, &Tab;, <keycap>Caps Lock</keycap> or &Enter;) to the layout.
The <inlinemediaobject>
<imageobject> <imagedata fileref="Icon-edit-delete.png"
format="PNG"/> </imageobject> </inlinemediaobject><guilabel>Delete</guilabel>
button can be used to remove a selected key from your layout. The scale can be
changed using the slider at the left part of the editor toolbar.
</para>
<para>
The properties of individual keys can be edited using the bottom pane of the
editor window.
</para>
<sect3 id="normal_keys">
<title>Normal keys</title>
<para>
It is easy to change the size or properties of a key.
</para>
<para>
Begin by clicking on the key you want to change. This selects the clicked key as
the current key.
</para>
<para>
1326
There are now 4 squares on the corners of the key. By dragging these squares, you
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
will be able to drag the key border to a new location. Dragging the whole key
allows you to change the key position in the layout.
</para>
<para>
The numerical characteristics of the key geometry can also be changed using the
<guilabel>Geometry</guilabel> section of the pane at the bottom of the editor
window.
</para>
<screenshot>
<screeninfo>Editing an individual key properties</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="key_editing.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Editing an individual key properties</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
The bottom pane can also be used to choose finger to press the key and switch
the haptic marker for the key.
</para>
<sect4 id="key_characters">
<title>Key characters</title>
<para>
The characters that will be shown on a key can be changed using the <guilabel>
Characters</guilabel> section of the editor bottom pane.
</para>
<screenshot>
<screeninfo>Editing the character position</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="character_editing.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Editing the character position</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
You can add a character by pressing <inlinemediaobject>
<imageobject> <imagedata fileref="Icon-list-add.png"
format="PNG"/> </imageobject> </inlinemediaobject> button. A selected character
can be removed by pressing <inlinemediaobject>
<imageobject> <imagedata fileref="Icon-list-remove.png"
format="PNG"/> </imageobject> </inlinemediaobject> button.
</para>
<para>
You can also select the position of individual characters on the key by
double-clicking in the <guilabel>Position</guilabel> column.
</para>
</sect4>
</sect3>
<sect3 id="modifier_keys">
<title>Modifiers</title>
<para>
There are several modifier keys that can be defined in &i18n-ktouch;. They can be
edited as normal keys but it is helpful to know identifier of modifier key to
use them as appropriate. The table of modifier keys identifiers is given below.
</para>
<table>
<title>Modifier keys</title>
<tgroup cols="2">
<thead>
<row>
<entry>Modifier key</entry>
<entry>Modifier id in &i18n-ktouch;</entry>
</row>
</thead>
<tbody>
<row>
<entry>&Alt;</entry>
<entry><literal>altgr</literal></entry>
</row>
<row>
<entry>&Shift;</entry>
<entry><literal>left_shift</literal> or <literal>right_shift</literal></entry>
</row>
</tbody>
</tgroup>
</table>
</sect3>
1410
</sect2>
1411
</sect1>
1412

1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
<sect1 id="custom_lessons">
<title>Custom Lessons</title>
<para>
The custom lessons feature allows you to extend your training material in 
an easy way by choosing some arbitrary text.
</para>
<para>
The custom lessons are gathered in a special course, the <guilabel>Custom 
Lessons</guilabel> course, always available right next to <link 
linkend="picking_a_lesson">the normal built-in courses</link>.
</para>
<screenshot>
<screeninfo>Custom lessons course</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="custom-lessons.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Custom lessons course</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
This special course mostly acts like any other, training and statistics 
1437
1438
gathering works as usual. Clicking on <guibutton>Add New 
Lesson</guibutton> or the <guibutton>Edit</guibutton> button (the pencil icon for 
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
existing lessons) brings up a stripped-down version of <link 
linkend="adding_lessons">the normal lesson editor</link>.
</para>
<screenshot>
<screeninfo>Custom lesson editor</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="custom-lessons-edit.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Custom lesson editor</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
1454
The editor will highlight problematic sections of your lesson texts. Characters which can't by typed on your keyboard layout will be shown on a dark red background, lines which are considered to be too long use a pink background for the excess characters. &i18n-ktouch; requires that every line of the 
Sebastian Gottfried's avatar
Sebastian Gottfried committed
1455
lesson does not exceed the recommended 60 characters limit.
1456
1457
</para>
<para>
1458
Use the <guibutton>Done</guibutton> button to confirm your edits or close the editor window to cancel them.
1459
</para>
Sebastian Gottfried's avatar
Sebastian Gottfried committed
1460
1461
1462
1463
1464
<tip>
<para>
All custom lessons are stored per profile and keyboard layout individually. Use this to manage different sets of lessons depending on the specific training situation.
</para>
</tip>
1465
1466
</sect1>

1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
<sect1 id="sharing_your_results">
<title>Sharing your results</title>
<para>
It is possible to save your courses and keyboard layouts in separate files
outside of the local &i18n-ktouch; database.
</para>
<sect2 id="export_import">
<title>Export/Import</title>
<para>
To export a course or keyboard layout in a separate file choose the
corresponding item in the list at the left part of <guilabel>Course and Keyboard
Layout Editor</guilabel> window and press <guibutton>Export</guibutton> button
in the toolbar.
</para>
<para>
&i18n-ktouch; will open a standard &kde; save dialog. Description of this dialog in
details can be found in the <ulink url="help:/fundamentals/files.html"
>Opening and Saving Files</ulink> chapter of the &kde; Fundamentals.
</para>
<para>
You can choose the name and the location of the &XML; file to be saved.
</para>
<para>
If you find it worth to share your files with over users, please send them
with some description to <ulink url="mailto:kde-edu@kde.org">kde-edu mailing
list</ulink>.
</para>
<important>
<para>
Your data should be licensed under <ulink
1497
url="https://www.gnu.org/licenses/gpl-2.0.html">GNU General Public License,
1498
1499
1500
1501
1502
1503
1504
1505
version 2</ulink> to include them into the default &i18n-ktouch; installation.
</para>
</important>
<para>
To import your data files into &i18n-ktouch; press <guibutton>Import</guibutton>
button in the toolbar and choose &XML; file that was earlier exported using
&i18n-ktouch;.
</para>
1506
1507
1508
</sect2>
</sect1>
</chapter>
1509
1510

<chapter id="credits">
Håvard Frøiland's avatar
Håvard Frøiland committed
1511

1512
<title>Credits and License</title>
1513
<para>&i18n-ktouch;</para>
Anne-Marie Mahfouf's avatar
Anne-Marie Mahfouf committed
1514
<para>
1515
&i18n-ktouch;, Copyright 1999-2007 by</para>
1516
<itemizedlist>
1517
1518
<listitem><simpara>Håvard Frøiland
&Haavard.Froeiland.mail;</simpara></listitem>
1519
1520
<listitem><simpara>Andreas Nicolai <email>andreas.nicolai@gmx DOT
net</email></simpara></listitem>
1521
</itemizedlist>
Yuri Chornoivan's avatar