<?xml version='1.0'  encoding="UTF-8" ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 "/usr/share/sgml/docbook/dtd/xml/4.2/docbookx.dtd" [

 <!-- Why make all urls to entitites? entities are only useful for recurring things (Michael) -->
 <!ENTITY fdictUrl "http://www.freedict.org/">
 <!ENTITY fdictsf "http://sourceforge.net/projects/freedict/">
 <!ENTITY fdictMail "freedict-beta@lists.sourceforge.net">
 <!ENTITY MichEmail "bunk@imn.htwk-leipzig.de">
 <!ENTITY Mich137 "micha137@users.sourceforge.net">
 <!ENTITY PeteEmail "petergozz@users.sf.net">
 <!ENTITY TEIsys "-//TEI P4//DTD Main Document Type//EN">
 <!ENTITY TEIUrl "http://www.tei-c.org/">
 <!ENTITY TEIUrlTut "http://www.tei-c.org/Tutorials/index.html">
 <!ENTITY TEIguide "http://www.tei-c.org/Guidelines2/index.html">
 <!ENTITY TEIdl "http://sourceforge.net/project/showfiles.php?group_id=106328&amp;package_id=114572">
 <!ENTITY xmluni "http://skew.org/xml/tutorial/">
 <!ENTITY w3c "http://www.w3.org/">
 <!ENTITY w3cxml11 "http://www.w3.org/TR/2004/REC-xml11-20040204/">
 <!ENTITY oasiscover "http://xml.coverpages.org/">
 <!ENTITY oasis "http://www.oasis-open.org/home/">
 <!ENTITY cmdp "<prompt>account@host:~$</prompt>">
 <!ENTITY Rcmdp "<prompt>ADMIN@host:##</prompt>">
 <!ENTITY gnufdl "http://www.gnu.org/copyleft/fdl.html">
 <!ENTITY gnugpl "http://www.gnu.org/licenses/gpl.html">

 <!ENTITY la1-la2.template.tei SYSTEM "inc/la1-la2.template.tei.escaped.xml">
 <!ENTITY kha-deu.tei.header SYSTEM "inc/kha-deu.tei.header.escaped.xml">

 <!ENTITY intro SYSTEM "introduction.xml">
 <!ENTITY writing SYSTEM "writing.xml">
 <!ENTITY writing-dictd SYSTEM "writing-dictd.xml">
 <!ENTITY writing-tei SYSTEM "writing-tei.xml">
 <!ENTITY installing-tei SYSTEM "installing-tei.xml">
 <!ENTITY requirements SYSTEM "requirements.xml">
 <!ENTITY submit SYSTEM "submitting.xml">
 <!ENTITY tools SYSTEM "tools.xml">
 <!ENTITY writing-texteditor SYSTEM "writing-texteditor.xml">
 ]>

