diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 93 |
1 files changed, 64 insertions, 29 deletions
@@ -27,15 +27,18 @@ * easy selection of dictionary and search strategy * backward moving through the visited definitions - Here is a sample screenshot showing the dictionary mode in action + Here are two ample screenshot showing the dictionary mode in action within an Emacs 21 buffer: - [dictionary-1.png] This buffer shows the result of searching the definition for Emacs. Two entries have been found. The bold text on the top are buttons for selecting action using the mouse or keyboard, the blue words are hyper links that points to the definitions of these words. + This buffer shows the result of looking for matching words to + possible. You can now select one of the found entries or ignore the + search by pressing any mouse button outside the menu. + Download and Requirements I have tested the package with a native GNU Emacs 19.34.1 and XEmacs @@ -43,17 +46,18 @@ custom.el file in the above GNU Emacs. Please update to the current version whenever possible. XEmacs 21 and Emacs 20 as well as Emacs 21 have been tested too. - * [5]Current version (1.3.3) of this package - * [6]Version 1.2.1 of this package - * [7]Version 1.1 of this package - * [8]Initial version (1.0) of this package + * [5]Current version (1.4) of this package + * [6]Version 1.3.3 of this package + * [7]Version 1.2.1 of this package + * [8]Version 1.1 of this package + * [9]Initial version (1.0) of this package I you want to know more about the differences please look at the - [9]ChangeLog. + [10]ChangeLog. You will need the custom package to use this package. For full support please check if your system knows the defface function, if not please - download the [10]current version. + download the [11]current version. For best usability I suggest using the mouse, but it provide good keyboard support as well. @@ -61,14 +65,14 @@ Unpacking the archive The package is distributed as tar.gz file. You unpack it using: -gzip -dc dictionary-1.3.3.tar.gz | tar xf - +gzip -dc dictionary-1.4.tar.gz | tar xf - or -tar -xzf dictionary-1.3.3.tar.gz +tar -xzf dictionary-1.4.tar.gz (with the version number subject to change) depending on whether you are using GNU tar which support the z flag for compression. After - unpacking the archive a directory dictionary-1.3.3 has been created + unpacking the archive a directory dictionary-1.4 has been created containing the necessary files. Installation @@ -80,12 +84,12 @@ Debian dpkg-buildpackage) you can use the supplied debian support. make debian - This will create a package named dictionary-1.3.3-1_i386.deb or - similiar in the parent directory of dictionary-1.3.3. You can now - install this package as root, it will automatically byte-compile - itself for all installed emacs versions and provide a startup-file - which autoloads this package. In the configuration example given below - you can omit the autoload lines. + This will create a package named dictionary-1.4-1_i386.deb or similiar + in the parent directory of dictionary-1.4. You can now install this + package as root, it will automatically byte-compile itself for all + installed emacs versions and provide a startup-file which autoloads + this package. In the configuration example given below you can omit + the autoload lines. If you no longer want to use this package, you can remove it using: dpkg -r dictionary @@ -137,11 +141,18 @@ Manually "Unconditionally lookup the word at point." t) (autoload 'dictionary "dictionary" "Create a new dictionary buffer" t) +(autoload 'dictionary-mouse-popup-matching-words "dictionary" + "Display entries matching the word at the cursor" t) +(autoload 'dictionary-popup-matching-words "dictionary" + "Display entries matching the word at the point" t) In addition, some key bindings for faster access can be useful. I use the following ones in my installation: (global-set-key [(control c) ?s] 'dictionary-search) (global-set-key [(control c) ?m] 'dictionary-match-words) +(if (boundp 'running-xemacs) + (global-set-key [(control button3)] 'dictionary-mouse-popup-matching-words) + (global-set-key [mouse-3] 'dictionary-mouse-popup-matching-words)) I will describe the user-callable functions and the key bindings within dictionary mode later in this document. @@ -190,7 +201,7 @@ Glossary Invoking - There are four different (documented) ways of invoking the package. By + There are five different (documented) ways of invoking the package. By calling dictionary you can start a new dictionary buffer waiting for your commands. If you want to create multiple buffers for searching the dictionary, you can run this function multiple times. @@ -202,6 +213,19 @@ Invoking one is dictionary-match-words which will ask for a pattern and display all matching words. + You can also display a popup menu showing the definition for a certain + word. You just place the mouse cursor above the word you want to + lookup and press the assigned mouse button. The above sample keyboard + definition binds this command to the right mouse button in GNU Emacs + and to ctrl + right mouse button in XEmacs. If you want this function + using a mouse event use the dictionary-mouse-popup-matching-words, for + assigning to a key combination use the dictionary-popup-matching-words + function. The latter function search for the word located at point. + + I have tested this feature in Emacs 21 and XEmacs 21. Emacs 20 do not + support this kind of popup menus (you will get an error message if you + try anyway), XEmacs 20 or prior has not been tested yet. + If you get an error message that the server could not be contacted, please check the values of the variables dictionary-server and dictionary-port. The port should usually be 2628, the default server @@ -343,8 +367,9 @@ Getting Help Thanks I want to thank Sam Steingold, Baoqiu Cui, Bruce Ravel, Pavel Janík, - Sergei Pokrovsky, Jeff Mincy, Serge Boiko, Enrico Scholz for their - valuable suggestions (including patches) for improving this package. + Sergei Pokrovsky, Jeff Mincy, Serge Boiko, Enrico Scholz, and Reuben + Thomas for their valuable suggestions (including patches) for + improving this package. License @@ -363,6 +388,10 @@ Getting Help ChangeLogs +Version 1.3.3 - 1.4 + + * added popup menu for easier lookup of words + Version 1.3.2 - 1.3.3 * added support for XEmacs 21 packages to ease installation for @@ -430,20 +459,26 @@ Version 1.0 - 1.1 _________________________________________________________________ - [11]Torsten Hilbrich + [12]Torsten Hilbrich - Last modified: Fri Jun 29 08:02:46 CEST 2001 + Last modified: Fri Jul 6 21:55:15 CEST 2001 References + Visible links 1. http://www.dict.org/ 2. http://www.dict.org/rfc2229.txt 3. http://www.xemacs.org/ 4. http://www.myrkr.in-berlin.de/dictionary.html - 5. http://localhost/~torsten/dictionary-1.3.3.tar.gz - 6. http://localhost/~torsten/dictionary-1.2.1.tar.gz - 7. http://localhost/~torsten/dictionary-1.1.tar.gz - 8. http://localhost/~torsten/dictionary-1.0.tar.gz - 9. http://localhost/~torsten/dictionary.html#changelog - 10. http://www.dina.kvl.dk/~abraham/custom/ - 11. mailto:Torsten.Hilbrich@gmx.net + 5. http://localhost/~torsten/dictionary-1.4.tar.gz + 6. http://localhost/~torsten/dictionary-1.3.3.tar.gz + 7. http://localhost/~torsten/dictionary-1.2.1.tar.gz + 8. http://localhost/~torsten/dictionary-1.1.tar.gz + 9. http://localhost/~torsten/dictionary-1.0.tar.gz + 10. http://localhost/~torsten/dictionary.html#changelog + 11. http://www.dina.kvl.dk/~abraham/custom/ + 12. mailto:Torsten.Hilbrich@gmx.net + + Hidden links: + 13. http://localhost/~torsten/dictionary-1.png + 14. http://localhost/~torsten/dictionary-2.png |