[9b252d]: doc / users-guide.txt Maximize Restore History

Download this file

users-guide.txt    134 lines (91 with data), 3.2 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
==============
Accents Plugin
==============
:Author: Ollie Rutherfurd
:Date: $Date$
:Version: $Version$
About
=====
`Accents` makes inserting characters like ``á`` easy. As you
type, `Accents` watches for character abbreviations and
converts them as you type them. For example, if you enter
``'a`` `Accents` converts it to ``á`` when you enter the
``a``.
However, with this convenience comes a cost. If you actually
wanted to enter ``'a``, not ``á``, you must enter ``' a``,
which `Accents` will convert to ``'a`` (it removes the space).
NOTE: At present, `Accents` assumes one is using the
ISO-8859-1 character encoding (also known as Latin-1).
Character Abbreviations
=======================
The default set of characters and abbreviations:
.. include:: accents-table.txt
Usage
=====
`Accents` menu items:
`Enabled`:
Enable or disable `Accents`.
`Ignore Next`:
Ignore the next abbreviation match.
`List`:
Display a dockable list of accent characters
and abbreviations.
`Reload Accents`:
Reload accents and abbreviations from
``~/.jedit/accents.txt``.
`Verbose Logging`:
Increases amount of logging for trouble-shooting.
Configuration
=============
Options
-------
`Enable Accents when jEdit starts`:
Toggles whether `Accents` is enabled when jEdit
starts. This is indepenent of whether `Accents` is
currently enabled or not. By default, `Accents` is
enabled when jEdit starts.
`Accents Encoding`:
Character set of ``accents.txt``. Default is ISO-8859-1.
`Enable Verbose Logging by default`:
Whether to turn on verbose logging by defaul
for `Accents`.
Character Abbreviations
-----------------------
Character abbreviations are stored in ``~/.jedit/accents.txt``.
Edit ``accents.txt`` to add or remove abbreviations.
``accents.txt`` 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 ``#`` are comments.
The `CharacterMap`_ plugin may be useful for inserting
characters.
.. _CharacterMap: http://plugins.jedit.org/plugins/?CharacterMap
Feedback
========
Bug reports, comments, and suggestions regarding `Accents`
may be sent to Ollie Rutherfurd at oliver@jedit.org
or posted on the jedit-users mailing list
`jedit-users@lists.sourceforge.net <mailto:jedit-users@lists.sourceforge.net>`__
(membership is required).
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.
To Do
=====
* 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
``" a"`` to enter the string ``"a"``.
Credits
=======
`Accents` is inspired by `iso-accents-mode`_ in `Emacs`_.
.. _iso-accents-mode: http://www.cs.tut.fi/~jkorpela/emacs-iso.html.
.. _Emacs: http://www.gnu.org/software/emacs/emacs.html
Accent abbreviations were provided by
`David Bourguignon <mailto:dmab@users.sourceforge.net>`__
who originally requested the functionality.
History
=======
* Version 1.0, May 2004
- Initial release.
.. :mode=rest:wrap=hard:line:maxLineLen=62: