README.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Thu, 12 Jul 2012 23:15:44 +0300
changeset 232 81bfc95bd853
parent 231 f993fc31e03f
child 233 d3670cd252ce
permissions -rw-r--r--
Move getting sources to proper place.

.. -*- fill-column: 78 -*-

.. include:: header.rst

======================
 gadict dictionaries.
======================
.. contents::

Document version.
=================

.. include:: VERSION.rst

About gadict.
=============

``gadict`` is a collection of en-ru dictionaries and some freely available
English thesaurus.

Also project provide some useful information. Check the `sitemap
<index.html#sitemap>`_.

Home page.
==========

  http://gadict.sourceforge.net/
                Home page.
  http://sourceforge.net/p/gadict/
                SourceForge home page.
  http://sourceforge.net/projects/gadict
                SourceForge (old look) home page.

Project goals.
==============

 * Create and maintain good quality EN-RU dictionaries.
 * Host some free dictionaries (to make them available to broad auditory).
 * Provide all data in most liberal restrictions (public domain).
 * Supply additional information about English language and tools for creating
   and maintaining dictionaries.

Target audience.
================

 * Regular users for using dictionaries and reading articles.
 * Dictionary develpers for checking dictionary building and maintaining
   techniques.

Project quality.
================

Currently dictionaries have very small size and less useful. You can see
`statistics <STAT.html>`_ on articles count.

I check spelling and translation of most words with old learning books and
sometimes with free dictionaries.

But *gadict-irregular-verbs-en-ru* dictionary contain mostly all irregular
verbs.

Project history.
================

Project born in 2009-06-28 as collection of irregular verbs which I learn.

It use inconvenient for editing Stardict TAB format. Later project switched to
much verbose C5 dictfmt format.

Licensing, term of use.
=======================

Generally speak: all files released for free use without any restrictions and
warranty.

See LICENSE_ file.

.. _LICENSE: LICENSE.html

Download page.
==============

  https://sourceforge.net/projects/gadict/files/
                gadict source releases at SourceForge.

Software directory.
===================

  https://www.ohloh.net/p/gadict
                ohloh home page for gadict

Report bug (BTS).
=================

Fill bug reports and suggestions in Trac instance by
https://sourceforge.net/apps/trac/gadict/newticket

Don't forget add your email address to ticket *CC* field to be notified on
ticket changes!

Dictionary source file format.
==============================

For source file format used dictd C5 file format. See::

  $ man 1 dictfmt

Shortly:

 * Headwords was preceded by 5 or more underscore characters ``_`` and a blank
   line.
 * All text until the next headword is considered the definition.
 * Any leading ``@`` characters are stripped out, but the file is
   otherwise unchanged.

For convenience also used such assumptions:

 * Headwords was separated by ``;<SPACE>`` (and all was placed on single
   line).
 * UTF-8 encoding was used.
 * Lines started with ``#`` striped out (comment syntax).
 * First line with ``ABOUT:`` used as description of dictionary.
 * First URL (line with ``http://``) used as dictionary home page.


World wide dictionary formats and standards.
============================================

  http://en.wikipedia.org/wiki/Dictionary_writing_system
                Dictionary writing system
  http://www.sil.org/computing/shoebox/mdf.html
                Multi-Dictionary Formatter (MDF). It defines about 100 data
                field markers.
  http://fieldworks.sil.org/flex/
                FieldWorks Language Explorer (or FLEx, for short) is designed
                to help field linguists perform many common language
                documentation and analysis tasks.
  http://code.google.com/p/lift-standard/
                LIFT (Lexicon Interchange FormaT) is an XML format for storing
                lexical information, as used in the creation of dictionaries.
                It's not necessarily the format for your lexicon.
  http://www.lexiquepro.com/
                Lexique Pro is an interactive lexicon viewer and editor, with
                hyperlinks between entries, category views, dictionary
                reversal, search, and export tools. It's designed to display
                your data in a user-friendly format so you can distribute it
                to others.
  http://deb.fi.muni.cz/index.php
                DEBII — Dictionary Editor and Browser