Source

dictionary / README

Diff from to

File README

      * backward moving through the visited definitions
      * in the latest versions of GNU Emacs and XEmacs you get support for
        popup menus
-     * in  GNU Emacs 21 you can lookup words by simply pointing the mouse
-       cursor to them (tool-tips)
+     * in GNU Emacs 21 and XEmacs 21 you can lookup words by simply
+       pointing the mouse cursor to them (tool-tips)
 
-   Here are three sample screenshot showing the dictionary mode in action
-   within an Emacs 21 buffer:
+                           Requirements
 
-   This buffer shows the result of searching the definition for
-   distinguished. A lot of entries have been found, including translation
-   into german and russian language. The blue words are hyper-links that
-   points to the definitions of these words. The hyper-link with the
-   green background will be activated when pressing the middle mouse
-   button.
-   
-   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.
-   
-   This screenshot shows the tool-tips supported in GNU Emacs 21.
-   Whenever the mouse cursor stands still for a certain time (about one
-   second) the word at cursor is looked up in the configured dictionary.
-   This example shows the german translation for originally, in this
-   context not the right one, urspr�nglich would be better.
-
-                           Download and Requirements
-
-   I  have  tested the package with a native GNU Emacs 19.34.1 and XEmacs
-   20.4.  I  implemented  some  hacks  to  work  with  the  very very old
-   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.
-     * Current version (1.7.2) of this package
-     * Version 1.5.1 of this package
-     * Version 1.4.1 of this package
-     * Version 1.3.3 of this package
-     * Version 1.2.1 of this package
-     * Version 1.1 of this package
-     * Initial version (1.0) of this package
+   I have tested the package with a native GNU Emacs 19.34.1 and
+   XEmacs 20.4.  I implemented some hacks to work with the very very
+   old 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.
 
    I  you  want  to  know  more  about the differences please look at the
    ChangeLog.
                              Unpacking the archive
 
    The package is distributed as tar.gz file. You unpack it using:
-gzip -dc dictionary-1.7.2.tar.gz | tar xf -
+
+gzip -dc dictionary-1.8.5.tar.gz | tar xf -
 
    or
-tar -xzf dictionary-1.7.2.tar.gz
+
+tar -xzf dictionary-1.8.5.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.7.2 has been created
+   unpacking  the  archive  a directory dictionary-1.8.5 has been created
    containing the necessary files.
 
                                  Installation
 
 Debian
 
-   If  you  are using a current Debian distribution (one that support the
-   emacsen  package  system) and have the dpkg-dev installed (for running
-   dpkg-buildpackage) you can use the supplied debian support.
+   If you are using a current Debian distribution (one that support
+   the emacsen package system) and have the build-essential, dpkg-dev,
+   and debmake packages installed (for running dpkg-buildpackage) you
+   can use the supplied debian support.
+
 make debian
 
-   This  will  create  a  package  named  dictionary-1.7.2-1_i386.deb  or
-   similiar  in  the  parent  directory  of dictionary-1.7.2. You can now
+   This  will  create  a  package  named  dictionary-1.8.5-1_all.deb  or
+   similiar  in  the  parent  directory  of dictionary-1.8.5. 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
 
 XEmacs 21
 
    The  XEmacs  version  21  support  so  called  xemacs  packages. These
    packages are also supported, you can create them using:
+
 make EMACS=xemacs package
 
    The created package will be named dictionary-1.5-pkg.tar.gz and stored
    within  the  current  directory.  If  you  don't  want to install this
    package manually, you can use the following command, provided you have
    sufficient privileges (if unsure, login as super user):
+
 make EMACS=xemacs package-install
 
    If  you  have  more  than  one XEmacs versions installed make sure the
    package  as  Debian  package  or  XEmacs  package  you  don't need the
    autoloads,  they are already supplied. Other users I suggest using the
    following lines:
+
 (autoload 'dictionary-search "dictionary"
   "Ask for a word and search it in all dictionaries" t)
 (autoload 'dictionary-match-words "dictionary"
   "Display entries matching the word at the point" t)
 (autoload 'dictionary-tooltip-mode "dictionary"
   "Display tooltips for the current word" t)
