/usr/share/doc/kde/HTML/en/ktouch/index.docbook is in ktouch-data 4:4.8.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 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 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 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 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 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 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 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 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 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 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 | <?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
"dtd/kdex.dtd" [
<!ENTITY kappname "&ktouch;"><!-- replace kapp here -->
<!ENTITY package "kdeedu">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE"><!-- change language only here -->
]>
<book lang="&language;">
<bookinfo>
<title>The &ktouch; Handbook</title>
<authorgroup>
<author>
<firstname>Håvard</firstname><surname>Frøiland</surname>
<affiliation>
<address>&Haavard.Froeiland.mail;</address>
</affiliation>
</author>
<author>
<firstname>Andreas</firstname><surname>Nicolai</surname>
<affiliation>
<address><email>Andreas.nicolai@gmx.net</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<copyright>
<year>1999-2007</year>
<holder>Håvard Frøiland, Andreas Nicolai</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
<date>2008-08-23</date>
<releaseinfo>1.7.1</releaseinfo>
<abstract>
<para>&ktouch; is a program for learning to touch type. &ktouch;
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
and the correct finger to use.</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>touchwriting</keyword>
<keyword>touchtyping</keyword>
<keyword>typing</keyword>
<keyword>typewriting</keyword>
<keyword>education</keyword>
<keyword>ktouch</keyword>
<keyword>touch</keyword>
<keyword>type</keyword>
</keywordset>
</bookinfo>
<chapter id="using_ktouch">
<title>Using &ktouch;</title>
<sect1 id="introduction">
<title>Introduction</title>
<sect2>
<title>What is &ktouch;?</title>
<para>&ktouch; is a program for learning to touch type.</para>
<para>&ktouch; provides you with text to train on and adjusts to
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>
<screenshot>
<screeninfo>The main screen of &ktouch;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="main_screen_default_color.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>The main screen of &ktouch;</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>&ktouch; is an excellent touch typing tutor. You learn typing
with all fingers, step by step, without having to look down
at the keyboard all the time to find your keys (which slows you down a lot).
It is convenient for all ages
and the perfect typing tutor for schools, universities and individuals.
It is free and licensed under the &GNU; Public License, so you will
never have to pay anything for the program or any update.
</para>
</sect2>
<sect2>
<title>Features </title>
<para>In its current version, &ktouch; 1.7.1 has quite a number of helpful
features, such as:</para>
<itemizedlist>
<listitem><simpara>Support for many different training lectures in many
languages including language specific text fonts and a comfortable lecture
editor</simpara></listitem>
<listitem><simpara>Support for different keyboard layouts with the ability to
use user-defined layouts</simpara></listitem>
<listitem><simpara>During your training session comprehensive statistical
information is obtained to help you (or your teacher) analyse your
progress</simpara></listitem>
</itemizedlist>
<para>
Many other features are included and will be discussed in the appropriate
chapters of this manual.
</para>
</sect2>
</sect1>
<sect1 id="learning">
<title>Learning touch typing with &ktouch;</title>
<para>Here's another screenshot of &ktouch; in action, this time with a german
keyboard and training lecture:</para>
<screenshot>
<screeninfo>Main screen of &ktouch;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="main_window_german.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Main screen of &ktouch;</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>Even though learning touch typing with &ktouch; and using the program
should be very simple we will look a bit closer at &ktouch; in the following
sections.</para>
<sect2 id="getting_started">
<title>Getting started</title>
<para>When you start &ktouch; you can see the screen shown above. The main
program window shows three main sections:
</para>
<orderedlist>
<listitem><simpara>Some typing statistics in info boxes at the
top</simpara></listitem>
<listitem><simpara>The text you need to type (in the teacher's line) and the
text that you have typed so far (in the student's line)</simpara></listitem>
<listitem><simpara>The keyboard (that hopefully looks like
yours)</simpara></listitem>
</orderedlist>
<para>We look at these sections later again.</para>
<para>
Ok, the first time you start &ktouch; it will open a lecture and
select a keyboard layout for the locale and keyboard defined in the &systemsettings;.
To adjust the keyboard layout go to
<menuchoice><guimenu>Settings</guimenu><guisubmenu>Keyboard
Layouts...</guisubmenu></menuchoice> and select the country you're in (or
some country which uses the same keyboard layout as you). If your keyboard is
not included, you can always define your own keyboard (see <link
linkend="create_keyboards">Creating your own keyboard</link>).
</para>
<para>
Once you have your keyboard selected, choose your training lecture. The first
line in your current lecture and level is shown in the teacher's line. You can
select any of the default lectures via
<menuchoice><guimenu>Training</guimenu><guisubmenu>Default
Lectures</guisubmenu></menuchoice> or open a user defined lecture file
(⪚ if your teacher gives you a special lecture to practice on) with
<menuchoice><guimenu>File</guimenu><guimenuitem>Open
Lecture...</guimenuitem></menuchoice>. You may even create your own lecture
(see <link linkend="create_lectures">Creating your own lecture</link>). When
you have selected keyboard and lecture you can start typing.
</para>
<para>
Place your hand on the keyboard as indicated by the 8 marked finger keys
(thumbs over the space bar) and start typing the text shown in the teacher's
line. Each key you need to press is highlighted on the keyboard and if you
need to move a finger from its resting position the target key and the
appropriate finger key is highlighted. Try to move your hands as little as
possible and after you typed a character always try to return your fingers to
their resting positions.
</para>
<tip><para>The key colors indicate which finger needs to press which
key.</para></tip>
<para>
While you type you may make mistakes and hit the wrong key. In that case the
student's line will change its color (per default to red) and you have to hit
Backspace to erase the wrong character (or characters) again.
</para>
<para>
When you have successfully completed a line of text you need to press the
&Enter; key to advance to the next line.
</para>
</sect2>
<sect2 id="lectures_and_levels">
<title>Lectures and levels</title>
<para>
As already mentioned above you need to select a training lecture which
contains all the text you want to practice. Usually the difficulty of the text
is gradually increasing and so most lectures contain various difficulty
levels. However, some lectures may just contain a single level and text (⪚
a newspaper article to test your skills).
</para>
<para>
In the info boxes on top of the &ktouch; main window you see the current
level on the left. The small buttons to the right allow you to manually switch
levels. Normally this happens automatically (more about this in the section
<link linkend="training_options">Training Options</link>). The right info box
shows a brief information text about the level. Usually it gives you a list of
characters that are new in this level. The middle two info boxes show your
current typing speed (in characters per minute) and your correctness. These
values are Level Statistics and whenever you start a new level these values
are reset. However, the program still remembers your previous statistics
(see section <link linkend="statistics">Statistics in &ktouch;</link>).
</para>
</sect2>
<sect2 id="starting_stopping">
<title>Starting and stopping a training session</title>
<para>
While you type the text of a training lecture you are in a practice session.
You can start a new practice session using
<menuchoice><guimenu>Training</guimenu><guimenuitem>Start New
Session</guimenuitem></menuchoice> or the appropriate button in the toolbar.
Level changes (automatic or manual) do not change your training session. You
stay in this training session until you start a new training session, select a
new lecture (which automatically starts a new training session) or quit the
program.
</para>
<para>
If you open any dialog in &ktouch; while you are in a training session the
training is paused and the timer is stopped until you hit the next key. You
can manually pause the session using
<menuchoice><guimenu>Training</guimenu><guimenuitem>Pause
Session</guimenuitem></menuchoice> or the appropriate button in the toolbar.
</para>
</sect2>
</sect1>
<sect1 id="statistics">
<title>Statistics in &ktouch;</title>
<para>&ktouch; remembers you! Basically whatever you type is recorded and some
useful (and sometimes just interesting) statistics are created. &ktouch;
stores statistical data based on the lecture file you use for training. For
every lecture file a separate history is kept. &ktouch; also distinguishes
between level and practice session statistics. This is important to prevent
cheating :-).
</para>
<sect2>
<title>Training Session Statistics</title>
<screenshot>
<screeninfo>Current Training Statistics</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="statistics_dialog.png"
format="PNG"/></imageobject>
<textobject><phrase>Current Training Statistics</phrase></textobject>
</mediaobject>
</screenshot>
<para>Whenever you start a new training session a new statistics record is
started. &ktouch; remembers several things to assess your skill and to help
you identify problem keys:
</para>
<itemizedlist>
<listitem><simpara>How many keys were pressed in total?</simpara></listitem>
<listitem><simpara>How many were correctly pressed?</simpara></listitem>
<listitem><simpara>Which keys where missed and how often?</simpara></listitem>
<listitem><simpara>How many correct words did you type?</simpara></listitem>
<listitem><simpara>How much time did you need?</simpara></listitem>
</itemizedlist>
<para>Using training session statistics you and &ktouch; can evaluate your
overall performance and skill in a certain training lecture.</para>
</sect2>
<sect2>
<title>Level Statistics</title>
<para>For each level in your training session (&ie; all levels you typed text
in) the same statistics as for the training session are obtained. Using level
statistics data you can investigate your progress in each level of a training
lecture (and you will notice how your skill increases level by level and you
can concentrate on the levels which still cause problems).
</para>
</sect2>
<sect2>
<title>The Statistics Dialog</title>
<para><menuchoice><guimenu>Training</guimenu><guimenuitem>Lecture
Statistics</guimenuitem></menuchoice> or the statistics button in the toolbar
opens the statistics dialog. It displays your current training and level
statistics and shows a graphical history of previous training sessions.
</para>
<para>
When you open the statistics dialog you can select a <guilabel>Current Training
Session</guilabel> statistics page and a <guilabel>Current Level Statistics</guilabel>
page. The first page gives you a summary about everything you typed so far.
The <guilabel>Current Level Statistics</guilabel> page only contains the stats
for the current level. This is useful to distinguish between overall
performance and skill in certain levels.
</para>
<para>
The third statistics page gives you a graphical overview of your typing skill
by offering several choices. A note about the time scaling option. Whenever a
session or level statistic is obtained, also the date is stored. So you can
also see how your skill dropped in long training breaks and when you last
practiced a certain lecture or level.
</para>
<screenshot>
<screeninfo>Training Statistics Chart</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="statistics_dialog_chart.png"
format="PNG"/></imageobject>
<textobject><phrase>Training Statistics Chart</phrase></textobject>
</mediaobject>
</screenshot>
</sect2>
</sect1>
</chapter>
<chapter id="ui_guide">
<title>The &ktouch; main menu and program dialogs</title>
<para>In this chapter we look at some of the details in the program.
<tip><para>You can use the <quote>What's this?</quote> feature (the little
question mark besides the minimize/maximize window buttons) in many dialogs of
the program.</para></tip>
</para>
<sect1 id="main_menu">
<title>The menu of &ktouch;</title>
<para>Pretty much everything in the &ktouch; menu should be self-explanatory.
The <guimenu>File</guimenu> menu contains options to load a user defined lecture
and edit lectures. The <guimenu>Training</guimenu> menu contains training
options and the <guimenu>Settings</guimenu> menu
contains options to setup the program. The various options in the
configuration dialog are explained in the next section.</para>
</sect1>
<sect1 id="program_settings">
<title>Configuration options for &ktouch;</title>
<para>You can customize &ktouch; quite a bit. The settings are always stored
for the current user of the program. Open the configuration dialog via
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &ktouch;
...</guimenuitem></menuchoice></para>
<sect2 id="general_options">
<title>General Options</title>
<para>In this dialog you can change general options that control the behaviour
of &ktouch;.
</para>
<screenshot>
<screeninfo>General options</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="general_options.png"
format="PNG"/></imageobject>
<textobject><phrase>General options</phrase></textobject>
</mediaobject>
</screenshot>
<para>First of all you can switch the sound on or off (might be useful in
class rooms). You can also set the sliding speed of the teacher's and
student's line.
</para>
<para>Most important, however, might be the selection of the lecture font.
When showing the teacher's text &ktouch; will normally use the font specified
in the lecture file. But if this font doesn't exist on your system or none has
been specified, &ktouch; uses a default system font. What if this font does
not contain all characters needed for your lecture? In such cases you can
override the choice of the font and specify any font you like.
<note><para>&ktouch; distinguishes between lecture and keyboard fonts.
Overriding the lecture font does not automatically adjust the keyboard font as
well. Use the appropriate option in the Keyboard Options configuration
page.</para></note>
</para>
</sect2>
<sect2 id="training_options">
<title>Training Options</title>
<para>In this dialog you can select the options that control how &ktouch;
changes difficulty levels based on the user's skill.</para>
<screenshot>
<screeninfo>Training options</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="training_options.png"
format="PNG"/></imageobject>
<textobject><phrase>Training options</phrase></textobject>
</mediaobject>
</screenshot>
<para>If <guilabel>Automatic level adjustment</guilabel> is enabled,
&ktouch; checks the given limits at the end of each level and decides whether to
increase or decrease the level or stay in the level for another run. Level
changes occur always at the end of a level (&ie; when the user has finished the
last line of a level). If the typing speed (in characters per minute) and
accuracy (correctness) are <emphasis>both</emphasis> above or equal to the
<guilabel>Limits to increase a level</guilabel> &ktouch; will jump to the next higher
level. If <emphasis>either</emphasis> typing speed or accuracy falls below the
<guilabel>Limits to decrease a level</guilabel> &ktouch; will jump back to the
previous lower level.
</para>
<para>
On this configuration page you can also select that the program remembers your
current level when you quit the program and jumps back to it when you restart
&ktouch;.
</para>
</sect2>
<sect2 id="keyboard_options">
<title>Keyboard Settings</title>
<para>In this dialog you can select keyboard specific options.</para>
<screenshot>
<screeninfo>Keyboard settings</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="keyboard_options.png"
format="PNG"/></imageobject>
<textobject><phrase>Keyboard settings</phrase></textobject>
</mediaobject>
</screenshot>
<para>
This dialog controls the appearance and functionality of the keyboard. Similar
to the <guilabel>Override lecture font</guilabel> option in the <guilabel>General Options</guilabel>
configuration page, you can here specify your own keyboard font. The option
<guilabel>Highlight keys on keyboard</guilabel> can be used to decrease the
difficulty of the training. <tip><para>Once you are familiar with the keyboard
you may want to turn keyboard highlighting off so it won't distract you when
you concentrate on the teacher's text.</para></tip>
</para>
</sect2>
<sect2 id="color_options">
<title>Color Settings</title>
<para>In this dialog you can tweak the colors used by &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 text and background color for teacher's line, typing line and on miss typing.
</para>
</sect2>
<sect2 id="sound_options">
<title>Sound Settings</title>
<para>In this dialog you can tweak the sound options for &ktouch;.</para>
<screenshot>
<screeninfo>Sound settings</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="sound_options.png"
format="PNG"/></imageobject>
<textobject><phrase>Sound settings</phrase></textobject>
</mediaobject>
</screenshot>
<para>
Enable or disable <guilabel>Beep on error</guilabel>, <guilabel>Typewriter sound when typing</guilabel> or <guilabel>Sound on automatic level change</guilabel>.
</para>
</sect2>
</sect1>
</chapter>
<chapter id="extending">
<title>Extending &ktouch;</title>
<sect1 id="create_lectures">
<title>Creating your own lecture</title>
<para>You can easily create your own training lecture using the built-in
&ktouch; lecture editor. When you select
<menuchoice><guimenu>File</guimenu><guimenuitem>Edit
Lecture...</guimenuitem></menuchoice> the <guilabel>Open Lecture File</guilabel>
dialog will open and ask you to select a lecture. You can choose either edit the
current lecture, any of the predefined lectures (if you have write access to
the installation directory), open a lecture file or create an empty lecture from scratch.</para>
<sect2>
<title>Creating a lecture</title>
<para>
Let's assume you want to create a new lecture. There are a few guidelines you
may want to consider:
</para>
<itemizedlist>
<listitem><para>
For the first 20 keys or so, only add 2 keys at a time to a new level. Let the
user practice the keys alone first in different combinations and then use the
new keys in words and mixed with already known words.
</para></listitem>
<listitem><para>Add at least a few levels to the lecture in order to allow the
user to see some progress while training</para></listitem>
<listitem><para>
Don't make the levels too long.
</para></listitem>
<listitem><para>
Try to increase the difficulty of the text gradually and test your text
yourself.
</para></listitem>
<listitem><para>
After the first keys have been learned include a recap lecture.
</para></listitem>
</itemizedlist>
</sect2>
<sect2>
<title>Things to know about lectures</title>
<para>
The lecture title is important for the quick-select menu entry in the training
menu and for the statistics. The comment should be used to include information
about the lecture author and source of lecture data if any.
</para>
<para>
For each level you can specify the new characters/keys in the lecture. The
text you enter there will be shown as level information text in the top right
info box of the &ktouch; main window.
</para>
<para>You can also specify a default font for the lecture which will be used
in the teacher's and student's line and of course in the edit lecture dialog
using the <guiicon>Font</guiicon> icon.
</para>
</sect2>
</sect1>
<sect1 id="create_keyboards">
<title>Creating your own keyboard</title>
<para>You can create your own keyboards by creating keyboard files. Currently
&ktouch; doesn't have a keyboard editor but it is still pretty easy to define
your own keyboard. It doesn't require much more than a little math to work out
the geometry and some time. Best is to start with an existing keyboard file,
create a copy for your keyboard layout and simply adjust the lines.</para>
<para>
Currently keyboard files are plain UTF-8 encoded text files. In one of the
next version of &ktouch; keyboard data will be stored in &XML; files, too.
Therefore I'll only briefly explain the structure of a keyboard file.
</para>
<para>A keyboard file usually starts with a header including some information
about the author and type of the keyboard.</para>
<programlisting>
####################################################
# &ktouch;
# Keyboard layout file for german keyboard layout
# Code=UTF-8
####################################################
</programlisting>
<para>
All lines starting with a hash character '#' are considered comments. After
the header section a block of so called <quote>finger keys</quote> follows,
indicating the resting positions for all 8 fingers.
</para>
<programlisting>
#
# Unicode KeyChar x y
#
FingerKey 97 A 18 20
FingerKey 115 S 28 20
FingerKey 100 D 38 20
FingerKey 102 F 48 20
FingerKey 106 J 78 20
FingerKey 107 K 88 20
FingerKey 108 L 98 20
FingerKey 246 Ö 108 20
</programlisting>
<para>Keys have the default dimensions of 8 units, so using a grid of 10 units
gives a normal looking keyboard. The first number is the unicode character
code as decimal number. The KeyText is the text printed on the key encoded as
UTF-8 (automatic under newer &Linux; versions, just make sure your editor saves
files as UTF-8 format).</para>
<para>The next section contains special keys, which are - apart from BackSpace
and Enter - just decorative.</para>
<programlisting>
#
# Unicode KeyText x y Width Height
#
ControlKey 260 Tab 0 10 15 10
ControlKey 13 Enter 138 20 12 10
ControlKey 258 Shift 123 30 27 10
ControlKey 264 AltGr 120 40 15 10
ControlKey 265 Ctrl 135 40 15 10
ControlKey 263 Alt 15 40 15 10
ControlKey 262 Strg 0 40 15 10
ControlKey 32 Leertaste 30 40 90 10
ControlKey 257 Shift 0 30 13 10
ControlKey 259 CapsLock 0 20 18 10
ControlKey 8 BackSpace 130 0 20 10
</programlisting>
<para>
The text you specify for the key is printed completely on the keyboard.
However, for the keytexts <quote>Shift</quote>, <quote>CapsLock</quote>,
<quote>Tab</quote>, <quote>BackSpace</quote> and <quote>Enter</quote> &ktouch;
draws the appropriate symbols. Hence you can use these keytexts regardless of
the language. The other keytexts like Ctrl or Alt need to be translated
though. The geometry of the control keys can be any rectangle, defined by
upper left x and y coordinates and width and height.</para>
<para>The next section contains all characters on the keyboard (except the
already defined finger keys) that can be typed <emphasis>without</emphasis>
pressing shift.</para>
<programlisting>
#
# Unicode KeyChar x y FingerKeyUnicode
#
NormalKey 94 ^ 0 0 97
NormalKey 49 1 10 0 97
NormalKey 50 2 20 0 115
NormalKey 51 3 30 0 100
NormalKey 52 4 40 0 102
NormalKey 53 5 50 0 102
NormalKey 54 6 60 0 102
.
.
.
NormalKey 46 . 103 30 108
NormalKey 45 - 113 30 246
</programlisting>
<para>The definition of these primary keys or chars is pretty much the same as
for the finger keys, but they include an additional property. The last unicode
character code identifies the associated finger key. Basically which finger
has to be used to press this key.</para>
<para>
The next and last section in a keyboard layout defines all keys that are
pressed by using a modifier key such as the shift key.
</para>
<programlisting>
#
# Unicode TargetUnicode FingerUnicode ControllUnicode
Comment
#
HiddenKey 65 97 97 258 #A
HiddenKey 66 98 102 258 #B
HiddenKey 67 99 100 258 #C
HiddenKey 68 100 100 258 #D
.
.
.
HiddenKey 124 60 97 264 #|
HiddenKey 64 113 97 264 #@
</programlisting>
<para>The <quote>hidden keys</quote> are really controlling what should happen
on the keyboard when you type a certain character. The first unicode number is
the character code of the character you define. The second number is the
character code of the key on the keyboard (one of the already defined normal
keys). The third number indicates a finger key (where does the finger rest
that is needed to type the key) and the last number indicates the modifier key
you need to press to get this character.
</para>
<para>Let's look at an example:</para>
<para>You want to define the uppercase 'R' character. It has the unicode 82.
The character obtained when the 'R' key is pressed without modifier is the
small 'r' with the unicode 114. The finger for the 'R' rests over the 'f' key
which has the unicode 102. And in order to get the 'R' you need to press the
right (or left) shift key which has the code 264 (this is actually not a
unicode but the code obtained from a keypress event of QT). Note that the
identification of controll keys will likely change in the next version of
&ktouch;. But for now you can use the codes used in other keyboard files.
</para>
</sect1>
</chapter>
<chapter id="commands">
<title>Command Reference</title>
<sect1 id="ktouch-mainwindow">
<title>Menus and shortcut keys</title>
<sect2>
<title>The <guimenu>File</guimenu> Menu</title>
<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Open Plain Text File...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Open</action> a plain text file and use it as lecture.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Open Lecture...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Open</action> a new training lecture
file</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Edit Lecture...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Open</action> the lecture editor to allow you to
change the current training file </para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Edit Color Scheme...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Open</action> the color scheme editor to allow you to
define new color schemes</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Edit Keyboard Layout...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Open</action> a keyboard file and edit a keyboard layout in the
<guilabel>&ktouch; Keyboard Editor</guilabel> dialog.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice></term>
<listitem><para><action>Quit</action> &ktouch;</para></listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2>
<title>The <guimenu>Training</guimenu> Menu</title>
<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Training</guimenu>
<guimenuitem>Start New Session</guimenuitem>
</menuchoice></term>
<listitem><para><action>Start</action> a new typing session and ask you if you
want to start at the same level</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Training</guimenu>
<guimenuitem>Pause Session</guimenuitem>
</menuchoice></term>
<listitem><para><action>Pause</action> the current session: statistics are on
hold</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Training</guimenu>
<guimenuitem>Lecture Statistics</guimenuitem>
</menuchoice></term>
<listitem><para><action>Open</action> the current session statistics
dialog</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Training</guimenu>
<guisubmenu>Default Lectures</guisubmenu>
<guimenuitem>English (auto-generated)</guimenuitem>
</menuchoice></term>
<listitem><para><action>Choose</action> what language you want to learn touch
typing in</para></listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2>
<title>The <guimenu>Settings</guimenu> Menu</title>
<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Show Toolbar</guimenuitem>
</menuchoice></term>
<listitem><para><action>Toggle</action> the toolbar</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Show Statusbar</guimenuitem>
</menuchoice></term>
<listitem><para><action>Toggle</action> the statusbar</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guisubmenu>Keyboard Layouts</guisubmenu>
<!--guimenuitem>Keypad/Number block</guimenuitem-->
</menuchoice></term>
<listitem><para>This item <action>displays</action> a list of available the keyboard layout
where you can choose the layout you want to use.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guisubmenu>Keyboards Color Schemes</guisubmenu>
<guimenuitem>Black & White</guimenuitem>
</menuchoice></term>
<listitem><para><action>Choose</action> the keyboard color layout in black in
white: all keys are white and the one you should type is
black</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guisubmenu>Keyboards Color Schemes</guisubmenu>
<guimenuitem>Classic</guimenuitem>
</menuchoice></term>
<listitem><para><action>Choose</action> the classic keyboard color layout:
each column of keys has a different color</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guisubmenu>Keyboards Color Schemes</guisubmenu>
<guimenuitem>Deep Blue</guimenuitem>
</menuchoice></term>
<listitem><para><action>Choose</action> the deep blue keyboard color layout:
each column of keys has a different color in a shade of blue</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guisubmenu>Keyboards Color Schemes</guisubmenu>
<guimenuitem>Stripy</guimenuitem>
</menuchoice></term>
<listitem><para><action>Choose</action> the stripy keyboard color layout: in
blue and grey</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guisubmenu>Current User</guisubmenu>
<guimenuitem>Default User</guimenuitem>
</menuchoice></term>
<listitem><para><action>Choose</action> the user for the current training sessions.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Setup Users...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Displays</action> a dialog to add or remove a user for &ktouch;.
The users listed in this dialog are displayed in the <guisubmenu>Current User</guisubmenu> submenu.</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Shortcuts...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Configure</action> the shortcuts you want to associate
with some actions
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure Toolbars...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Configure</action> the items you want to put in the
toolbar
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure &ktouch;...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Display</action> the &ktouch; settings dialog
</para></listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2>
<title>The <guimenu>Help</guimenu> Menu</title>
&help.menu.documentation;
</sect2>
</sect1>
</chapter>
<chapter id="credits">
<title>Credits and License</title>
<para>&ktouch;</para>
<para>
&ktouch;, Copyright 1999-2007 by</para>
<itemizedlist>
<listitem><simpara>Håvard Frøiland &Haavard.Froeiland.mail;</simpara></listitem>
<listitem><simpara>Andreas Nicolai <email>andreas.nicolai@gmx DOT
net</email></simpara></listitem>
</itemizedlist>
<para> Contributors:</para>
<itemizedlist>
<listitem><simpara>Frank Quotschalla, German keyboard and German training file and
translation.</simpara></listitem>
<listitem><simpara>Ernesto Hernández-Novich, Latin American
keyboard</simpara></listitem>
<listitem><simpara>João Miguel Neves, Portuguese keyboard</simpara></listitem>
<listitem><simpara>Henri Girard, French keyboard</simpara></listitem>
</itemizedlist>
<para><emphasis>Special thanks to all the other (here not mentioned) contributors of keyboard and lecture files.</emphasis>
</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL; <!-- FDL: do not remove -->
&underGPL; <!-- GPL License -->
</chapter>
<appendix id="installation">
<title>How to obtain and install &ktouch;</title>
&install.intro.documentation;
</appendix>
&documentation.index;
</book>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:
// vim:ts=2:sw=2:tw=78:noet
-->
|