[b94f90]: doc / users-guide.xml Maximize Restore History

Download this file

users-guide.xml    502 lines (501 with data), 12.7 kB

  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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE article
PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<article>
<articleinfo>
<title>Accents Plugin</title>
<author>
<othername>Ollie Rutherfurd</othername>
</author>
<edition>Version 1.3</edition>
<date>2004-05-15</date>
</articleinfo>
<section id="about">
<title>About</title>
<para><citetitle>Accents</citetitle> enables one to enter non-ascii characters using
abbreviations. <citetitle>Accents</citetitle> converts the abbreviations to the
characters they represent, as you type. For example, if you
enter <literal>&quot;a</literal>, <citetitle>Accents</citetitle> converts it to <literal>ä</literal> when you type the
&quot;a&quot; character.</para><para>However, with this convenience comes a cost. If you actually
wanted to enter <literal>'a</literal>, not <literal>á</literal>, you must enter <literal>' a</literal>,
which <citetitle>Accents</citetitle> will convert to <literal>'a</literal> (it removes the space).</para><para>NOTE: At present, <citetitle>Accents</citetitle> assumes one is using the
ISO-8859-1 character encoding (also known as Latin-1).</para></section>
<section id="character-abbreviations">
<title>Character Abbreviations</title>
<para>The default set of characters and abbreviations:</para><!-- This table generated by ``accents2table.py``. -->
<informaltable frame="all">
<tgroup cols="2">
<colspec colname="col_1" />
<colspec colname="col_2" />
<thead>
<row>
<entry><para>Character</para></entry>
<entry><para>Abbreviation</para></entry>
</row>
</thead>
<tbody>
<row>
<entry><para>Ŕ</para></entry>
<entry><para>`A</para></entry>
</row>
<row>
<entry><para>Á</para></entry>
<entry><para>'A</para></entry>
</row>
<row>
<entry><para>Â</para></entry>
<entry><para>^A</para></entry>
</row>
<row>
<entry><para>Ä</para></entry>
<entry><para>&quot;A</para></entry>
</row>
<row>
<entry><para>Ă</para></entry>
<entry><para>~A</para></entry>
</row>
<row>
<entry><para>Ĺ</para></entry>
<entry><para>/A</para></entry>
</row>
<row>
<entry><para>Ć</para></entry>
<entry><para>/E</para></entry>
</row>
<row>
<entry><para>Ç</para></entry>
<entry><para>~C</para></entry>
</row>
<row>
<entry><para>Đ</para></entry>
<entry><para>~D</para></entry>
</row>
<row>
<entry><para>Č</para></entry>
<entry><para>`E</para></entry>
</row>
<row>
<entry><para>É</para></entry>
<entry><para>'E</para></entry>
</row>
<row>
<entry><para>Ę</para></entry>
<entry><para>^E</para></entry>
</row>
<row>
<entry><para>Ë</para></entry>
<entry><para>&quot;E</para></entry>
</row>
<row>
<entry><para>Ě</para></entry>
<entry><para>`I</para></entry>
</row>
<row>
<entry><para>Í</para></entry>
<entry><para>'I</para></entry>
</row>
<row>
<entry><para>Î</para></entry>
<entry><para>^I</para></entry>
</row>
<row>
<entry><para>Ď</para></entry>
<entry><para>&quot;I</para></entry>
</row>
<row>
<entry><para>Ń</para></entry>
<entry><para>~N</para></entry>
</row>
<row>
<entry><para>Ň</para></entry>
<entry><para>`O</para></entry>
</row>
<row>
<entry><para>Ó</para></entry>
<entry><para>'O</para></entry>
</row>
<row>
<entry><para>Ô</para></entry>
<entry><para>^O</para></entry>
</row>
<row>
<entry><para>Ö</para></entry>
<entry><para>&quot;O</para></entry>
</row>
<row>
<entry><para>Ř</para></entry>
<entry><para>/O</para></entry>
</row>
<row>
<entry><para>Ő</para></entry>
<entry><para>~O</para></entry>
</row>
<row>
<entry><para>Ţ</para></entry>
<entry><para>~T</para></entry>
</row>
<row>
<entry><para>Ú</para></entry>
<entry><para>'U</para></entry>
</row>
<row>
<entry><para>Ů</para></entry>
<entry><para>`U</para></entry>
</row>
<row>
<entry><para>Ű</para></entry>
<entry><para>^U</para></entry>
</row>
<row>
<entry><para>Ü</para></entry>
<entry><para>&quot;U</para></entry>
</row>
<row>
<entry><para>Ý</para></entry>
<entry><para>'Y</para></entry>
</row>
<row>
<entry><para>ŕ</para></entry>
<entry><para>`a</para></entry>
</row>
<row>
<entry><para>á</para></entry>
<entry><para>'a</para></entry>
</row>
<row>
<entry><para>â</para></entry>
<entry><para>^a</para></entry>
</row>
<row>
<entry><para>ä</para></entry>
<entry><para>&quot;a</para></entry>
</row>
<row>
<entry><para>ă</para></entry>
<entry><para>~a</para></entry>
</row>
<row>
<entry><para>ĺ</para></entry>
<entry><para>/a</para></entry>
</row>
<row>
<entry><para>ć</para></entry>
<entry><para>/e</para></entry>
</row>
<row>
<entry><para>ç</para></entry>
<entry><para>~c</para></entry>
</row>
<row>
<entry><para>đ</para></entry>
<entry><para>~d</para></entry>
</row>
<row>
<entry><para>č</para></entry>
<entry><para>`e</para></entry>
</row>
<row>
<entry><para>é</para></entry>
<entry><para>'e</para></entry>
</row>
<row>
<entry><para>ę</para></entry>
<entry><para>^e</para></entry>
</row>
<row>
<entry><para>ë</para></entry>
<entry><para>&quot;e</para></entry>
</row>
<row>
<entry><para>ě</para></entry>
<entry><para>`i</para></entry>
</row>
<row>
<entry><para>í</para></entry>
<entry><para>'i</para></entry>
</row>
<row>
<entry><para>î</para></entry>
<entry><para>^i</para></entry>
</row>
<row>
<entry><para>ď</para></entry>
<entry><para>&quot;i</para></entry>
</row>
<row>
<entry><para>ń</para></entry>
<entry><para>~n</para></entry>
</row>
<row>
<entry><para>ň</para></entry>
<entry><para>`o</para></entry>
</row>
<row>
<entry><para>ó</para></entry>
<entry><para>'o</para></entry>
</row>
<row>
<entry><para>ô</para></entry>
<entry><para>^o</para></entry>
</row>
<row>
<entry><para>ö</para></entry>
<entry><para>&quot;o</para></entry>
</row>
<row>
<entry><para>ř</para></entry>
<entry><para>/o</para></entry>
</row>
<row>
<entry><para>ő</para></entry>
<entry><para>~o</para></entry>
</row>
<row>
<entry><para>ß</para></entry>
<entry><para>&quot;s</para></entry>
</row>
<row>
<entry><para>ţ</para></entry>
<entry><para>~t</para></entry>
</row>
<row>
<entry><para>ů</para></entry>
<entry><para>`u</para></entry>
</row>
<row>
<entry><para>ú</para></entry>
<entry><para>'u</para></entry>
</row>
<row>
<entry><para>ű</para></entry>
<entry><para>^u</para></entry>
</row>
<row>
<entry><para>ü</para></entry>
<entry><para>&quot;u</para></entry>
</row>
<row>
<entry><para>ý</para></entry>
<entry><para>'y</para></entry>
</row>
<row>
<entry><para>˙</para></entry>
<entry><para>&quot;y</para></entry>
</row>
<row>
<entry><para>×</para></entry>
<entry><para>~*</para></entry>
</row>
<row>
<entry><para>÷</para></entry>
<entry><para>~/</para></entry>
</row>
<row>
<entry><para>ś</para></entry>
<entry><para>/P</para></entry>
</row>
<row>
<entry><para>§</para></entry>
<entry><para>/S</para></entry>
</row>
<row>
<entry><para>Š</para></entry>
<entry><para>/C</para></entry>
</row>
<row>
<entry><para>Ž</para></entry>
<entry><para>/R</para></entry>
</row>
<row>
<entry><para>°</para></entry>
<entry><para>/d</para></entry>
</row>
<row>
<entry><para>ş</para></entry>
<entry><para>/T</para></entry>
</row>
<row>
<entry><para>ą</para></entry>
<entry><para>+-</para></entry>
</row>
<row>
<entry><para>š</para></entry>
<entry><para>^1</para></entry>
</row>
<row>
<entry><para>˛</para></entry>
<entry><para>^2</para></entry>
</row>
<row>
<entry><para>ł</para></entry>
<entry><para>^3</para></entry>
</row>
<row>
<entry><para>´</para></entry>
<entry><para>~'</para></entry>
</row>
<row>
<entry><para>ź</para></entry>
<entry><para>/4</para></entry>
</row>
<row>
<entry><para>˝</para></entry>
<entry><para>/2</para></entry>
</row>
<row>
<entry><para>ž</para></entry>
<entry><para>/3</para></entry>
</row>
<row>
<entry><para>Ť</para></entry>
<entry><para>~&lt;</para></entry>
</row>
<row>
<entry><para>ť</para></entry>
<entry><para>~&gt;</para></entry>
</row>
<row>
<entry><para>Ą</para></entry>
<entry><para>~!</para></entry>
</row>
<row>
<entry><para>ż</para></entry>
<entry><para>~?</para></entry>
</row>
<row>
<entry><para>˘</para></entry>
<entry><para>/c</para></entry>
</row>
<row>
<entry><para>Ł</para></entry>
<entry><para>~L</para></entry>
</row>
<row>
<entry><para>Ľ</para></entry>
<entry><para>~Y</para></entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
<section id="usage">
<title>Usage</title>
<para><citetitle>Accents</citetitle> menu items:</para><variablelist>
<varlistentry>
<term>
<varname><citetitle>Enabled</citetitle>:</varname></term>
<listitem>
<para>Enable or disable <citetitle>Accents</citetitle>.</para></listitem>
</varlistentry>
<varlistentry>
<term>
<varname><citetitle>Convert Abbreviation before Caret</citetitle>:</varname></term>
<listitem>
<para>Convert the abbreviation before the caret. This works
regardless of whether <citetitle>Accents</citetitle> is enabled to convert
abbreviations as you type them.</para></listitem>
</varlistentry>
<varlistentry>
<term>
<varname><citetitle>Ignore Next</citetitle>:</varname></term>
<listitem>
<para>Ignore the next abbreviation match.</para></listitem>
</varlistentry>
<varlistentry>
<term>
<varname><citetitle>List</citetitle>:</varname></term>
<listitem>
<para>Display a dockable list of accent characters
and abbreviations.</para></listitem>
</varlistentry>
<varlistentry>
<term>
<varname><citetitle>Reload Accents</citetitle>:</varname></term>
<listitem>
<para>Reload accents and abbreviations from
<literal>~/.jedit/accents.txt</literal>.</para></listitem>
</varlistentry>
<varlistentry>
<term>
<varname><citetitle>Verbose Logging</citetitle>:</varname></term>
<listitem>
<para>Increases amount of logging for trouble-shooting.</para></listitem>
</varlistentry>
</variablelist>
</section>
<section id="configuration">
<title>Configuration</title>
<section id="options">
<title>Options</title>
<variablelist>
<varlistentry>
<term>
<varname><citetitle>Enable Accents when jEdit starts</citetitle>:</varname></term>
<listitem>
<para>Toggles whether <citetitle>Accents</citetitle> is enabled when jEdit
starts. This is indepenent of whether <citetitle>Accents</citetitle> is
currently enabled or not. By default, <citetitle>Accents</citetitle> is
enabled when jEdit starts.</para></listitem>
</varlistentry>
<varlistentry>
<term>
<varname><citetitle>Accents Encoding</citetitle>:</varname></term>
<listitem>
<para>Character set of <literal>accents.txt</literal>. Default is ISO-8859-1.</para></listitem>
</varlistentry>
<varlistentry>
<term>
<varname><citetitle>Enable Verbose Logging by default</citetitle>:</varname></term>
<listitem>
<para>Whether to turn on verbose logging by defaul
for <citetitle>Accents</citetitle>.</para></listitem>
</varlistentry>
</variablelist>
</section>
<section id="id1">
<title>Character Abbreviations</title>
<para>Character abbreviations are stored in <literal>~/.jedit/accents.txt</literal>.
Edit <literal>accents.txt</literal> to add or remove abbreviations.</para><para><literal>accents.txt</literal> is a tab-delimited text file with the
character in the first field and the 2-character abbreviation
in the second field. Blank lines are ignored and lines
beginning with <literal>#</literal> are comments.</para><para>The <ulink url="http://plugins.jedit.org/plugins/?CharacterMap">CharacterMap</ulink> plugin may be useful for inserting
characters.</para></section>
</section>
<section id="feedback">
<title>Feedback</title>
<para>Bug reports, comments, and suggestions regarding <citetitle>Accents</citetitle>
may be sent to Ollie Rutherfurd at <ulink url="mailto:oliver@jedit.org">oliver@jedit.org</ulink>
or posted on the jedit-users mailing list
<ulink url="mailto:jedit-users@lists.sourceforge.net">jedit-users@lists.sourceforge.net</ulink>
(membership is required).</para><para>I'd appreciate feedback on what works, what doesn't, and
how to it more useful. I don't use the plugin, as I don't
have a need for it.</para></section>
<section id="to-do">
<title>To Do</title>
<itemizedlist>
<listitem>
<para>Add an option to try to be clever w/comments, strings,
etc... -- if the abbrevation is the start of one, don't
expand it. This would save one from having to type
<literal>&quot; a&quot;</literal> to enter the string <literal>&quot;a&quot;</literal>.</para></listitem>
</itemizedlist>
</section>
<section id="credits">
<title>Credits</title>
<para><citetitle>Accents</citetitle> is inspired by <ulink url="http://www.cs.tut.fi/~jkorpela/emacs-iso.html.">iso-accents-mode</ulink> in <ulink url="http://www.gnu.org/software/emacs/emacs.html">Emacs</ulink>.</para><para>Accent abbreviations were provided by
<ulink url="mailto:dmab@users.sourceforge.net">David Bourguignon</ulink>
who originally requested the functionality.</para></section>
<section id="history">
<title>History</title>
<itemizedlist>
<listitem>
<para>Version 1.0, May 2004</para><itemizedlist>
<listitem>
<para>Initial release.</para></listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<!-- :mode=rest:wrap=hard:line:maxLineLen=62: -->
</section>
</article>