File: ispelleo-readme.html

package info (click to toggle)
eo-spell 3.7-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 952 kB
  • sloc: lisp: 2,789; sh: 179; makefile: 142; sed: 73; perl: 25; ansic: 16
file content (373 lines) | stat: -rw-r--r-- 10,870 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
  <head>
    <title>README about ispell eo dictionary</title>
    <meta name="generator" content="muse.el">
    <meta http-equiv="Content-Type"
          content="text/html; charset=utf-8">
    <link rel="stylesheet" type="text/css" charset="utf-8" media="all" href="./this.css" />
  </head>
  <body>
    <h1>README about ispell eo dictionary</h1>
    <!-- Page published by Emacs Muse begins here -->
<div class="contents">
<dl>
<dt>
<a href="#sec1">About this File</a>
</dt>
<dt>
<a href="#sec2">About the Package</a>
</dt>
<dd>
<dl>
<dt>
<a href="#sec3">The Ispell utility program</a>
</dt>
<dt>
<a href="#sec4">Esperanto encodings</a>
</dt>
</dl>
</dd>
<dt>
<a href="#sec5">Installation</a>
</dt>
<dd>
<dl>
<dt>
<a href="#sec6">Simple Install (Unix or Cygwin)</a>
</dt>
<dt>
<a href="#sec7">Open Office</a>
</dt>
<dt>
<a href="#sec8">Customized Build</a>
</dt>
</dl>
</dd>
<dt>
<a href="#sec9">Usage</a>
</dt>
<dd>
<dl>
<dt>
<a href="#sec10">Command line</a>
</dt>
<dt>
<a href="#sec11">emacs.el</a>
</dt>
</dl>
</dd>
</dl>
</div>

<h2><a name="sec1" id="sec1"></a>
About this File</h2>

<p class="first">This is a short htmlized version of the <code>readme</code> file from the
<code>ispelleo.tar.bz2</code> distribution tarball.</p>

<table class="muse-table" border="2" cellpadding="5">
  <tbody>
    <tr>
      <td>Name:</td>
      <td>./readme</td>
    </tr>
    <tr>
      <td>Content:</td>
      <td>Information about Esperanto dictionary for the Ispell speller</td>
    </tr>
    <tr>
      <td>Created:</td>
      <td>1997-08-30 by Sergio Pokrovskij &lt;sergio.pokrovskij(ĉe)gmail.com&gt;</td>
    </tr>
    <tr>
      <td>Version</td>
      <td>3.7</td>
    </tr>
  </tbody>
</table>

<p>Copyright © 1997, 1998, 2003, 2006, 2008 by Sergio Pokrovskij</p>

<p>This dictionary package is available on the terms of GNU General Public License
(Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA).</p>



<h2><a name="sec2" id="sec2"></a>
About the Package</h2>

<p class="first">Here is an Esperanto dictionary, compiled by Sergio Pokrovskij for
the version 3 of ispell.</p>

<h3><a name="sec3" id="sec3"></a>
The Ispell utility program</h3>

<p class="first">You will first need to get ispell 3.0+; it is available from
<a href="ftp://ftp.cs.ucla.edu/pub/ispell-3.1">here</a>; make sure that in its <code>local.h</code>
the <code>NO8BIT</code> thing is commented out and <code>MASKBITS = 64</code>.  To see the
options ispell has been compiled with please run
<p class="verse">
<code>$ ispell -vv</code><br>
</p>


<h3><a name="sec4" id="sec4"></a>
Esperanto encodings</h3>

<p class="first">Several encodings used with Esperanto text are supported:</p>

<ol>
<li>The very best is Unicode or its subset, which contains the
esperantic letters, like the Microsoft's WGL4; you can use it with
xterm or Emacs under Unix, or with UniRed under Windows.

<p>Unicode is available in UTF-8 encoding, which is preferred
for the Unices.</p></li>

<li>The second best choice used to be the Latin-3 encoding
(ISO-8859-3); it is obsolete by now.</li>

<li>For the sake of the ASCII-impaired (and ANSI-impaired), there are
two surrogates:

