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

.. include:: header.rst

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

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

.. include:: VERSION.rst

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

I create and update these dictionaries when learn English.

They was covered by lesser possible usage restriction: Public domain.

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

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

Currently dictionaries have very small word count so not useful.

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

Project goal.
=============

Create and maintain good quality EN-RU, RU-EN dictionaries.

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.

License statement.
==================

All files released for free use without any restrictions and warranty.

See LICENSE_ file.

.. _LICENSE: LICENSE.html

Versioning rules.
=================

We use **major.minor** schema.

Until we reach 5000 words **major** is 0. **minor** updated from time to time.

Getting sources (VCS).
======================

To clone repository run::

  $ hg clone http://hg.code.sf.net/p/gadict/code gadict-hg

To push to repository you must have write permission and do::

  $ hg push ssh://$USER@hg.code.sf.net/p/gadict/code

or::

  $ hg clone https://$USER@hg.code.sf.net/p/gadict/code

Browsing sources.
=================

  http://hg.code.sf.net/p/gadict/code
                hgweb interface for official repository.
  https://sourceforge.net/p/gadict/code/
                Sourceforge Allure interface for official repository.

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!

How install/uninstall?
======================

To install in /usr/local/ run::

  $ make install

If you want install in different place run::

  $ make install prefix=PREFIX

If you install in nonstandard place and wont use dictionary for current user
run::

  $ make prefix=PREFIX install install-local-symlink

To uninstall run one command from list accordingly to installation procedure::

  $ make uninstall
  $ make uninstall prefix=PREFIX
  $ make prefix=PREFIX uninstall uninstall-local-symlink

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