Use yelp-tools instead of mate-doc-utils

1 files changed, 451 insertions, 0 deletions

diff --git a/mate-dictionary/help/C/index.docbook b/mate-dictionary/help/C/index.docbook
new file mode 100644
index 00000000..2cdf89de
--- /dev/null
+++ b/mate-dictionary/help/C/index.docbook
@@ -0,0 +1,451 @@
+<?xml version="1.0"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+<!ENTITY app "Dictionary">
+<!ENTITY applet "Dictionary Applet">
+<!ENTITY appversion "2.14.0">
+<!ENTITY date "January 2005">
+<!ENTITY legal SYSTEM "legal.xml">
+<!ENTITY manrevision "1.0.0">
+]>
+<!-- This file describes the Dictionary applet and application. -->
+<!-- 
+      (Do not remove this comment block.)
+  Maintained by the MATE Documentation Project
+  http://developer.mate.org/projects/gdp
+  Template version: 2.0 beta
+  Template last modified 11 April, 2002
+  
+-->
+<!-- =============Document Header ============================= -->
+<article id="index" lang="en">
+<!-- please do not change the id; for translations, change language to -->
+<!-- appropriate code -->
+  <articleinfo> 
+    <title>&app; Manual</title>
+
+    <abstract role="description">
+      <para>
+        Dictionary enables you to look up definitions and correct spellings
+        of words.
+      </para>
+    </abstract>
+    
+    <copyright>
+      <year>2005</year>
+      <holder>Emmanuele Bassi</holder>
+    </copyright>
+    
+<!-- translators: uncomment this:
+
+  <copyright>
+   <year>2006</year>
+   <holder>ME-THE-TRANSLATOR (Latin translation)</holder>
+  </copyright>
+
+   -->
+   
+    <publisher> 
+      <publishername> MATE Documentation Project </publishername> 
+    </publisher> 
+
+   &legal;
+
+    <authorgroup> 
+      <author role="maintainer"> 
+	<firstname>Emmanuele</firstname> 
+	<surname>Bassi</surname> 
+	<affiliation> 
+	  <address><email>[email protected]</email></address> 
+	</affiliation> 
+      </author> 
+
+<!-- This is appropriate place for other contributors: translators,
+      maintainers,  etc. Commented out by default.
+       <othercredit role="translator">
+	<firstname>Latin</firstname> 
+	<surname>Translator 1</surname> 
+	<affiliation> 
+	  <orgname>Latin Translation Team</orgname> 
+	  <address> <email>[email protected]</email> </address> 
+	</affiliation>
+	<contrib>Latin translation</contrib>
+      </othercredit>
+-->
+
+    </authorgroup>
+
+    <revhistory>
+      <revision> 
+	<revnumber>&app; Manual V&manrevision;</revnumber> 
+	<date>&date;</date> 
+	<revdescription> 
+	  <para role="author">Emmanuele Bassi</para>
+	  <para role="publisher">MATE Documentation Project</para>
+	</revdescription> 
+      </revision>
+    </revhistory> 
+
+    <releaseinfo>This manual describes version &appversion; of &app;.</releaseinfo> 
+    <legalnotice> 
+      <title>Feedback</title> 
+      <para>To report a bug or make a suggestion regarding the &app;
+      application or this manual, follow the directions in the
+      <ulink url="help:mate-feedback" type="help">MATE Feedback
+      Page</ulink>.</para>
+      
+<!-- Translators may also add here feedback address for translations -->
+    </legalnotice> 
+  </articleinfo> 
+
+  <indexterm> 
+    <primary>Dictionary</primary> 
+  </indexterm> 
+
+<!-- ============= Document Body ============================= -->
+<!-- ============= Introduction ============================== -->
+  <sect1 id="mate-dictionary-introduction"> 
+    <title>Introduction</title>
+
+    <para>The <application>&app;</application> application enables you to
+    search words and terms on a dictionary source.</para>
+    
+  </sect1>
+
+<!-- ============= Getting Started =========================== -->  
+  <sect1 id="mate-dictionary-getting-started">
+    <title>Getting Started</title>
+    
+<!-- ============= To Start Dictionary ======================= -->
+    <sect2 id="mate-dictionary-start-application">
+      <title>To Start &app;</title>
+      
+      <para>You can start <application>&app;</application> in the following
+      ways:</para>
+      
+      <variablelist>
+        	<varlistentry>
+        	  <term><guimenu>Applications</guimenu> menu</term>
+        	  <listitem>
+        	    <para>Choose <menuchoice><guisubmenu>Accessories</guisubmenu>
+        	      <guimenuitem>Dictionary</guimenuitem></menuchoice>.
+        	    </para>
+        	  </listitem>
+        	</varlistentry>
+    	<varlistentry>
+    	  <term>Command line</term>
+    	  <listitem>
+    	    <para>Execute the following command: <command>mate-dictionary</command></para>
+    	  </listitem>
+    	</varlistentry>
+      </variablelist>
+      
+      <para>Once started, the <application>&app;</application> window is
+      displayed:</para>
+      
+      <figure id="mate-dictionary-fig">
+        <title>&app; Window</title>
+        <screenshot> 
+          <mediaobject>
+            <imageobject>
+              <imagedata fileref="figures/mate-dictionary-application.png" format="PNG"/>
+            </imageobject>
+            <textobject><phrase>Shows &app; main window.</phrase></textobject> 
+          </mediaobject>
+        </screenshot>
+      </figure>
+
+    </sect2>
+
+  </sect1>
+  
+<!-- ============= Usage ===================================== -->
+  <sect1 id="mate-dictionary-usage">
+    <title>Usage</title>
+    
+    <sect2 id="mate-dictionary-lookup">
+      <title>Looking up a word</title>
+      
+      <para>To look up a word, type it into the <guilabel>entry field</guilabel>
+      and press <keycap>Enter</keycap>.</para>
+    
+      <para>If some definition for the word is found, it will appear inside
+      the main window area:</para>
+
+      <figure id="mate-dictionary-lookup-fig">
+        <title>&app; Window</title>
+        <screenshot> 
+          <mediaobject>
+            <imageobject>
+              <imagedata fileref="figures/mate-dictionary-lookup.png" format="PNG"/>
+            </imageobject>
+            <textobject><phrase>Shows a definition inside the &app; main window.</phrase></textobject> 
+          </mediaobject>
+        </screenshot>
+      </figure>
+      
+      <para>Otherwise, an error dialog will appear, with a message explaining the
+      nature of the error.</para>
+    
+    </sect2>
+    
+    <sect2 id="mate-dictionary-save">
+      <title>Save look up results</title>
+      
+      <para>To save the results of a look up, choose <menuchoice><guimenu>File</guimenu><guimenuitem>Save a Copy</guimenuitem></menuchoice>. Enter a name for the file in the <guilabel>Save a Copy</guilabel> dialog, then click <guibutton>Save</guibutton>.</para>
+    
+    </sect2>
+    
+    <sect2 id="mate-dictionary-print">
+      <title>Print look up results</title>
+      
+      <para>To print the results of a look up, choose <menuchoice><guimenu>File</guimenu><guimenuitem>Print</guimenuitem></menuchoice>.</para>
+
+      <para>Inside the <guilabel>Print</guilabel> dialog you can select the
+      printer to use, the paper format, the number of copies.</para>
+
+      <para>To see a preview of what will be printed, click
+      <guibutton>Preview</guibutton>.</para>
+
+      <para>To print, click <guibutton>Print</guibutton>.</para>
+    
+    </sect2>
+    
+    <sect2 id="mate-dictionary-find">
+      <title>Find Text</title>
+
+      <figure id="mate-dictionary-find-fig">
+        <title>&app; Window</title>
+        <screenshot> 
+          <mediaobject>
+            <imageobject>
+              <imagedata fileref="figures/mate-dictionary-find.png" format="PNG"/>
+            </imageobject>
+            <textobject><phrase>Shows the &app; Find pane inside the main window.</phrase></textobject> 
+          </mediaobject>
+        </screenshot>
+      </figure>
+
+      
+      <para>To find text inside the results of a look up, perform the following
+      steps:</para>
+      
+      <orderedlist>
+        <listitem><para>Choose <menuchoice> <guimenu>Edit</guimenu> <guimenuitem>Find</guimenuitem> </menuchoice>
+        to display the <guilabel>Find</guilabel> pane.</para></listitem>
+        <listitem><para>Type the text you want to find inside the <guilabel>Search</guilabel>
+        entry.</para></listitem>
+        <listitem><para>To find the next occurrence of the text, click <guibutton>Next</guibutton>.
+        To find the previous occurrence of the text, click
+        <guibutton>Previous</guibutton>.</para></listitem>
+      </orderedlist>
+    
+    </sect2>
+      
+  </sect1>
+
+<!-- ============= Preferences =============================== -->
+  <sect1 id="mate-dictionary-preferences">
+    <title>Preferences</title>
+    
+    <para>To change the <application>&app;</application> application
+    preferences, choose <menuchoice><guimenu>Edit</guimenu><guimenuitem>Preferences</guimenuitem></menuchoice>.</para>
+
+<!-- ============= Source Tab ================================ -->
+    <sect2 id="mate-dictionary-source-tab">
+      <title>Dictionary Sources</title>
+
+      <figure id="mate-dictionary-sources-fig">
+        <title>&app; Window</title>
+        <screenshot> 
+          <mediaobject>
+            <imageobject>
+              <imagedata fileref="figures/mate-dictionary-preferences-source.png" format="PNG"/>
+            </imageobject>
+            <textobject><phrase>Shows the Source tab of the Preferences dialog.</phrase></textobject> 
+          </mediaobject>
+        </screenshot>
+      </figure>
+
+      <para>To change the dictionary source used to look up words, select
+      the desired source from the list.</para>
+    </sect2>
+    
+<!-- ============= Add Source ================================ -->
+    <sect2 id="mate-dictionary-add-source">
+      <title>Adding a new source</title>
+
+      <figure id="mate-dictionary-add-source-fig">
+        <title>&app; Window</title>
+        <screenshot> 
+          <mediaobject>
+            <imageobject>
+              <imagedata fileref="figures/mate-dictionary-add-source.png" format="PNG"/>
+            </imageobject>
+            <textobject><phrase>Shows the Add Source dialog.</phrase></textobject> 
+          </mediaobject>
+        </screenshot>
+      </figure>
+
+      <para>To add a new dictionary source, perform the following steps:</para>
+
+      <orderedlist>
+        <listitem><para>Click on the <guibutton>Add</guibutton> button</para></listitem>
+	<listitem><para>Edit the name of the new source inside the <guilabel>Description</guilabel> entry</para></listitem>
+	<listitem><para>Change the transport type of the new source using the <guilabel>Transport</guilabel> combo box</para></listitem>
+	<listitem><para>Edit the attributes of the new source</para></listitem>
+	<listitem><para>Click <guibutton>Add</guibutton></para></listitem>
+      </orderedlist>
+
+      <para>Different source transport types uses different attributes.  This
+      is the list of available attributes per transport type:</para>
+
+      <informaltable frame="all">
+        <tgroup cols="2" colsep="1" rowsep="1">
+	  <thead>
+	    <row valign="top">
+	      <entry><para>Transport</para></entry>
+	      <entry><para>Attributes</para></entry>
+	    </row>
+	  </thead>
+	  <tbody>
+	    <row valign="top">
+	      <entry><para>Dictionary Server</para></entry>
+	      <entry>
+	        <para>Hostname: the hostname of the dictionary server</para>
+		<para>Port: the port of the dictionary server</para>
+              </entry>
+	    </row>
+	  </tbody>
+	</tgroup>
+      </informaltable>
+    
+    </sect2>
+
+<!-- ============= Remove Source ============================= -->
+    <sect2 id="mate-dictionary-remove-source">
+      <title>Removing a source</title>
+      
+      <para>To remove a dictionary source, perform the following steps:</para>
+
+      <orderedlist>
+        <listitem><para>Select the source you wish to remove</para></listitem>
+	<listitem><para>Click the <guibutton>Remove</guibutton> button</para></listitem>
+      </orderedlist>
+
+      <warning><para>If you remove a dictionary source it will be permanently
+      deleted from the list of available sources.  Also, as some sources might
+      be defined system-wide you may actually not be able to remove
+      them unless you have the right ownership privileges.</para></warning>
+      
+    </sect2>
+    
+<!-- ============= Print Tab ================================= -->
+    <sect2 id="mate-dictionary-print-tab">
+      <title>Print Options</title>
+
+      <figure id="mate-dictionary-print-fig">
+        <title>&app; Window</title>
+        <screenshot> 
+          <mediaobject>
+            <imageobject>
+              <imagedata fileref="figures/mate-dictionary-preferences-print.png" format="PNG"/>
+            </imageobject>
+            <textobject><phrase>Shows the Print tab inside the Preferences dialog.</phrase></textobject> 
+          </mediaobject>
+        </screenshot>
+      </figure>
+
+      <para>If you want to change the font name and size used when printing,
+      perform the following steps:</para>
+
+      <orderedlist>
+        <listitem><para>Click on the <guilabel>Print Font</guilabel> button</para></listitem>
+	<listitem><para>Select the font and size you wish to use</para></listitem>
+	<listitem><para>Click <guibutton>Ok</guibutton></para></listitem>
+      </orderedlist>
+	
+    </sect2>
+    
+  </sect1>
+
+<!-- ============= Dictionary Applet ======================== -->
+  <sect1 id="mate-dictionary-applet">
+  <title>The &applet;</title>
+  
+  <para>The <application>&app;</application> application comes with a
+  panel applet, the <application>&applet;</application>.  You can add
+  the <application>&applet;</application> applet to a panel and look
+  up words in dictionaries.</para>
+
+  <figure id="mate-dictionary-applet-fig">
+    <title>&applet; Window</title>
+    <screenshot> 
+      <mediaobject>
+        <imageobject>
+          <imagedata fileref="figures/mate-dictionary-applet.png" format="PNG"/>
+        </imageobject>
+        <textobject><phrase>Shows &applet;.</phrase></textobject> 
+      </mediaobject>
+    </screenshot>
+  </figure>
+
+
+<!-- ============= Dictionary Applet Start ================== -->
+    <sect2 id="mate-dictionary-applet-start">
+      <title>To Start &applet;</title>
+    
+      <para>To add <application>&applet;</application> to a panel, right-click
+      on the panel, then choose <guimenuitem>Add to Panel</guimenuitem>.
+      Select &applet; in the <application>Add to the panel</application>
+      dialog, then click <guibutton>OK</guibutton>.</para>
+      
+    </sect2>
+
+<!-- ============= Dictionary Applet Start ================== -->
+    <sect2 id="mate-dictionary-applet-usage">
+      <title>Using the &applet;</title>
+      
+      <para>To look up a word, type it into the <guilabel>entry field</guilabel>,
+      and press <keycap>Enter</keycap> or right-click on the dictionary icon
+      and then choose <guimenuitem>Look up</guimenuitem>.
+      </para>
+      
+      <para>If some definition for the word was found, a window will appear,
+      with the text of the definitions:</para>
+
+      <figure id="mate-dictionary-applet-window-fig">
+        <title>&applet; Window</title>
+        <screenshot> 
+          <mediaobject>
+            <imageobject>
+              <imagedata fileref="figures/mate-dictionary-applet-window.png" format="PNG"/>
+            </imageobject>
+            <textobject><phrase>Shows &applet; main window.</phrase></textobject> 
+          </mediaobject>
+        </screenshot>
+      </figure>
+      
+      <para>Click <guibutton>Save</guibutton> to save the definitions to a
+      text file.  Click <guibutton>Print</guibutton> to print the definitions.
+      Click <guibutton>Clear</guibutton> to clear the definitions.</para>
+      
+      <para>You can make the window disappear by left-clicking on the dictionary
+      icon or by pressing <keycap>Esc</keycap>.</para>
+
+    </sect2>
+    
+    <sect2 id="mate-dictionary-applet-preferences">
+      <title>Preferences</title>
+      
+      <para>To configure the <application>&applet;</application>, right-click on
+      the dictionary icon, then choose <guimenuitem>Preferences</guimenuitem>.</para>
+      
+      <para>The <guilabel>Preferences</guilabel> dialog is the same used by
+      the <application>&app;</application> application, so refer to
+      <xref linkend="mate-dictionary-preferences"/></para>
+      
+    </sect2>
+    
+  </sect1>
+
+</article>