<ul>
<li>The TeX-like <code>^cirka^u-style: e^ho^san^go ^ciu^ja^ude</code>.
Presently this is used as the reference representation, mainly
because it is unambiguous (cf names like <em>Michaux</em>); and</li>

<li>The popular <code>cxirkaux-style</code>, which is also convenient for
lexicographical ordering and thus is used in the dictionaries;
besides, it uses letters only, and that makes it suitable for
variable names in computer programs.</li>
</ul></li>
</ol>




<h2><a name="sec5" id="sec5"></a>
Installation</h2>

<h3><a name="sec6" id="sec6"></a>
Simple Install (Unix or Cygwin)</h3>

<p class="first">1. Unpack <code>ispelleo.tar.bz2</code>.</p>

<p>2. Go to the root directory <code>ispell-eo</code> (where this <code>readme</code> resides).</p>

<p>3. Say
<p class="verse">
&nbsp;&nbsp;<code>$ make first</code><br>
</p>
(or simply <code>make</code>) in order to check your ispell program.

<p>Examine the output, e.g. do you have the permissions to write the
hash file(s) at the install phase?</p>

<p>4. If everything is OK, say
<p class="verse">
&nbsp;&nbsp;<code>$ make eo</code><br>
</p>
(to built the strict dictionary), or
<p class="verse">
&nbsp;&nbsp;<code>$ make esperanto</code><br>
</p>
(to built a permissive dictionary), or
<p class="verse">
&nbsp;&nbsp;<code>$ make all</code><br>
</p>
(to built both).

<p>You'll get a few warnings of from buildhash, like this one:</p>

<center>
<p><code>eo.aff line 218: Flag must be alphabetic</code></p>
</center>

<p>Just ignore them.</p>

<p>5. Type
<p class="verse">
&nbsp;&nbsp;<code>$ make install</code><br>
</p>
to copy the hash file(s) to where ispell expects them to be
(probably you already have your american.hash there; normally
you shall need the root rights to make install).

<p>After that you can call
<p class="verse">
&nbsp;&nbsp;<code>$ ispell -d eo </code> <em>filename</em><br>
</p>


<h3><a name="sec7" id="sec7"></a>
Open Office</h3>

<p class="first">You'll need emacs to produce the dictionary for myspell which works
with Open Office.  Customize the word provision as described in
“Customized Build” (except the buildhash step); and then say
<p class="verse">
&nbsp;&nbsp;<code>$ make OO</code><br>
</p>
That should produce the files <code>eo_l3.aff</code> and <code>eo_l3.dic</code> in the <code>work/</code>
subdirectory.



<h3><a name="sec8" id="sec8"></a>
Customized Build</h3>

<p class="first">In order to enable selective construction of dictionaries, some
entries in the source dictionary <code>./src/vortoj.l3</code> are marked with
keywords indicating the special field they belong to:</p>

<table class="muse-table" border="2" cellpadding="5">
  <tbody>
    <tr>
      <td><code>#arhx</code></td>
      <td>archaic words, like <em>ĥina</em> (= <em>ĉina</em>) or <em>malkompreni</em> (= <em>miskompreni</em>)</td>
    </tr>
    <tr>
      <td><code>#bot</code></td>
      <td>a rare botanic word</td>
    </tr>
    <tr>
      <td><code>#Eujo</code></td>
      <td>vocabulary of the Esperanto Movement (of <em>Esperantujo</em>)</td>
    </tr>
    <tr>
      <td><code>#etn</code></td>
      <td>countries and ethnography</td>
    </tr>
    <tr>
      <td><code>#komp</code></td>
      <td>some computer-science terminology according to the <a href="http://www.esperanto.mv.ru/KompLeks/UTF8/DEFAULT.html">Komputada Leksikono</a></td>
    </tr>
    <tr>
      <td><code>#mav</code></td>
      <td>redundant words, which are used by some esperantists, though they are less precise and unnecessarily complicate the language; e.g. <em>olda</em> (<em>maljuna</em> <strong>or</strong> <em>malnova</em>), <em>mava</em> (= <em>malbona</em>)</td>
    </tr>
    <tr>
      <td><code>#pers</code></td>
      <td>given names and names of important personalities (e.g. <em>Petro, Zamenhof</em> ...)</td>
    </tr>
    <tr>
      <td><code>#pok</code></td>
      <td>the words specific to my idiolect</td>
    </tr>
    <tr>
      <td><code>#rar</code></td>
      <td>rare words which may coincide with a misspelling of a more frequent word; e.g. <em>ajuna</em>, <em>komanditi</em>, <em>liona</em></td>
    </tr>
    <tr>
      <td><code>#var</code></td>
      <td>variant which I do not use but which is frequent enough (e.g. <em>kemio, tekniko</em> opposed to <em>ĥemio</em> and <em>teĥniko</em>)</td>
    </tr>
    <tr>
      <td>...</td>
      <td> </td>
    </tr>
  </tbody>
