« back to all changes in this revision
Viewing changes to doc/plover_guide.tex
- browse files at revision 61
- compare with another revision
- download diff
- download tarball
- view history from revision 61
- Committer: Joshua Harlan Lifton
- Date: 2011-12-28 06:42:49 UTC
- Revision ID: joshua.harlan.lifton@gmail.com-20111228064249-lgv9gxkb6mduu3xh
Fix handling of the number bar key.
Update the user guide.
Update version from alpha to beta.
Update the user guide.
Update version from alpha to beta.
added
removed
doc/plover_guide.tex
34
34
running \plover.
35
35
36
36
\subsection{Starting the Program}
37
Once installed, \plover~can be run from either the menu
38
(\code{Applications->Universal Access->Plover}) or from a
39
\terminal~(\code{plover} and then \code{ENTER}). If a stenotype
37
Once installed, \plover~can be run from either the application menu or
38
from a \terminal~(\code{plover} and then \code{ENTER}). If a stenotype
40
39
machine other than the default is used, set the machine type in the
41
40
configuration dialog.
42
41
45
44
46
45
\plover~comes with a default configuration that should work for most
47
46
setups that use the Microsoft Sidewinder X4 keyboard as the stenotype
48
machine. \plover~can be configured by right-clicking on the
49
\plover~task bar icon and selecting the \code{Configure...}
50
option. Within the configuration dialog, the user can select which
51
stenotype machine to use, which dictionary file to use, and whether or
52
not strokes and translations should be logged to a file. \plover~will
53
need to be restarted before any configuration changes take effect.
47
machine. \plover~can be configured by clicking the \code{Configure...}
48
button. Within the configuration dialog, the user can select which
49
stenotype machine to use, which dictionary file to use, whether or not
50
strokes and translations should be logged to a file, and whether or
51
not \plover~should immediately start translating when the program is
52
started. \plover~will need to be restarted before any configuration
53
changes take effect.
54
54
55
55
\section{Stenography Dictionary}
56
56
At the core of stenography is a dictionary that translates stroke
57
combinations into English words and phrases.
57
combinations into words and phrases. The words and phrases can be
58
English, another language, or a nonsense string of characters. The
59
words and phrases can also be commands and special keys other than
60
printable characters.
58
61
59
62
\subsection{Dictionary Format}
60
63
\plover~expects the stenography dictionary file to be in JSON format
61
64
and each dictionary entry within the file to be in a specific variant
62
of RTF/CRE format. A simple dictionary entry looks like:
63
64
\code{"stroke": "Some English text",}
65
65
of RTF/CRE format.
66
67
\subsubsection{Single-stroke Entries}
68
A simple dictionary entry looks like:
69
70
\code{"STROKE": "word or phrase",}
71
72
For example:
73
\begin{itemize}
74
\item \code{"TKO": "do",}
75
\item \code{"K": "can",}
76
\item \code{"KWRORPBL": "I don't remember",}
77
\item \code{"PHAS": "mas",}
78
\end{itemize}
79
80
\subsubsection{Multiple-stroke Entries}
66
81
A dictionary entry for more than one stroke looks like:
67
82
68
\code{"stroke1/stroke2/stroke3": "Some more English text",}
69
70
Meta commands are surrounded by \{ and \}, like:
71
72
\code{"stroke1/stroke2": "\meta{\^{ }opolis}",}
73
74
which means append ``opolis'' to the previous word without inserting a space.
83
\code{"STROKE1/STROKE2/STROKE3": "another word or phrase",}
84
85
\begin{itemize}
86
\item \code{"SEUPB/OPB/PHOUS": "synonymous",}
87
\item \code{"TKE/TPER": "defer",}
88
\item \code{"TOEPBD/SRA*EU": "tend to have a",}
89
\item \code{"KWREUP/KWREU/KAOEU/KWRAEU": "yippee ki-yay",}
90
\item \code{"PEPB/SAR": "pensar",}
91
\end{itemize}
92
93
\subsubsection{Meta Commands}
94
95
Meta commands are dictionary entries surrounded by \{ and \}, like:
96
97
\code{"STROKE1/STROKE2": "\meta{\^{ }opolis}",}
98
99
which means append ``opolis'' to the previous word without inserting a
100
space.
75
101
76
102
Meta commands and regular text can be mixed, like:
77
103
78
\code{"stroke1/stroke2": "\meta{.}Thus, we can see that",}
104
\code{"STROKE1/STROKE2": "\meta{.}Thus, we can see that",}
79
105
80
106
which means append a period and the number of spaces after a period
81
107
and the text ``Thus, we can see that''.
82
108
83
Spaces between meta commands and regular text don't count, so the previous example is the same as:
84
85
\code{"stroke1/stroke2": "\meta{.} Thus, we can see that",}
86
87
Furthermore, since the \meta{.} meta command will also capitalize the next word, the previous example is also the same as:
88
89
\code{"stroke1/stroke2": "\meta{.} thus, we can see that",}
109
Spaces between meta commands and regular text don't count, so the
110
previous example is the same as:
111
112
\code{"STROKE1/STROKE2": "\meta{.} Thus, we can see that",}
113
114
Furthermore, since the \meta{.} meta command will also capitalize the
115
next word, the previous example is also the same as:
116
117
\code{"STROKE1/STROKE2": "\meta{.} thus, we can see that",}
90
118
91
119
There can be more than one meta command in a translation, like:
92
120
93
\code{"stroke1/stroke2": "\meta{,}like\meta{,}}"
94
95
Since \code{"}, \code{\{}, and \code{\}} are all special dictionary format characters, the
96
character sequences \code{$\backslash$"}, \code{$\backslash$\{}, and \code{$\backslash$\}}, should be used within a
97
translation, like:
98
99
\code{"stroke1/stroke2": "\meta{\^{ }.$\backslash$"~}\meta{-\textbar}",}
121
\code{"STROKE1/STROKE2": "\meta{,}like\meta{,}}"
122
123
Since \code{"}, \code{\{}, and \code{\}} are all special dictionary
124
format characters, the character sequences \code{$\backslash$"},
125
\code{$\backslash$\{}, and \code{$\backslash$\}}, should be used
126
within a translation, like:
127
128
\code{"STROKE1/STROKE2": "\meta{\^{ }.$\backslash$"~}\meta{-\textbar}",}
100
129
101
130
which will append ." and a space to the previous word and then
102
131
capitalize the next word.
103
132
104
\subsection{Available Meta Commands}
133
\plover~supports the following meta commands:
105
134
\begin{itemize}
106
135
107
136
\item Sentence stops: \meta{.}, \meta{!}, \meta{?} all end a sentence
121
150
\item Glue flag: \meta{\&X} will connect the string X without a space to any
122
151
adjacent (previous or following) strings that also have glue flags.
123
152
124
\item Attach flag: \meta{\^{ }X}, \meta{X\^{ }}, \meta{\^{ }X\^{ }} will connect
125
the string X without a space to the previous, next, or both previous
126
and next, respectively, words, unless X is one of the simple
127
suffixes (ed, ing, er, s), in which case the simple suffix rules
128
take precedence.
153
\item Attach flag: \meta{\^{ }X}, \meta{X\^{ }}, \meta{\^{ }X\^{ }}
154
will connect the string X without a space to the previous, next, or
155
both previous and next, respectively, words, unless X is one of the
156
simple suffixes (ed, ing, er, s), in which case the simple suffix
157
rules take precedence.
158
159
\item \plover~controls: \meta{PLOVER:X} will control the state of the
160
\plover~program itself, where X is one of \code{SUSPEND},
161
\code{RESUME}, \code{TOGGLE}, \code{CONFIGURE}, \code{FOCUS}, or
162
\code{QUIT}.
129
163
130
164
\item Key combinations: \meta{\#X} will execute the key combination
131
165
described by X. See below for details.
132
166
133
167
\end{itemize}
134
168
135
\subsection{Arbitrary Key Combinations}
169
\subsubsection{Arbitrary Key Combinations}
136
170
137
171
Meta commands of the form \meta{\#X} are interpreted as a sequence of
138
172
keyboard keys pressed and released in sequence and/or
139
simultaneously. In sequence key presses are separated by a single
173
simultaneously. Serial key presses are separated by a single
140
174
space. Simultaneous key presses are denoted by parentheses surrounding
141
175
keys pressed while another key is held down. For example:
142
176
Loggerhead is a web-based interface for Breezy
Version: 2.0.1