<book id="index">

  <bookinfo>
    <title>FreeDict HOWTO</title>
    <titleabbrev>FreeDict Howto</titleabbrev>
    <author>
      <firstname>Peter</firstname>
      <surname>Gossner</surname>
      <address>
       <city>Woodside</city>
       <state>South Australia</state>
       <email>&PeteEmail;</email>
      </address>
    </author>
    <author>
      <firstname>Michael</firstname>
      <surname>Bunk</surname>
      <address>
       <city>Lützschena</city>
       <country>Germany</country>
       <email>&Mich137;</email>
      </address>
    </author>
    <collab>
      <collabname>namen</collabname>
    </collab>
    <orgname><ulink url="&fdictUrl;">FreeDict</ulink></orgname>
    <abstract>
      <title>FreeDict Dictionaries</title>
      <para>This document describes how to build, install and improve
        FreeDict project dictionaries. It is aimed at developers rather than
        end users and was written from the point of view of a GNU/Linux based
        platform. Generally the information should be portable across any open
        operating system. The approach is reasonably comprehensive. Information
        is given on installation issues, XML basics, editor selection/setup,
        developer tools etc.</para>
    </abstract>
    <revhistory>
      <revision>
	<revnumber>0.0.0</revnumber>
	<date>Sun Feb 08 2004</date>
      </revision>
      <revision>
	<revnumber>0.0.1</revnumber>
	<date>Wed Feb 18 2004</date>
	<authorinitials>PG</authorinitials>
	<revdescription>
	  <para>Some Proofing and checking. Small changes to layout. repair broken internal links.</para>
	</revdescription>
      </revision>
      <revision>
	<revnumber>0.0.2</revnumber>
	<date>Sat Feb 21 2004</date>
	<authorinitials>PG</authorinitials>
	<revdescription>
	  <para>Literal inclusions, and references to The GFDL and GPL2 removed. Some article level
            divisions moved to Chapter level. Grouped into Parts. XML / SGML sections developed. Editors
            section added.</para>
	</revdescription>
      </revision>
      <revision>
	<revnumber>0.0.3</revnumber>
	<date>Wed Mar 24 2004</date>
	<authorinitials>PG</authorinitials>
	<authorinitials>MB</authorinitials>
	<revdescription>
	  <para>First Patches Applied. Now on Site CVS. Added links for Dictd and Serpento. Cleaned
            up Index Items. Rewrote manual install locations.</para>
	</revdescription>
      </revision>
      <revision>
        <revnumber>0.0.4</revnumber>
	<date>Sat Jul 03 2004</date>
	<authorinitials>MB</authorinitials>
	<revdescription>
	  <para>Renamed dict2xml.py into dict2tei.py, added example dictfmt command</para>
	</revdescription>
      </revision>
      <revision>
        <revnumber>0.0.5</revnumber>
	<date>Sat Mar 19 2005</date>
	<authorinitials>MB</authorinitials>
	<revdescription>
	  <para>Added some DocBook style customisations. Most notably the long XML
	    listings now stand out by having a different background. Shortened
	    TOC (2 levels, no list of examples). Added sections on CVS and Makefile.common,
	    making the TOC unbalanced. Spellchecked. Extended description of supported
	    elements in TEI header and entries. The XHTML version now uses a
	    CSS stylesheet to make usage of a serifless font.</para>
	</revdescription>
      </revision>
      <revision>
        <revnumber>0.0.6</revnumber>
	<date>Sat Apr 15 2005</date>
	<authorinitials>MB</authorinitials>
	<revdescription>
	  <para>Less chunking. Sections on Build System and Quality/Growing a Dictionary.</para>
	</revdescription>
      </revision>
      <revision>
        <revnumber>0.0.7</revnumber>
	<date>Sun Jul 03 2005</date>
	<authorinitials>MB</authorinitials>
	<revdescription>
	  <para>Added section about bedic platform.</para>
	</revdescription>
      </revision>
    </revhistory>
    <legalnotice>
      <title>Copyright Notice</title>
      <blockquote id="copyrightSample">
	<para>Copyright (c) 2004-2005 Peter Gossner and Michael Bunk.</para>
	<para>Permission is granted to copy, distribute and/or modify this document
	  under the terms of the <ulink url="&gnufdl;">GNU Free Documentation License,</ulink> Version 1.2
	  or any later version published by the Free Software Foundation;
	  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.</para>
	<para>Permissions are extended to copy and distribute translations of this document
          into another language, under the above conditions for modified versions, except
          that this extended permission notice may be included in translations approved by
          the <ulink url="http://www.fsf.org/">Free Software Foundation</ulink> instead of
          in the original English.</para>
        <note>
	  <title>Local Copies of the GNU Licences</title>
          <para>You may also access the GNU Free Documentation License by accessing manual or info pages on your system:</para>
          <para>Try <command>man gfdl</command>, <command>info gfdl</command>,
                    <command>man gpl</command>, <command>info gpl</command>,
                    <command>locate gpl</command> or <command>locate gfdl</command>.</para>
          <para>Adding yet more local copies was a little redundant. Please refer to the GNU site for
            latest information and versions of these important, indeed enabling licences.</para>
        </note>
      </blockquote>
    </legalnotice>
    <releaseinfo>Please see the <link linkend="about">Colophon</link> for more information
      about this document.</releaseinfo>
  </bookinfo>

  <dedication>
    <title>Epigram</title>
    <para> 
      <literallayout>
The bait is the means to get the fish where you want it,
 catch the fish and you forget the bait. 
The snare is the means to get the rabbit where you want it,
 catch the rabbit and forget the snare.
Words are the means to get the idea where you want it,
 catch on to the idea and you forget about the words.

Where shall I find a man who forgets about words, and have a word with him?

  </literallayout>
    <author>
      <personname>
        <firstname>Chuang</firstname>
	<surname>Tzu</surname>
      </personname>
    </author>
      <indexterm><primary>rabbit</primary></indexterm>
      <indexterm><primary>fish</primary></indexterm>
      <indexterm><primary>bait</primary></indexterm>
      <indexterm><primary>Chuang Tzu</primary>
        <secondary>epigram</secondary>
      </indexterm>
    </para>
  </dedication>

  &intro;

  &requirements;

  <part id="writingnew">
    <title>Constructing a translating dictionary</title>
    &installing-tei;
    &writing-tei;
    &writing-dictd;
  </part>
  <part id="submissions">
    <title>FreeDict Build System and Submitting New Dictionaries</title>
    &submit;
  </part>

  &tools;
  
  <!-- As long as we cannot make the list of examples appear in an appendix,
       its generation is disabled in customize-docbook.xsl -->

  <!-- and here as well
  <appendix id="examples">
    <title>Examples</title>
    <para>I see that we get a list of examples. Unfortunately it does
      not appear in this appendix.</para>    
  </appendix>
    --> 
  
  <!-- Don't delete this element! It makes the index appear here. -->
  <index/>
  
  <colophon id="about">
    <!-- Michael: this colophon part doesn't appear in the TOC. The "next"
         link from the index will show this information -->
    <title>About this document</title>
    <para>This HOWTO was written using the <application>DocBook
	XML</application> set of DTDs using <application>Xemacs</application>
      and <application>vi</application> as editors.</para>
    <para>Conversion to XHTML was done using <application><ulink
	  url="http://cyberelk.net/tim/xmlto/">xmlto</ulink></application> with
      the following command:</para>
    <para><command>xmlto -m customise-docbook.xsl -o xhtml xhtml
	freedicthowto.xml</command></para>
    <para>You find the newest version of this HOWTO at
      <ulink url="http://freedict.org/howto/">http://freedict.org/howto</ulink>.
      You can download an offline version of this HOWTO from the FreeDict File Releases
      at SourceForge, when it is released there (it is currently too unstable for
      such release).</para>
  </colophon>
 
</book>

