ktouch/extras/training-gen/perl/README

   1 ###################################################################
   2 #
   3 #  ktouch-gen.pl
   4 #
   5 #    written by: Steinar Theigmann <steinart@incatel.no>
   6 #                Håvard Frøiland  <havard.froiland@chello.no>
   7 #
   8 #    This file describes how to generate your own training files
   9 #    in 3. steps.
  10 #
  11
  12
  13 Step 1: Collect data
  14
  15 The script needs a data file with words, one word on each line. You
  16 can create it in your editor, or you can get it generated (see
  17 below). You will also find some data files in cvs.
  18
  19 Suggestion for creating your own data file using an excisting dictionary. See http://aspell.sourceforge.net for more info.
  20
  21 $ aspell dump master
  22
  23 This will print out a looong list with words in the default
  24 language. If you have installed other languages that you want to use
  25 you can write:
  26
  27 $ aspell dump master norwegian
  28
  29 This will print out all the norwegian words found in the norwegian
  30 ditionary.
  31
  32 Since we don't want this word on the screen, but in a file we do this:
  33
  34 $ aspell dump master > ~/your-word-file
  35
  36 You will now have a file called your-word-file stored in your home directory.
  37
  38
  39 Step 2: Creat a configuration file
  40
  41 The config file is shown below.
  42
  43 <---- the file starts here ---->
  44 length-of-line 20
  45 number-of-line 10
  46
  47 jf
  48 kd
  49 ls
  50 ca
  51 nt
  52 iv
  53 me
  54 hr
  55 go
  56 bp
  57 qu
  58 wn
  59 cx
  60 yz
  61 ABCDEFGHIJKLMNOPQRSTUVWXYZ
  62 <---- the file ends here ---->
  63
  64 The length of a line is set to be 20 characters, and each level should
  65 be 10 lines loong. The first level will only contain combinations of
  66 "jf" and the next one will contain "jfkd" and so on.
  67
  68 Save it to a file called your-config-file, and we are ready to try the script.
  69
  70
  71 Step 3: Generate your training file
  72
  73 To test the script you should do this:
  74
  75 $ perl ktouch-gen.pl your-config-file < your-word-file
  76
  77 This will print out the newly generated training file to your screen,
  78 if you are happy with it, you could save it to file by doing this.
  79
  80 $ perl ktouch-gen.pl your-config-file < your-word-file > your-training-file.ktouch