Xfce Wiki

Sub domains
 

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
apps:xfce4-dict:start [2020/08/09 00:30] – updated bug reporting section for consistency kevinbowenapps:xfce4-dict:start [2025/05/20 15:24] (current) – [Using a local dictionary server] Replace broken link andreldm
Line 14: Line 14:
 ---- ----
  
-===== About =====+===== Introduction =====
  
-This program allows you to search different kinds of dictionary services +xfce4-dict allows you to search different kinds of dictionary services for words or phrases and shows you the result. 
-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
-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. aspell/ispell program.
  
-xfce4-dict contains a stand-alone application called "xfce4-dict" and a +xfce4-dict contains a stand-alone application called "xfce4-dict" and a panel plugin for the Xfce panel.
-panel plugin for the Xfce panel.+
  
 ---- ----
Line 29: Line 26:
 ===== Screenshots ===== ===== Screenshots =====
  
-<figure "The main window"> +<figure "Main xfce4-dict Window"> 
-{{:apps:xfce4-dict:xfce4-dict-main-dict.png?600|}}  +{{:apps:xfce4-dict:xfce4-dict-main-dict.png?575|Main xfce4-dict Window}}  
 </figure> </figure>
  
-<figure "The main window showing some results containing cross references and the search history"> +<figure "Main xfce4-dict window showing some results containing cross references and the search history"> 
-{{:apps:xfce4-dict:xfce4-dict-main-dict-2.png?600|}}+{{:apps:xfce4-dict:xfce4-dict-main-dict-2.png?575|Main xfce4-dict window showing some results containing cross references and the search history}}
 </figure> </figure>
  
-<figure "The main window showing a failed search and spelling suggestions fall back"> +<figure "Main xfce4-dict window showing a failed search and spelling suggestions fall back"> 
-{{:apps:xfce4-dict:xfce4-dict-main-spell.png?600|}}+{{:apps:xfce4-dict:xfce4-dict-main-spell.png?575|Main xfce4-dict window showing a failed search and spelling suggestions fall back}} 
 +</figure> 
 + 
 +<figure "xfce4-dict Speed Reader Window"> 
 +{{:apps:xfce4-dict:xfce4-dict_speed_reader.png|xfce4-dict Speed Reader Window}}   
 +</figure> 
 + 
 +<figure "xfce4-dict Preferences General Tab"> 
 +{{:apps:xfce4-dict:xfce4-dict_preferences_general.png|xfce4-dict Speed Preferences General Tab}}   
 +</figure> 
 + 
 +<figure "xfce4-dict Preferences Dictionary Server Tab"> 
 +{{:apps:xfce4-dict:xfce4-dict_preferences_dictionary_server.png|xfce4-dict Preferences Dictionary Server Tab}} 
 +</figure> 
 + 
 +<figure "xfce4-dict Preferences Web Service Tab"> 
 +{{:apps:xfce4-dict:xfce4-dict_preferences_web_service.png|xfce4-dict Preferences Web Service Tab}}   
 +</figure> 
 + 
 +<figure "xfce4-dict Preferences Spell Checker Tab"> 
 +{{:apps:xfce4-dict:xfce4-dict_preferences_spell_checker.png|xfce4-dict Preferences Spell Checker Tab}}  
 </figure> </figure>
  
Line 46: Line 63:
 ==== xfce4-dict command ==== ==== xfce4-dict command ====
  
-If the panel plugin is loaded, the xfce4-dict command just opens the +If the panel plugin is loaded, the xfce4-dict command just opens the already loaded main window of the panel plugin (replacement for the
-already loaded main window of the panel plugin (replacement for the+
 former ''xfce4-popup-dict'' command). former ''xfce4-popup-dict'' command).
-If the panel plugin is not loaded, xfce4-dict opens the application +If the panel plugin is not loaded, xfce4-dict opens the application normally.
-normally.+
  
-xfce4-dict understand a few command line options, for details read its +xfce4-dict understand a few command line options, for details read its manpage or call: ''xfce4-dict --help''.
-manpage or call: ''xfce4-dict --help''.+
  
-It can also be used to bind the dict plugin actions to a keyboard +It can also be used to bind the dict plugin actions to a keyboard shortcut. 
-shortcut. You can add a new keyboard command with the Keyboard settings +You can add a new keyboard command with the Keyboard settings plugin in Xfce's settings manager and assign ''xfce4-dict'' as the action
-plugin in Xfce's settings manager and assign ''xfce4-dict'' as the action+
 command. command.
  
