summaryrefslogtreecommitdiffstats
path: root/doc/tdespell/index.docbook
blob: ea51e70eed30f8bdd449ce18a8146c447d42074f (plain)
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
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY kappname "&tdespell;">
  <!ENTITY % English "INCLUDE" > <!-- change language only here -->
  <!ENTITY % addindex "IGNORE">
]>

<book lang="&language;">

<bookinfo>
<title>The &tdespell; Handbook</title>

<authorgroup>
<author>&David.Sweet; &David.Sweet.mail;</author>

<!-- TRANS:ROLES_OF_TRANSLATORS -->

</authorgroup>

<date>2003-02-24</date>
<releaseinfo>1.00.00</releaseinfo>
<abstract>
<para>&tdespell; is the spelling checker used by &tde; applications such
as &kate;, &kmail;, and &kword;. It is a &GUI; frontend to <application>International ISpell</application> and <application>ASpell</application>.</para>

</abstract>
<keywordset>
<keyword>spell</keyword>
<keyword>spelling</keyword>
<keyword>tdespell</keyword>
<keyword>ispell</keyword>
<keyword>aspell</keyword>
<keyword>check</keyword>
<keyword>checker</keyword>
<keyword>KDE</keyword>
</keywordset>
</bookinfo>

<chapter id="misspelled-word-dialog">
<title>Misspelled Word Dialog</title>

<!-- This one might need a paragraph of its own) --> 
<para>(If you do not have <application>Ispell</application> installed
you can obtain it from the <ulink
url="http://fmg-www.cs.ucla.edu/geoff/ispell.html">International
ISpell home page</ulink>.  ASpell is available from the <ulink
url="http://aspell.sourceforge.net/">ASpell home page</ulink>.)
</para>

<sect1 id="general-use">
<title>General Use</title>

<para><anchor id="spelldlg"/>
The top line in the dialog displays a possibly misspelled word which was found in your
document. &tdespell; attempts to find an appropriate replacement word. One or
several may be found. The best guess is shown to the right of <guilabel>Replacement:</guilabel>.
To accept this replacement, click on <guibutton>Replace</guibutton>. You may also select a word
from the list of <guilabel>Suggestions</guilabel> and then click <guibutton>Replace</guibutton> to replace the
misspelled word with the selected word.</para>

<para>To keep your original spelling, click on <guilabel>Ignore</guilabel>.</para>

<para>To stop the spellchecking -- keeping the changes you've already made -- click
on <guibutton>Stop</guibutton>.</para>

<para>To stop the spellchecking and cancel the changes you've already made, click on
<guibutton>Cancel</guibutton>.</para>

<para>Clicking on <guibutton>Replace All</guibutton> will initially perform the same function as
clicking on <guibutton>Replace</guibutton>, but will automatically replace the misspelled word
with the chosen replacement word, if it appears again (at a later point) in your
document.</para>

<para>The <guibutton>Ignore All</guibutton> button ignores this and all future occurrences of the
misspelled word.</para>

<para>Clicking on <guibutton>Add</guibutton> will add the misspelled word to your personal dictionary
(this is distinct from the original system dictionary, so the additions you make
will not be seen by other users).</para>
</sect1>
</chapter>

<chapter id="configuration-dialog">
<title>Configuration Dialog </title>
<anchor id="configuration"/>

<sect1 id="dictionaries">
<title>Dictionaries</title>

<para>You can choose the dictionary to use for spellchecking from the list of
installed dictionaries.</para>
</sect1>

<sect1 id="encodings">
<title>Encodings</title>

<para>The most commonly used character encodings are:
<variablelist>
<varlistentry>
<term>US-ASCII</term>
<listitem>
<para>This is the character set used for English text.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ISO-8859-1</term>
<listitem>
<para>This is used for Western European languages.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>UTF-8</term>
<listitem>
<para>This is a Unicode encoding that can be used for almost any language, if 
your system has the necessary fonts.</para>
</listitem>
</varlistentry>
</variablelist>
</para>

<para>You should select the one that matches the character set you are using.
In some cases, dictionaries will support more than one encoding.  A
dictionary might, for example, accept accented characters when <guilabel>ISO-8859-1</guilabel> is
selected, but accept email-style character combinations (like <literal>'a</literal> for an
accented <literal>a</literal>) when <guilabel>US-ASCII</guilabel> is selected. Please see
your dictionary's distribution for more information.</para>
</sect1>

<sect1 id="spell-checking-client">
<title>Spell-checking client</title>

<para>You may choose to use <application>Ispell</application> or <application>Aspell</application> as the spell-checking
backend for &tdespell;. <application>Ispell</application> is more widely available and may
have better international support, but <application>Aspell</application> is gaining
popularity as it claims to give better suggestions for word replacements.</para>
</sect1>

<sect1 id="other">
<title>Other</title>

<para>It is recommend that you do not change the first two options unless you have
read the International <application>ISpell</application> man page.</para>
</sect1>
</chapter>

<chapter id="contact-information">
<title>Contact Information</title>

<para>For more information about &tdespell;, visit the <ulink url="http://www.chaos.umd.edu/~dsweet/KDE/KSpell">&tdespell; 
Home Page</ulink>. In particular, you will find information about programming the &tdespell; C++ class.</para>

<para>You may email the author/maintainer with questions and/or comments at
&David.Sweet.mail;.</para>

<para>
Documentation Copyright &copy; 2003 &David.Sweet; &David.Sweet.mail;
</para>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->

&underFDL;               <!-- FDL: do not remove -->

</chapter>
&documentation.index; 
</book>