1 ***** edict.el optimized for XEmacs *****
5 This file Copyright 1998, 2002 Free Software Foundation, Inc.
7 The edict.el package is Copyright 1991, 1992 Per Hammarlund
8 <perham@nada.kth.se>, 1992 Bob Kerns <rwk@crl.dec.com>, and 1998, 2002
9 Free Software Foundation, Inc.
11 Individual files may have their own Copyrights differing from the above.
13 This file is part of XEmacs.
15 It is free software; you can redistribute it and/or modify it
16 under the terms of the GNU General Public License as published by
17 the Free Software Foundation; either version 2, or (at your
18 option) any later version.
20 XEmacs is distributed in the hope that it will be useful, but
21 WITHOUT ANY WARRANTY; without even the implied warranty of
22 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
23 General Public License for more details.
25 You should have received a copy of the GNU General Public License
26 along with XEmacs; if not, write to the Free Software Foundation,
27 Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
29 Original author: Per Hammarlund <perham@nada.kth.se>
30 Other authors: Bob Kerns <rwk@crl.dec.com>
31 Stephen J. Turnbull <stephen@xemacs.org>
33 Adapted-by: Stephen J. Turnbull <stephen@xemacs.org> for XEmacs
34 Maintainer: Stephen J. Turnbull <stephen@xemacs.org>
38 The original edict.el was written by Per Hammarlund. It is an
39 interface to the EDICT Japanese-English dictionary compiled by Jim
40 Breen at Monash University. Using the region and couple of
41 keystrokes, edict.el will look up the Japanese key and return all the
42 EDICT entries containing that key, in a pop-up buffer. English is
43 even easier, you just put point anywhere in the word you want to look
46 Bob Kerns added a morphology engine, which reduces a highly inflected
47 Japanese word to a list of dictionary forms (eg, itta -> (iku, iu)),
48 all of which are looked up.
54 You can now use the Customize interface (in the 'edict subgroup of the
55 'mule group) to set variables.
57 An experimental automated update function is partially implemented,
58 but already useful. `update-edict' uses wget to fetch the current
59 version(s) of the edict dictionary(ies) you use from the Monash
60 University Nihongo archive, or a user-specified mirror.
64 After several years of service, it became partially incompatible with
65 recent GNU Emacsen, especially the keymaps and the byte compiler, and
66 never was adapted for XEmacs (which only recently acquired Japanese
67 capability). This BETA release adapts edict.el to XEmacs (because
68 that's what the maintainer uses), packages it for ease of installation
69 on XEmacs, and provides a unified interface to the functions via the
70 Dictionary Lookup minor mode.
72 Documentation from version 0.9.6 (the last version maintained by Per
73 Hammarlund) is included in the appropriate .../etc directory, with the
74 file extension .096. (This numbering is unrelated to the numbering of
77 ***** Installation *****
79 For XEmacs >= 21.1, use the package user interface.
81 For XEmacs >= 20.3, get edict-<version>-pkg.tar.gz from
83 ftp://ftp.emacs.org/pub/xemacs/packages/
85 and untar it in the the directory ~/.xemacs (or top directory of your
86 package hierarchy). If you are using XEmacs >= 20.5, you're done. If
87 you're using XEmacs 20.3 or 20.4, then add
89 (load-file "~/.xemacs/lisp/edict/auto-autoloads.el")
91 to your ~/.emacs or ~/.xemacs/init.el.
93 Get edict (the dictionary) from
94 ftp://ftp.cc.monash.edu.au/pub/nihongo/, and install it in an
95 appropriate etc/ or etc/edict/ in your package hierarchy
96 (~/.xemacs/etc/ is fine). For trial purposes, there is a tiny
97 edictj.demo dictionary supplied with edict.el.
99 For mainline GNU Emacs >= 20.1, get edict-<version>-pkg.tar.gz from
100 the URL above. Unpack it somewhere; .../emacs/site-lisp/edict/ is
101 recommended. The dictionary should go in the same directory. (This
102 is intended to be automatically found, but version 0.9.9 doesn't do
103 that yet. You will have to set either the `edict-dictionary-path' or
104 `edict-dictionaries'.)
106 Users of other versions of Mule are welcome to play around; please
107 tell me what you did, whether it works or not. Due to changes in
108 keymap code, it is highly unlikely that the current version of
109 edict.el will work with nemacs or Mule based on Emacs version 18.
111 If you have special needs, the package sources are available by CVS,
112 see http://cvs.xemacs.org/. Makefile is very XEmacs (>=20) specific;
113 Makefile.GNU is provided for building for the FSF's distribution of
114 Emacs. Mainline GNU Emacs and XEmacs are nearly byte-code compatible;
115 unfortunately the incompatibilities are most likely to show up in Mule
116 applications, so you should byte-compile the source with the Emacs you
117 plan to use the package with.
119 ***** User Setup *****
121 Users of recent XEmacsen should need little setup, unless you are
122 using public dictionaries not named "edict" or user dictionaries not
123 in your home directory or not named ".edict". In that case, set the
124 variables `edict-dictionaries' and `edict-user-dictionary' as needed.
126 Other users may need to set up autoloads and possibly their
127 load-paths. A file auto-autoloads.el is provided; this file can only
128 (at this time) be produced using XEmacs, but it should work with other
129 Emacs. This file is automatically consulted by XEmacs; users of
130 mainline GNU Emacs should be able to use it by adding
132 (load-file "<path-to>/site-lisp/edict/auto-autoloads.el")
134 to .emacs. (`load-file', rather than `load-library', is suggested
135 because every XEmacs package has a file named auto-autoloads.el.)
137 The necessary autoloads may also be found by
139 grep -A 1 '^;;;###autoload$' *.el
141 You should also probably set the variable `edict-dictionary-path' to
142 help edict find your public dictionaries.
144 For some reason, Mule occasionally has trouble recognizing the file
145 coding system of edict files. If so, the Monash distribution
146 dictionary `edict', which is in EUC-JP format, should be correctly
149 (setq edict-dictionaries '(("edict" . euc-jp)))
151 in .emacs. The value of this variable is a LIST of CONS-or-STRING.
152 If a CONS, it should have a STRING as car and a CODING-SYSTEM as cdr.
153 Note that the name of this variable has changed. If your dictionary
154 directory is not found at all, you can setq `edict-dictionary-path' to
155 a LIST of strings, each of which should be a path to a directory which
156 might contain edict dictionaries.
160 The interface to edict is now the Dictionary Lookup minor mode
161 (dl-mode). It is invoked as usual by (eg) "M-x dl-mode", and its
162 modeline indicator is "dl". dl-mode is autoloaded. The various
163 functions are bound to keys in a mode-specific keymap, which is
164 invoked by a prefix key. The default prefix is "C-c $" (by analogy
165 with ispell's "M-$").
167 Unlike the former interface, dui is intended to be a general interface
168 to various dictionary-like commands. Dictionary lookup is bound to
169 "s" (for "search") in the sub-keymap; insertion and help are bound
170 to "i" and "d" (for "describe method" respectively. The search mode
171 is initialized to "EDICT search Japanese" by default.
173 Using a prefix argument allows you to change modes. Eg, "C-u C-c $ s"
174 generates a prompt for a "Method:". Currently valid search methods
175 include "EDICT search Japanese", "EDICT search English", and "ispell
176 word". Valid insert methods include "EDICT add English" and "EDICT add
179 edict.el provides a simple dictionary editing mode, automatically
180 invoked by the "EDICT add ..." methods, with TAB switching
181 between fields. An experimental `electric-henkan' mode is available,
182 in which the mode recognizes whether a field is Japanese or English
183 and invokes your preferred henkan method appropriately. To try this
184 out (setq edict-use-electric-henkan t). Note that electric henkan
185 uses the LEIM interface, so it cannot work if your preferred input
188 Due to the indirect way in which the actual methods are called, a
189 separate help function, `dui-describe-method', bound to "C-c $ d", is
190 provided to access method documentation.
194 ***** Bug reports, comments, and feature requests *****
196 Please send these to "Stephen Turnbull" <stephen@xemacs.org>.
198 Bug reports are of course of high priority, but I am hoping that users
199 will also report inflections and idioms that the morphology engine
202 Known bugs and problems are in the file TODO. (Documentation and
203 organization are both known bugs....)
205 With the reimplementation as a minor mode, it now makes sense to
206 provide keystrokes for variations on the basic theme. One example
207 (already implemented for ispell) is to use dl-mode to access other
208 dictionary applications. Another possibility is that kanjidic can be
209 loaded into the *edict* buffer as well; one could imagine restricted
210 functions (not yet implemented) that only search kanjidic or only
211 edict. Suggestions are welcome.
213 ***** Historical notes *****
215 The files edict.el.096 and edict-test.el.096 in the source
216 distribution are from the original version 0.9.6 distribution grabbed
217 from ftp.cc.monash.edu.au. The ChangeLog for version 0.9.6 is in
218 ChangeLog.096, which is included in all forms of the current
221 The .el files in this package have been converted to ISO-2022-JP
224 All hail Jim, Per, and Bob!
projects / packages / blob