</table>

<p>You can</p>

<pre class="example">
  $ grep '#mav' ./src/vortoj.l3 | less
</pre>
in order to see if you feel like me about them; you can either remove
all of them from the target dictionary, or remove the <code>#mav</code> mark from
those you do use and like; the default setting in the <code>./Makefile</code> is

<pre class="example">
short_list      =  komp,etn,Eujo,pers,mll
eo_list         =  $(short_list),drv
esperanto_list  =  $(short_list),arhx,mav,rar
</pre>
Unless included in the custom list (like <code>eo_list</code>), a marked word is
considered as a special one and is excluded from the build; the above
custom lists thus specify “positive criteria”.  But some words have
several marks (e.g. a word may be “ethnic” and “obsolete” or
dangerously close to a  misspelling of a frequent word).  Thus a
“negative” filtration is available via the <code>$(sen)</code> macro; you can
specify it in <code>src/Makefile</code>, or in the command-line:

<pre class="example">
  $ make eo sen=&quot;arhx,rar&quot;
</pre>

<p>In this way some otherwise eligible words from the <code>komp</code> or <code>etn</code> or
<code>mll</code> categories shall be discarded, if they are also obsolete or rare.</p>



<h2><a name="sec9" id="sec9"></a>
Usage</h2>

<h3><a name="sec10" id="sec10"></a>
Command line</h3>

<p class="first">You can use ispell in a stand-alone mode; type</p>

<p class="verse">
&nbsp;&nbsp;<code>$ ispell -d eo </code> <em>filename</em><br>
</p>

<p>or you may prefer to customize your emacs; e.g. copy
<code>./emacs/ispell-ini.el</code> from this distribution into your site-lisp (or
somewhere else on your emacs load-path), and put this into your .emacs</p>

<p class="verse">
<code>(load &quot;ispell-ini.el&quot;)</code><br>
</p>

<p>In order to get a list of all misspelled or unknown words from a text
in the Latin-3 encoding you could say (in Linux):</p>

<pre class="example">
   export LC_ALL=eo_XX.ISO-8859-3
   ispell -d esperanto -T .l3 -l &lt; FILENAME | sort -u
</pre>

<p>Some more comments are in <code>legu-min.l3</code> (in esperanto).</p>


<h3><a name="sec11" id="sec11"></a>
emacs.el</h3>

<p class="first">This probably is no longer required for emacs-21 or newer.</p>

<p>I enclose the <code>emacs/ispell.el</code> file, which is a modified version of
ispell.el which comes with the Emacs-20 distribution.  There are two
modifications:</p>

<ol>
<li>the variable ispell-dictionary-alist-3 is modified to use the
latin-3 encoding (it is latin-1 in the distribution);</li>

<li>the coordinates of the correction for the word being checked is
done in a more thorough fashion.  The original version fails to
account for the fact that ispell returns multibyte representation,
while the internal Emacs representation for the UTF-8 takes one
unit per character.  As a result, the &quot;misalignment error&quot; occurs,
when the word is close to the end of line, and the correction end
extends beyond the end of line.  With my patch the esperantic texts
in UTF-8 are spellchecked normally, unless a foreign character
occurs in the buffer; but that is a different bug, which is present
for the unibyte encodings as well.</li>
</ol>











<!-- Page published by Emacs Muse ends here -->
  </body>
</html>