-(autoload 'global-dictionary-tooltip-mode "dictionary"
-  "Enable/disable dictionary-tooltip-mode for all buffers" t)
+(unless (boundp 'running-xemacs)
+    (autoload 'global-dictionary-tooltip-mode "dictionary"
+      "Enable/disable dictionary-tooltip-mode for all buffers" t))
 
    In  addition, some key bindings for faster access can be useful. I use
    the following ones in my installation:
+
 ;; key bindings
 (global-set-key "\C-cs" 'dictionary-search)
 (global-set-key "\C-cm" 'dictionary-match-words)
    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.
 
-   A  new  feature of version 1.5 is the tool-tip support. This will only
-   work  in  GNU  Emacs  21,  XEmacs  uses  a different mechanism (called
-   balloon  help)  which  can  not  easily  be  adapted. Please note, the
-   tool-tip mode may slow down your Emacs, especially if you prefer using
-   the mouse.
+   A new feature of version 1.5 is the tool-tip support. This will
+   only work in GNU Emacs 21. Starting from version 1.8.5 this feature
+   is also available in XEmacs. Please note, the tool-tip mode may
+   slow down your Emacs, especially if you prefer using the mouse.
 
-   First  you  have  to  define  the  dictionary  for looking up words to
-   display  in  the  tool-tip  window.  You  could use * to search in all
-   dictionaries, however tool-tip window should be rather small. I use an
-   english  to german dictionary for myself, which is called eng-deu (you
-   can find out the name if you look into contents of the square brackets
-   within  the  dictionary buffer; for example, the line From WordNet (r)
-   1.6[wn]: tells you the name of this dictionary is wn).
-(setq dictionary-tooltip-dictionary "eng-deu")
+   First you have to define the dictionary for looking up words to
+   display in the tool-tip window. You could use * to search in all
+   dictionaries, however tool-tip window should be rather small. I use
+   an english to german dictionary for myself, which is called eng-deu
+   (you can find out the name if you look into contents of the square
+   brackets within the dictionary buffer; for example, the line From
+   WordNet (r) 1.6[wn]: tells you the name of this dictionary is wn).
 
-   Next  you  have  to decide if you want tool-tip support in the current
-   buffer   only   or   in   all   buffers.   For   the   first  use  the
-   dictionary-tooltip-mode       command,       for       the      latter
-   global-dictionary-tooltip-mode.
-;; choose on of the following lines
-(global-dictionary-tooltip-mode 1)
-(dictionary-tooltip-mode 1)
+      (setq dictionary-tooltip-dictionary "eng-deu")
+    
 
-   To  turn the tool-tip support off, call these functions with a numeric
-   argument of 0.
+   In the GNU Emacs implemention you can decide to activate the
+   tool-tip support either globally (global-dictionary-tooltip-mode)
+   or local to a buffer (dictionary-tooltip-mode).
+
+;; global dictionary-mode
+(global-dictionary-tooltip-mode)
+;; activate for all text-based modes
+(add-hook 'text-mode-hook 'dictionary-tooltip-mode)
+    
+
+   In XEmacs only the local version (dictionary-tooltip-mode) is
+   available.
+
+;; activate for all text-based modes
+(add-hook 'text-mode-hook 'dictionary-tooltip-mode)
+
+   To turn the tool-tip support off, call these functions with a
+   numeric argument of 0.
+
+   The mode line includes a Dict marker if this minor mode is active.
 
    If  you  get  an error message that the server could not be contacted,
    please  check  the  values  of  the  variables  dictionary-server  and
    You  should  have  received  a  copy of the GNU General Public License
    version 2 along with this package; see the file GPL.
 
-                                  ChangeLogs
-
-Version 1.7.1 - 1.7.2
-
-     * link.el  (link-initialize-keymap):  fixed keybinding bug (reported
-       by David A. Panariti)
-
-Version 1.7 - 1.7.1
-
-     * fixed  mule-detection in dictionary-coding-system (patch submitted
-       by Robert Pluim)
-
-Version 1.5.1 - 1.7
-
-     * added HTTP proxy support (using the CONNECT method)
-     * added  support for dictionaries not encoded in utf-8 (suggested by
-       Eugene Morozov)
-
-Version 1.5 - 1.5.1
-
-     * fixed bug with non-working dictionary-previous (found by Rui Zhu)
-     * fixed key bindings in link.el
-
-Version 1.4.1 - 1.5
-
-     * tool-tip support for GNU Emacs 21
-
-Version 1.4 - 1.4.1
-
-     * changed recognition of utf-8 support (suggested by Enrico Scholz)
-
-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
-       those users (suggested and reviewed by Enrico Scholz)
-
-Version 1.3.1 - 1.3.2
-
-     * replaced   set-text-properties   by   remove-text-properties   and
-       add-text-properties  because  this  function  is  not  recommended
-       within XEmacs (reported by Serge Boiko)
-
-Version 1.3 - 1.3.1
-
-     * small  fix in dictionary function to check for availability of the
-       utf-8  encoding  to  prevent  problems  in certain xemacs versions
-       (reported by Jeff Mincy)
-     * added debian support (use dpkg-buildpackage to build a package)
-
-Version 1.2.1 - 1.3
-
-     * Implemented an automatic detection for line ends CR/LF and LF. The
-       variable  connection-broken-end-of-line is no longer necessary and
-       its value ignored.
-     * Added  utf-8  support,  the native character set of the dictionary
-       protocol.  Using  ISO-8859-1  (aka  latin-1)  was just a necessary
-       work-around.
-
-Version 1.2 - 1.2.1
-
-     * Corrected dictionary command to draw the button bar.
-     * Improved documentation on dictionary to explicitly mention the use
-       of multiple buffers.
-
-Version 1.1.1 - 1.2
-
-     * Some  users  reported  problems with GNU Emacs 20.3 and MULE. So I
-       introduced  a  new  variable  connection-broken-end-of-line  which
-       controls whether a line is ended by \n or by \r\n. You can use the
-       customize-group command on dictionary to change the setting of the
-       variable.
-
-Version 1.1 - 1.1.1
-
-     * dictionary-search now allows editing the word to search for
-     * dictionary-search-word-near-point  has  been  removed, you can use
-       dictionary-lookup-definition     instead.    It    behaves    like
-       dictionary-search but don't allow the search word to be edited (to
-       speed up looking up words).
-
-Version 1.0 - 1.1
-
-     * all dictionary buffers now share a single connection
-     * added kill-all-local-variables
-     * use cons instead of list where possible
-     * dictionary-search now:
-          + use     word    as    point    as    default    (implementing
-            dictionary-search-word-near-point too)
-          + asks for dictionary with prefix argument
-     * added help-echo tags which are used in XEmacs
-     * mark has been replaced by generic marker
-     * added  messages  for  communications to the dictionary server that
-       may take a while
-     * fixed bug with going to the previous link
-     * replaced word-at-point by current-word
-     _________________________________________________________________
-
    E-Mail: dictionary@myrkr.in-berlin.de
-   Last modified: Fri Dec 21 18:51:23 CET 2001