[Goodies-commits] r4576 - xfce4-dict/trunk

[Enrico Troeger]

Author: enrico
Date: 2008-04-15 14:02:04 +0000 (Tue, 15 Apr 2008)
New Revision: 4576

Modified:
   xfce4-dict/trunk/README
Log:
Update Readme.


Modified: xfce4-dict/trunk/README
===================================================================
--- xfce4-dict/trunk/README	2008-04-14 22:24:01 UTC (rev 4575)
+++ xfce4-dict/trunk/README	2008-04-15 14:02:04 UTC (rev 4576)
@@ -1,35 +1,83 @@
-xfce4-dict-plugin - A plugin to query a Dict server and other dictionary sources
+xfce4-dict - A client program to query different dictionaries
+-------------------------------------------------------------
 
-With this plugin you can query a dictionary server(see RFC 2229) to search for the
-translation or explanation of a word. You can also choose a dictionary offered by the
-server to improve your search results.
+This program allows you to search different kinds of dictionary services
+for words or phrases and shows you the result.
+Currently you can query a "Dict" server(RFC 2229), any online dictionary
+service by opening a web browser or search for words using the
+aspell/ispell program.
+
+xfce4-dict contains a stand-alone application called "xfce4-dict" and a
+panel plugin for the Xfce panel.
+
+
+"xfce4-dict" command
+--------------------
+
+If the panel plugin is loaded, the xfce4-dict command just opens the
+already loaded main window of the panel plugin (replacement for the
+former "xfce4-popup-dict" command).
+If the panel plugin is not loaded, xfce4-dict opens the application
+normally.
+
+xfce4-dict understand a few command line options, for details read its
+manpage or call: "xfce4-dict --help".
+
+It can also be used to bind the dict plugin actions to a keyboard
+shortcut. You can add a new keyboard command with the Keyboard settings
+plugin in Xfce's settings manager and assign "xfce4-dict" as the action
+command.
+
+
+Panel Plugin
+------------
+
+With the panel plugin enabled, you can also easily select a word in an
+email or on a webpage and drag it onto the dict icon in your panel, then
+the plugin begins to search and shows you the results.
+
+The plugin also provides a text field within the panel to directly enter
+text to search for. To start the search simply press the Enter key in
+the text field.
+
+
+"Dict" server
+-------------
+
+You can query a dictionary server(see RFC 2229) to search for the
+translation or explanation of a word. You can also choose a dictionary
+offered by the server to improve your search results.
 There are two special dictionaries:
-* - use this dictionary to search in all available dictionaries on the server
-! - use this dictionary to search in all available dictionaries on the server but
-    stop searching after the first match.
+* - use this dictionary to search in all available dictionaries on the
+    server
+! - use this dictionary to search in all available dictionaries on the
+    server but stop searching after the first match.
 
-You can also easily select a word in an email or on a webpage and drag it onto the dict
-icon in your panel, then the plugin begins to search and shows you the results.
+This program was mainly tested with the server "dict.org" but should
+work with any other servers which implement the DICT protocol defined
+in RFC 2229.
 
-This plugin was mainly tested with the server "dict.org" but should work with any other
-servers which implement the DICT protocol defined in RFC 2229.
 
-Searching web-based dictionary services like dict.leo.org or other ones is also supported
-by passing the search word as a URL argument and opening the URL in your webbrowser. The URL
-can be configured in the preferences dialog.
+Web-based dictionaries
+----------------------
 
-It is also possible to verify the spelling of word using aspell. To get this working you need
-to have the aspell binary in your binary search path and at least one dictionary working. If you
-have multiple aspell dictionaries installed, you can select the one to use in the preferences
-dialog.
+Searching web-based dictionary services like dict.leo.org or other ones
+is also supported by passing the search word as a URL argument and
+opening the URL in your web browser. The URL can be configured in the
+preferences dialog.
 
-Together with the plugin itself, a little tool named "xfce4-popup-dict" is installed which can
-be used to open the plugin's main window from the command line or from any other program.
-It can also be used to bind the dict plugin actions to a keyboard shortcut. You can add a new
-keyboard command with the Keyboard settings plugin in Xfce's settings manager and assign
-xfce4-popup-dict as the action command.
-It accepts the arguments -t and --text-field to grab the focus to the text entry field in the
-panel (if shown, it does nothing if not). If called without any arguments, it simply shows the
-plugin's main window.
-To get a list of available command line options you can also pass -h and --help as command line
-options.
+A note on the started web browser:
+xfce4-dict will open the configured URL with the "exo-open" command
+which will open the configured default browser. If that doesn't work
+other known browsers are tried. But it's better to set a default browser
+using "Preferred Applications" in the Xfce settings manager.
+
+
+Aspell/ispell based search
+--------------------------
+
+It is also possible to verify the spelling of word using aspell (or its
+predecessor ispell). To get this working you need to have the aspell or
+ispell binary in your binary search path and at least one dictionary
+working. If you have multiple aspell dictionaries installed, you can
+select the one to use in the preferences dialog.