<!DOCTYPE article PUBLIC "-//GNOME//DTD DocBook PNG Variant V1.1//EN"[
       
<!ENTITY version "1.4">
       
]>



<!-- =============Document Header ============================= -->

<article id="index"> <!-- please do not change the id -->

  <artheader>
    <title>GDict Manual</title>
    <copyright>
      <year>2000</year>
      <holder>John Fleck</holder>
    </copyright>

    <!-- translators: uncomment this:

  <copyright>
  <year>2000</year>
  <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
  </copyright>

    -->

    <legalnotice id="legalnotice">
      <para>Permission is granted to copy, distribute and/or modify this document
	under the terms of the <ulink type="help"
	url="gnome-help:fdl"><citetitle>GNU Free Documentation
	    License</citetitle></ulink>, Version 1.1 or any later version 
	published by the Free Software Foundation with no Invariant Sections, 
	no Front-Cover Texts, and no Back-Cover Texts.  A copy of the license
	can be found <ulink type="help" url="gnome-help:fdl">here</ulink>.
      </para>
      <para>Many of the names used by companies to distinguish their products and
	services are claimed as trademarks. Where those names appear in any
	GNOME documentation, and those trademarks are made aware to the members
	of the GNOME Documentation Project, the names have been printed in caps
	or initial caps.
      </para>
    </legalnotice>
 


    <!-- this is version of manual, not application -->
    <releaseinfo>
      This is version 1.0 of GDictmanual.
    </releaseinfo>

  </artheader>

  <!-- ============= Document Body ============================= -->
  
  <!-- ============= Introduction ============================== -->
  <sect1 id="intro">
    <title>Introduction</title>

    <para>
      <application>GDict</application> provides dictionary definitions of words,
      using any server that supports the <emphasis>dict</emphasis> protocol, an
      Internet standard for client/server dictionary applications.
    </para>

    <para>
      To run <application>GDict</application>, select
      <guimenuitem>GDict</guimenuitem> from the
      <guisubmenu>Utilities</guisubmenu> submenu of the <guimenu>Main
      Menu</guimenu>, or type <command>gdict -a</command> on the command line.
    </para>

    <para>
      <application>GDict</application> can also be started via a panel
      applet. To add this applet to a <interface>Panel</interface>, right-click
      on the panel and choose
      <menuchoice>
	<guimenu>Applets</guimenu>
	<guisubmenu>Utility</guisubmenu>
	<guimenuitem>GDict</guimenuitem>
      </menuchoice>, or type <command>gdict</command> on the command line.
    </para>
    <para>
      <application>GDict</application> is included in the
      <filename>gnome-utils</filename> package, which is part of the GNOME
      desktop environment. This document describes version &version; of
      <application>GDict</application>.
    </para>
    
  </sect1>


  <!-- ================ Usage ================================ -->
  <!-- This section should describe basic usage of the application. -->

  <sect1 id="usage">
    <title>Using GDict</title>
    <para>
      <application>GDict</application> can be used to obtain dictionary
      definitions of words from local or remote dictionary servers. It can check
      spelling and look up words based on imprecise spelling using various
      pattern matching techniques. This section describes basic usage of
      <application>GDict</application>.
    </para>

    <!-- ========= Basic Usage =========================== -->
    <sect2 id="mainwin">
      <title>Basic usage</title>
      <para>
	Starting <application>GDict</application> opens  the <interface>Main
	  window</interface>, shown in <xref linkend="mainwindow-fig">.
	<!-- ==== Figure ==== -->
	<figure id="mainwindow-fig">
	  <title>GDict Main Window</title>
	  <screenshot>
	    <screeninfo>GDict Main Window</screeninfo>
	    <graphic fileref="figures/gdictmain" format="png"
		     srccredit="John Fleck">
	    </graphic>
	  </screenshot>
	</figure>
	<!-- ==== End of Figure ==== -->

      </para>
      
      <para>
	<application>GDict</application> automatically connects to its default
	server, giving you an error message if it is unable to connect.
      </para>
      <para>
	To get a definition of a word, type the word in the text bar
	immediately below the toolbar, and click on the
	<guibutton>Look up</guibutton> button on the toolbar or the
	<keycode>Enter</keycode> or <keycode>Return</keycode> key.
      </para>

      <para>
	<application>GDict</application> connects to the server and, if a
	definition is found, returns it in the main text window.
      </para>
      <para>
	If no word is found, <application>GDict</application> will automatically
	open its spell check window and run a spell check on it. More
	information on spell-checking is available in <xref linkend="spelling">
      </para>

      <para>
	If you type in a search string using regular expressions,
	<application>GDict</application> opens the spell-checking window and
	begins a search for words matching the pattern typed. For example,
	typing <command>^h[ie]ll</command> returns "hell," "hill," and all words
	beginning in "hill" or "hell". Regular
	expressions are a powerful pattern-matching technique that are beyond
	the scope of this document. Details can be found in the <ulink type="man"
								       url="man:grep">manual for
	<application>grep</application></ulink>.
      </para>

      <para>By default, <application>GDict</application> uses the server at
	dict.org and searches all of its databases for a word that is a perfect
	match for the word you typed in. You can change the server in use, the
	databases it searches and the search strategy (allowing it to search for
	wound-alike words, for example, or use wildcards) in the preferences
	dialog, shown in <xref
								linkend="preferences-fig">.
      </para>

    </sect2>
    <sect2 id="spelling">
      <title>Spelling</title>
      <para>
	If you type in a word and click on the toolbar button labeled
	  <guibutton>spell</guibutton>, <application>GDict</application> opens
	  the <interface>spell checker window</interface>, shown in <xref
	  linkend="spellwindow-fig">.
	<!-- ==== Figure ==== -->
	<figure id="spellwindow-fig">
	  <title>GDict Spell Checker Window</title>
	  <screenshot>
	    <screeninfo>GDict Spell Checker Window</screeninfo>
	    <graphic fileref="figures/gdict-spell" format="png"
		     srccredit="John Fleck">
	    </graphic>
	  </screenshot>
	</figure>
	<!-- ==== End of Figure ==== -->

      </para>

      <para>This window returns a list of possible spellings, based on a search
	strategy for similar words. The search is executed on the server, not by
	<application>GDict</application>, and the types of search strategies
	available vary. A pull-down menu showing the various strategies
	available on the server is labelled <guilabel>Search
	Strategy</guilabel>. This menu allows you to change search strategies
	and conduct a new search by clicking on <guibutton>Find
	Words</guibutton>.</para>

      <para>
	In the <interface>spell checker window</interface>, you can also look up
	a word once you've found a correct spelling. To do so, click on the
	word, then click on <guibutton>Look up Word</guibutton>. The
	definition will appear in the program's main window.
      </para>

    </sect2>


    <!-- This section should also describe main elements of graphic user
    interface, such as menus and buttons, unless this description
    is too long - in that case, it should be moved to a separate
    section. For example -->


    <!-- ========= Menus =========================== -->
    <sect2 id="menubar">
      <title>Menus</title>
      <para>
	The menu bar, located at the top of the <interface>Main
	Window</interface>, contains the following menus:
      </para>

      <variablelist>
	<varlistentry>
	  <term><guimenu>File</guimenu></term>
	  <listitem>
	    <para>
	      This menu contains:
	      <menuchoice>
        
		<guimenuitem>Look up</guimenuitem>
	      </menuchoice> which looks up a word,
	      <menuchoice>
		
		<guimenuitem>Spell</guimenuitem>
	      </menuchoice> which launches a spelling help window, and
	      <guimenuitem>Exit</guimenuitem> which is self-explanatory.
	    </para>
	  </listitem>
	</varlistentry>
	
	<varlistentry>
	  <term><guimenu>Edit</guimenu></term>
	  <listitem>
	    <para>
	      This menu contains nothing.
	    </para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term><guimenu>Settings</guimenu></term>
	  <listitem>
	    <para>
	      This menu contains <guimenuitem>Preferences</guimenuitem>,
	      which opens the <link linkend="prefs"><interface>Preferences
	      Dialog</interface></link>.
	    </para>
	  </listitem>
	</varlistentry>

	<varlistentry>
	  <term><guimenu>Help</guimenu></term>
	  <listitem>
	    <para>
	      This menu contains:
	      <itemizedlist>
		<listitem>
		  <para>
		    <guimenuitem>Manual</guimenuitem> &mdash; shows this manual.
		  </para>
		</listitem>

		<listitem>
		  <para>
		    <guimenuitem>About</guimenuitem> &mdash; shows basic
		    information about <application>GDict</application>, such as
		    the author's name and the application version number.
		  </para>
		</listitem>
	      </itemizedlist>

	    </para>
	  </listitem>
	</varlistentry>
      </variablelist>
    </sect2>
  </sect1>


  <!-- ============= Customization ============================= -->
  <sect1 id="prefs">
    <title>Customization</title>
    <para>
      To change the application settings, select
      <guimenuitem>Preferences</guimenuitem> from the
      <guimenu>Settings</guimenu> menu. This opens the
      <interface>Preferences</interface> dialog, shown in <xref
								linkend="preferences-fig">.
    </para>

    <figure id="preferences-fig">
      <title>Preferences Dialog</title>
      <screenshot>
	<screeninfo>Preferences dialog</screeninfo>
	<graphic fileref="figures/gdict-prefs" format="png"
	     srccredit="John Fleck">
	</graphic>
      </screenshot>
    </figure>

    <tip>
      <title>TIP</title>
      <para>
	When opening the <guilabel>Preferences dialog</guilabel>,
	<application>GDict</application> conducts a brief conversation with the
	server selected, then customizes the listing in the dialog according to
	the server's capabilities. The dialog shown above uses the default
	server, www.dict.org.
      </para>
    </tip>
    <para>
      The properties in the <guilabel>Server</guilabel> tab are:
      <itemizedlist>

	<listitem>
	  <para>
	    Server &mdash; The name of the server used by
	    <application>GDict</application>. www.dict.org is the default. You
	    may use any other server that supports the Internet "dict"
	    protocol.
	  </para>
	</listitem>

	<listitem>
	  <para>
	    Port &mdash; The port number <application>GDict</application> uses
	    to connect. 2628 is the standard.
	  </para>
	</listitem>

	<listitem>
	  <para>
	    Database: &mdash; In its initial conversation with the selected
	    server, <application>GDict</application> downloads a list of
	    dictionary databases available for searching. This pull-down menu
	    allows you to select one or all of the databases for your searches.
	  </para>
	</listitem>

	<listitem>
	  <para>
	    Default strategy: &mdash;  In its initial conversation with the selected
	    server, <application>GDict</application> downloads a list of search
	    strategies available on the server. This pull-down menu selects the
	    default strategy to be used for spell-checking, or when you type in
	    a string that does not exactly match a word in the dictionary
	    database being searched.
	  </para>
	</listitem>

      </itemizedlist>
    </para>
    
    <para>
      The properties in the <guilabel>Fonts</guilabel> tab are:
      <itemizedlist>

    

	<listitem>
	  <para>
	    Headword, Pronunciation, Etymology, Example, Main Body, Sub-number, Part
	    of Speech and Cross-reference &mdash; When
	    <application>GDict</application> returns a definition, it uses
	    different fonts and colors to distinguish the various parts of the
	    definition returned. This tab allows you to customize those fonts
	    and colors.
	  </para>
	  <para>Clicking on the "ABC" icon next to each item opens a standard
	  GNOME font selection window. Clicking on the colored box next to each
	  item opens a standards GNOME color selection window.</para>
    </listitem>
   </itemizedlist>
  </para>

  <para>
    After you have made all the changes you want, click on
      <guibutton>OK</guibutton> to apply the changes and close the
      <interface>Properties</interface> dialog. To cancel the changes and return
      to previous values, click the <guibutton>Cancel</guibutton> button.
  </para>

  </sect1>