-Please note: +**Please note:** there is a limitation of max. 12 characters in passing a search term to xfce4-dict when the panel plugin is loaded. 
-There is a limitation of max. 12 characters in passing a search term +That is, if pass a search term as command line argument(s) to xfce4-dict which is longer than 12 characters, it is truncated. 
-to xfce4-dict when the panel plugin is loaded. That is, if pass a search +To be exact, the limit is 12 bytes so if the search term contains any non-ASCII characters it might be even less than 12 characters. 
-term as command line argument(s) to xfce4-dict which is longer than 12 +To work around this limitation, you can add the command line '-i' so that xfce4-dict will start a single stand-alone application. 
-characters, it is truncated. To be exact, the limit is 12 bytes so if +Then all passed text is used as search term.
-the search term contains any non-ASCII characters it might be even less +
-than 12 characters. +
-To work around this limitation, you can add the command line '-i' so +
-that xfce4-dict will start a single stand-alone application. Then all +
-passed text is used as search term.+
  
  
 ==== Panel Plugin ==== ==== Panel Plugin ====
  
-With the panel plugin enabled, you can also easily select a word in an +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.
-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.+
  
 +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.
  
 [[|Back to Top]] [[|Back to Top]]
Line 88: Line 92:
 ==== Query a Dict server ==== ==== Query a Dict server ====
  
-You can query a dictionary server(see RFC 2229) to search for the +You can query a dictionary server(see RFC 2229) to search for the translation or explanation of a word. 
-translation or explanation of a word. You can also choose a dictionary +You can also choose a dictionary offered by the server to improve your search results.
-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.+
  
-This program was mainly tested with the server ''dict.org'' but should +There are two special dictionaries: 
-work with any other servers which implement the DICT protocol defined +  * ''*'' - use this dictionary to search in all available dictionaries on the server 
-in RFC 2229.+  * ''!'' - use this dictionary to search in all available dictionaries on the server but stop searching after the first match. 
 + 
 +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.
  
 ==== Search result highlighting ==== ==== Search result highlighting ====
  
-Sometimes definitions in certain dictionaries contain special markups +Sometimes definitions in certain dictionaries contain special markups to give additional information. 
-to give additional information. Two of them are:+ 
 +Two of them are:
   * Cross-references   * Cross-references
-These are some kind of links in definitions to link to other definitions. +    * These are some kind of links in definitions to link to other definitions. 
-Xfce4-dict will highlight these definitions and make them clickable to easily jump (by searching) to this highlighted definition.+    * Xfce4-dict will highlight these definitions and make them clickable to easily jump (by searching) to this highlighted definition.
   * Phonetic hints   * Phonetic hints
-These are mostly phonetic spellings found in translation dictionaries to illustrate how a word is pronounced.Xfce4-dict will highlight these with a green colour. +    * These are mostly phonetic spellings found in translation dictionaries to illustrate how a word is pronounced. 
 +    * Xfce4-dict will highlight these with a green color.
  
 ==== Using a local dictionary server ==== ==== Using a local dictionary server ====
  
-Instead of using remote dictionary servers like ''dict.org'' which +Instead of using remote dictionary servers like ''dict.org'' which always need a network connection and then still might be slow, you can also run your own dictionary server on your machine. 
-always need a network connection and then still might be slow, +This way you always have fast access and you can install all the dictionaries you need.
-you can also run your own dictionary server on your machine. This +
-way you always have fast access and you can install all the +
-dictionaries you need.+
  
-Most distributions provide a package called ''dictd'' which contains +Most distributions provide a package called ''dictd'' which contains the server. 
-the server. Additionally you should install some dictionaries you +Additionally you should install some dictionaries you need like WordNet, Jargon or some translation dictionaries. 
-need like WordNet, Jargon or some translation dictionaries. On +On Debian and Ubuntu-like systems these packages are called ''dict-wn'' (WordNet), ''dict-jargon'', ''dict-de-en'' or similar. 
-Debian and Ubuntu-like systems these packages are called ''dict-wn'' +Basically it is enough to install the ''dictd'' packages along with some dictionaries to get a running local server. 
-(WordNet), ''dict-jargon'', ''dict-de-en'' or similar. Basically it is enough +In the Xfce4-dict preferences dialog, simply use ''localhost'' as the server name.
-to install the ''dictd'' packages along with some dictionaries to get +
-a running local server. In the Xfce4-dict preferences dialog, +
-simply use ''localhost'' as the server name. +
- +
-If you need more information about setting up a local dictionary server, +
-please see http://docs.kde.org/kde3/en/kdenetwork/kdict/dictd-mini-howto.html.+
  
 +If you need more information about setting up a local dictionary server, please see https://wiki.archlinux.org/title/Dictd#Configuration.
  
 ==== Web-based dictionaries ==== ==== Web-based dictionaries ====
  
-Searching web-based dictionary services like dict.leo.org or other ones +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 
-is also supported by passing the search word as a URL argument and +opening the URL in your web browser. 
-opening the URL in your web browser. The URL can be configured in the +The URL can be configured in the preferences dialog.
-preferences dialog.+
  
 A note on the started web browser: A note on the started web browser:
-xfce4-dict will open the configured URL with the ''exo-open'' command +xfce4-dict will open the configured URL with the ''exo-open'' command which will open the configured default browser. 
-which will open the configured default browser. If that doesn't work +If that doesn't work other known browsers are tried. 
-other known browsers are tried. But it's better to set a default browser +But it's better to set a default browser using "Preferred Applications" in the Xfce settings manager.
-using "Preferred Applications" in the Xfce settings manager. +
  
 ==== Spell checking based search ==== ==== Spell checking based search ====
  
-It is also possible to verify the spelling of word using spell checking +It is also possible to verify the spelling of word using spell checking programs like enchant or aspell (or its predecessor ispell). 
-programs like enchant or aspell (or its predecessor ispell). +To get this working you need to have the enchant, aspell or ispell binary in your binary search path and at least one dictionary working. 
-To get this working you need to have the enchant, aspell or +If you have multiple dictionaries installed, you can select the one to use in the preferences dialog.
-ispell binary in your binary search path and at least one dictionary +
-working. If you have multiple dictionaries installed, you can +
-select the one to use in the preferences dialog. +
  
 ====  Speed Reader ====  ====  Speed Reader ==== 
  
-With the builtin Speed Reader you can train and improve your +With the builtin Speed Reader you can train and improve your skills in fast reading texts. 
-skills in fast reading texts. You just specify a text, define +You just specify a text, define how many words should be displayed at once (word grouping) and how many words should be displayed per minute (speed rate).
-how many words should be displayed at once (word grouping) +
-and how many words should be displayed per minute (speed rate).+
 Then the words of the specified text are displayed so you can read them. Then the words of the specified text are displayed so you can read them.
 The higher the speed rate is the faster you can read. The higher the speed rate is the faster you can read.
Line 168: Line 154:
  
 ==== Latest Release ==== ==== Latest Release ====
-==== 0.8.3 (20191007) ==== 
-[[https://archive.xfce.org/src/apps/xfce4-dict/0.8/xfce4-dict-0.8.3.tar.bz2|xfce4-dict-0.8.3.tar.bz2]] 
  
 +{{rss>https://archive.xfce.org/feeds/project/xfce4-dict 1 date 2h}}
 +
 +[[https://gitlab.xfce.org/apps/xfce4-dict/-/blob/master/NEWS|Read the CHANGELOG]]
 +
 +  * **[[https://archive.xfce.org/src/apps/xfce4-dict/|Download current release]]** (older versions of this component are also available here)
 +
 +[[|Back to Top]]
  
 ===== Dependencies ===== ===== Dependencies =====
-  * Xfce4-panel 4.10.0 +  * glib 2.66.0 
-  * Libxfce4ui 4.10.0+  * gtk 3.24.0 
 +  * xfce4-panel 4.18.0 
 +  * libxfce4ui 4.18.0 
 +  * libxfce4util 4.18.0
  
 ---- ----
Line 184: Line 178:
  
 ===== Reporting Bugs ===== ===== Reporting Bugs =====
 +  * **[[:apps:xfce4-dict:bugs|Reporting Bugs]]** -- List of currently open bugs and instructions on how to submit new bug reports
  
-If you encounter a bug in ''xfce4-dict'', your way of helping things getting fixed is to report a bug about it in [[https://gitlab.xfce.org/explore/groups?sort=name_desc|Xfce GitLab]]. Please note that to do this you will need to have / create an account. 
- 
-<note important>Before reporting a new bug, please try your best to check if it has already been reported (see the latest reports below). [[https://gitlab.xfce.org/apps/xfce4-dict/-/issues|Click here for a full list of bug reports]].</note>  
- 
- 
-===== Report a new bug ===== 
- 
-If your bug has not been reported before, please [[https://gitlab.xfce.org/apps/xfce4-dict/-/issues/new|submit a new bug report]].  
- 
-When writing your bug report, try to be as descriptive as possible, but avoid verbosity; Mozilla has a nice guide on [[https://developer.mozilla.org/en-US/docs/Mozilla/QA/Bug_writing_guidelines|how to write a bug report]]. 
- 
-For more information, see [[https://docs.xfce.org/contribute/bugs/start|Bug Reporting and Fixing]]. 
- 
-**[[https://gitlab.xfce.org/apps/xfce4-dict/-/issues/new|File a new bug or enhancement request]]** 
- 
----- 
-==== Open Bugs ==== 
-Here's a list (updated daily) of open bug reports with the date that bug was reported in parenthesis. 
- 
-{{rss>https://gitlab.xfce.org/apps/xfce4-dict/-/issues.atom?state=opened 20 1d date}} 
-[[|Back To Top]] 
  
 +[[|Back to Top]]
 ---- ----
-[[:start|Back to main Xfce documentation page]]+[[:start|Return to Xfce Main Documentation Page]]