FreeDict HOWTO

Peter Gossner

Michael Bunk

Please see the Colophon for more information about this document.

Copyright Notice

Copyright (c) 2004-2005 Peter Gossner and Michael Bunk.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, 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.

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 Free Software Foundation instead of in the original English.

[Note]Local Copies of the GNU Licences

You may also access the GNU Free Documentation License by accessing manual or info pages on your system:

Try man gfdl, info gfdl, man gpl, info gpl, locate gpl or locate gfdl.

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.

Revision History
Revision 0.0.0Sun Feb 08 2004 
Revision 0.0.1Wed Feb 18 2004PG

Some Proofing and checking. Small changes to layout. repair broken internal links.

Revision 0.0.2Sat Feb 21 2004PG

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.

Revision 0.0.3Wed Mar 24 2004PG, MB

First Patches Applied. Now on Site CVS. Added links for Dictd and Serpento. Cleaned up Index Items. Rewrote manual install locations.

Revision 0.0.4Sat Jul 03 2004MB

Renamed dict2xml.py into dict2tei.py, added example dictfmt command

Revision 0.0.5Sat Mar 19 2005MB

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.

Revision 0.0.6Sat Apr 15 2005MB

Less chunking. Sections on Build System and Quality/Growing a Dictionary.

Revision 0.0.7Sun Jul 03 2005MB

Added section about bedic platform.

FreeDict Dictionaries

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.


Epigram


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?

  

Chuang Tzu

Table of Contents

Introduction
I. Basic Requirements
1. Licensing and Copyright
2. XML Markup
3. Unicode
II. Constructing a translating dictionary
4. Installing the TEI DTDs
5. Writing a FreeDict Dictionary
6. Writing Text Encoding Initiative XML files
7. The Dictd Approach
III. FreeDict Build System and Submitting New Dictionaries
8. FreeDict Build System
9. The FreeDict CVS Repository
10. FreeDict Build Tree
IV. Developer's toolkit
11. Editing the TEI XML files directly
12. Validating TEI format files
13. Converting into TEI format
14. Supported and Unsupported Platforms
15. Stylesheets
Index

List of Tables

5.1. Part of Speech Typology (recommended contents of the pos element)
13.1. The 'Woordenboek' table structure
14.1. Timing comparison of c5 and xmltei2xmldict.pl conversion styles