This document contains the following sections:
You can use the Help Window to display online help while running Typist. At the top of the window you can select from the topics that the help window offers. Selecting a topic brings the help information for that area into the window's text display.
To reduce program startup time, the online help text is not accessed until the Help Window is first displayed. This is particularly useful when Typist is running as an applet. You may however see a delay when accessing the online help for the first time.
Select File->Close Window on the menu bar for this window to close it.
The file Typist31.html contains an HTML version of the online help text.
This is the main window for Typist. The menu bar allows you to activate the other windows that Typist can display - the Tutorial Window, the Exercise Window, the Statistics Window, and the online Help Window. Additionally, it also offers a Help pulldown item: Use Help->About to get information about Typist and its licensing, and Help->On Typist to obtain the online Help Window.
Typist offers a number of alternative and complementary lesson series. The Control Window allows you to select which lesson series is currently active, and within a lesson series allows you to select a particular lesson.
Beneath the window's menu bar is a toolbar. Using the toolbar, you can select the lesson series that is active, and move forwards and backwards through the lessons in that series using the <Prev and Next> buttons.
The central area of the Control Window is the lessons list. This shows each lesson that the currently active series contains. To run any lesson individually, select it from this list. Lessons can be of three basic types:
Tutorials are displayed in the Tutorial Window. Drills and Speed Tests are displayed in the Exercise Window.
This window shows the text of the most recently selected Tutorial. Use the scroll bars to read the text. The window may be left up as a reminder of the lesson if you wish.
This is the window that you type into for practice, and displays both Drills and Speed Tests.
When a Drill is being shown, the window contains two text areas. The upper one shows the target text that should be typed, highlighting the next character expected. The lower text area shows what you have typed at the keyboard so far, with error characters picked out as '*'s. In a Drill, backspace characters will not delete the last typed character.
For a Speed Test, only one text area is shown. Again, the expected next character is highlighted. When in a Speed Test, you need to overtype the characters in this text area. If you enter an incorrect character, Typist puts a '*' at the location of the error. You can use backspace to back up and correct mis-typings in Speed Tests.
For both of these types of exercise, Typist times each keystroke, and at the end of the exercise, it displays information about how many errors you made in typing the exercise, and also your typing speed and adjusted speed in Words Per Minute (WPM). Your raw typing speed is calculated as the number of keystrokes you made, divided by five (the notional average word is taken as being five characters), divided by the time in minutes taken to complete the exercise. The adjusted WPM is calculated in the same way, except that one word is taken away for each single character typing error you made.
When timing keystrokes, Typist does not count the first character of an exercise. Also, if you pause for a few seconds between characters it won't count the next character after the pause as part of the exercise. It does this to try to maintain sensible keystroke timing information in cases where you might take breaks in mid-exercise.
By default, Typist will try to behave like a word processor. A space character is treated as correctly typed at the end of a line, and multiple spaces are condensed down into a single space. If you hit Return at the end of a line, the cursor moves forward to the next significant character to be typed, skipping over blank lines and paragraph indentation. Typist won't insist that you type the hyphen at the end of lines that end in one, but will wrap for you. To switch off any or all of these word processing features, use the Options menu on the menu bar.
To restart an exercise from the beginning, use File->Restart Lesson on the menu bar.
Each time you strike a key in an exercise, Typist notes the key that you struck, the one it was expecting you to strike, and the time it took you between the last key you struck and this one.
The Statistics Window displays a complete analysis of all of this timing information collected on exercises. Keystroke statistics are integrated globally, by finger, and displayed by individual key. You can use the View pulldown menu to decide which set of statistics you want to see in the window.
Each statistic is shown as a pair of gauges, giving the percent accuracy and speed for the finger or key. If the accuracy or speed drop below certain threshold levels, the gauges will change color to orange or red, to indicate that these are areas in which you might consider some additional practice.
Press the Refresh button to bring the window up to date with current keystroke statistics. The window is automatically refreshed if you change which set of statistics is on view, when the window is displayed, and at the end of each typing exercise you complete. You can also use the autorefesh function to have the statistics refresh automatically. To control this feature, use the Options->Automatic Refresh Every Second pulldown menu item.
You can use the File->Reset All pulldown menu item to set the complete collection of measurements back to their initial condition. To display adjusted WPM statistics, use the Options->Display Adjusted WPM pulldown menu item.
The statistics shown by this window are the normal keystroke statistics, broken down by key and by finger. Note that the WPM rates are calculated on timing information that is maintained regardless of whether you struck the right key or the wrong one - this means that where accuracy is poor, the WPM rates shown for individual keys and fingers can become misleading.
Because a large amount of Typist is exercises and other typing practise material, it makes sense for the program to only load those lesson series that are actually required. It does this by using dynamic class file loading to access a lesson series when it is selected on the Control Window. Once a lesson series has been loaded, Typist keeps it in memory, so there is no need to load it again.
The effect of this is that the startup time is reduced where Typist is being run as an applet. You may however notice a delay due to downloading when you access a lesson series for the first time. Dynamic lesson loading happens automatically, and does not require you to take any special actions.
Typist (Java version) consists of a flat directory of Java source files, and a single Makefile. If you have make on your system, then merely invoking the command should be sufficient to build the complete set of class files - the Makefile does not contain any complicated or GNU-make dependent constructs.
If you do not have make available, try 'javac [-O] *.java'. The Java compiler is sometimes smart enough to automatically compile any source files for a needed class file, so building may not be too much of a problem.
Most classes contain a main() method that tests the class in some way, the obvious exception being the Typist class that contains the 'real' main() method, and also the applet entry point for the program. The main() method in the HelpHTML class prints out the online help text as a single HTML User Guide document.
The single main runnable class file in Typist is:
To run Typist as an application; use a command something like 'java Typist' to run the Typist class. You can add -k keyboard_type to specify the keyboard type. Use -h for a full list of arguments.
To run Typist as an applet, again use the Typist class. For an applet, the keyboard type can be specified using the applet parameter kbtype - see TypistApplet.html for an example of HTML applet tags to activate the program. Because the program makes heavy use of frames and menu bars, the applet form is nothing more than a single pushbutton that starts the main program in a separate frame outside the browser. Use the buttonlabel applet parameter to control the label on this pushbutton.
Typist allows you to add new lessons to the ones that it offers. To do this, you need to create a lesson series class file. For example, if you want to create a lesson series Foo, the class file containing your lesson should be named LessonSeriesFoo.class. You can then use the -s or -series flags, or the series applet parameter, to specify the series that you want Typist to offer. This is a comma-separated list, for example, 'Q,R,T,Foo'.
To build the LessonSeriesFoo.class file, copy an existing lesson series java source file to LessonSeriesFoo.java, and edit the file to contain the lessons you want to put in this series; use the existing files as an example of format. When finished, compile the java source file. Javac, guavac, or any other Java compiler should be suitable.
Typist also allows you to extend its range of keyboard maps. To do this, you need to create a new KBLayout class file. You can then use the -k or -kb flags, or the keyboard applet parameter, to tell the program to use the new keyboard map.
As with adding a new lesson series, the simplest way to create the KBLayout class file is to copy an existing keyboard layout, and use it as a template. For example, to create KBLayoutFoo.class, copy KBLayoutUS.java to the file KBLayoutFoo.java, and edit this file to contain your layout. When finished, compile this file to create KBLayoutFoo.class, and then run Typist with the option -k Foo to use the new layout.
Typist was developed on a combination of the 1.0.2 JDK and the 1.1.7 JDK. both running on Linux, but is now fully converted to use the Java 1.1 event model. The following notes apply to the the various Java runtimes tried so far:
You may need to be prepared for a voyage of discovery with your Java runtime.
The Caps Lock key does not work correctly on some AWT 1.1 implementations. See Java Runtime Notes for at least some details on which ones have specific problems. Additionally, the numeric keypad does not generate KeyEvents on some AWT 1.1 implementations.
The exercise GUI interface is not as slick as it could be. In particular the slavish use by Typist of TextArea components does not give as much control over things like text placement as might be desirable.
The dynamic loading of lesson series class files should be OK, but it is a a relatively new feature, so hasn't had as much testing as the rest of the program. The same goes for loading keyboard layout files.
The gauge in the startup dialog popup never appears when the program is started as an applet. I have no idea why.
This program is a Java reworking of a UNIX C++ reworking of a UNIX C/Curses reworking of an IBM PC reworking of an original DECUS VAX BASIC program. This Java version, Typist v3.1 was created by Simon Baldwin, simonb@sco.com.
Thanks to the original authors, whoever they were, to D. Jason Penney for the initial conversion into C/Curses, and to George Ferguson for posting it to the Internet.
Typist v3.1 (Java), Copyright (C) 1998 Simon Baldwin
This program comes with ABSOLUTELY NO WARRANTY; for details please see the file 'COPYING' supplied with the source code. This is free software, and you are welcome to redistribute it under certain conditions; again, see 'COPYING' for details. This program is released under the GNU General Public License.