<!-- ============= Authors ================================ -->

  <sect1 id="authors">
    <title>Authors</title>
  <para>
   <application>GDict</application> was written by Spiros Papadimitriou
      (<email>spapadim+@cs.cmu.edu</email>, Mike Hughes
      (<email>mfh@psilord.com</email>) and Bradford Hovinen
      (<email>hovinen@helixcode.com</email>). To find more information about
      <application>GDict</application>, please visit the <ulink
								url="http://gdict.dhs.org" type="http">GDict Web page</ulink>. Please send all comments, suggestions, and bug reports to the <ulink url="http://bugzilla.gnome.org" type="http">GNOME bug tracking database</ulink>. You can also use <application>Bug Report Tool</application> (<command>bug-buddy</command>), available in the <guisubmenu>Utilities</guisubmenu> submenu of <guimenu>Main Menu</guimenu>, for submitting bug reports.
  </para>

  <para>
   This manual was written by John Fleck(<email>jfleck@inkstain.net</email>). Please send
      all comments and suggestions regarding this manual to the <ulink
								       type="http" url="http://developer.gnome.org/projects/gdp">GNOME Documentation Project</ulink>  by sending an email to <email>docs@gnome.org</email>. You can also add your comments online by using the <ulink type="http" url="http://developer.gnome.org/projects/gdp/doctable/">GNOME Documentation Status Table</ulink>.
  </para>

  <!-- For translations: uncomment this:

  <para>
   Latin translation was done by ME
   (<email>MYNAME@MYADDRESS</email>). Please send all  comments  and
   suggestions regarding this translation to SOMEWHERE.
  </para>

  -->

 </sect1>


 <!-- ============= Application License ============================= -->

 <sect1 id="license">
  <title>License</title>
    <para>
      This program is free software; you can redistribute it and/or
      modify it under the terms of the  <ulink type="help" url="gnome-help:gpl">
	<citetitle>GNU General Public License</citetitle></ulink> as
      published by the Free Software Foundation; 
      either version 2 of the License, or (at your option) any later
      version.
    </para>
    <para>
      This program is distributed in the hope that it will be useful, but WITHOUT
      ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
      FITNESS FOR A PARTICULAR PURPOSE.  See the <citetitle>GNU General Public
	License</citetitle> for more details.
    </para>
    <para>
      A copy of the <citetitle>GNU General Public License</citetitle> is included
      as an appendix to the <citetitle>GNOME Users Guide</citetitle>.  You may
      also obtain a copy of the <citetitle>GNU General Public
	License</citetitle> from the Free Software Foundation by visiting <ulink
										 type="http" url="http://www.fsf.org">their Web site</ulink> or by writing to <address> Free Software Foundation, Inc. <street>59 Temple Place</street> - Suite 330 <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode> <country>USA</country> </address>
  </para>
 </sect1>
</article>





