README.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Thu, 12 Jan 2012 23:32:52 +0200
changeset 109 5bb58b8d87a7
parent 100 e1fe0aee58fd
child 116 09391dc786c4
permissions -rw-r--r--
Add version info into documentation.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
69
580cc720c496 Fix RST syntax.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 65
diff changeset
     1
.. -*- fill-column: 78 -*-
11
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     2
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
     3
==========================
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
     4
 gadict dictionaries set.
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
     5
==========================
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
     6
.. contents::
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
     7
109
5bb58b8d87a7 Add version info into documentation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 100
diff changeset
     8
Document version.
5bb58b8d87a7 Add version info into documentation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 100
diff changeset
     9
=================
5bb58b8d87a7 Add version info into documentation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 100
diff changeset
    10
5bb58b8d87a7 Add version info into documentation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 100
diff changeset
    11
.. include:: VERSION.rst
5bb58b8d87a7 Add version info into documentation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 100
diff changeset
    12
99
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 95
diff changeset
    13
About.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 95
diff changeset
    14
======
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 95
diff changeset
    15
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 95
diff changeset
    16
I create and update these dictionaries when learn English.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 95
diff changeset
    17
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 95
diff changeset
    18
They was covered by lesser possible usage restriction: Public domain.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 95
diff changeset
    19
100
e1fe0aee58fd Fix spelling.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 99
diff changeset
    20
I check spelling and translation of most words with old learning books and
e1fe0aee58fd Fix spelling.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 99
diff changeset
    21
sometimes with free dictionaries.
99
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 95
diff changeset
    22
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    23
How install/uninstall?
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    24
======================
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    25
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    26
To install in /usr/local/ run::
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    27
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    28
  $ make install
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    29
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    30
If you want install in different place run::
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    31
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    32
  $ make install prefix=PREFIX
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    33
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    34
If you install in nonstandard place and wont use dictionary for current user
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    35
run::
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    36
26
6dfc4ac2dc80 Back targets that allow make symlink to dictionaries install dir from user HOME dir.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 15
diff changeset
    37
  $ make prefix=PREFIX install install-local-symlink
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    38
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    39
To uninstall run one command from list accordingly to installation procedure::
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    40
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    41
  $ make uninstall
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    42
  $ make uninstall prefix=PREFIX
26
6dfc4ac2dc80 Back targets that allow make symlink to dictionaries install dir from user HOME dir.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 15
diff changeset
    43
  $ make prefix=PREFIX uninstall uninstall-local-symlink
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    44
64
1174ea277aef .ifo, .tab, .descr file no longer used.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 38
diff changeset
    45
Dictionary source file format.
1174ea277aef .ifo, .tab, .descr file no longer used.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 38
diff changeset
    46
==============================
11
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    47
65
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    48
For source file format used dictd C5 file format. See::
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    49
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    50
  $ man 1 dictfmt
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    51
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    52
Shortly:
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    53
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    54
 * Headwords preceded by 5 or more underscore characters ``_`` and a
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    55
   blank line.
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    56
 * All text until the next headword is considered the definition.
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    57
 * Any leading ``@`` characters are stripped out, but the file is
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    58
   otherwise unchanged.
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    59
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    60
For convenience also used such assumptions:
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    61
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    62
 * Headwords separated by ``;<SPACE>`` (and all was placed on single
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    63
   line).
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    64
 * UTF-8 encoding was used.
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    65
 * Lines started with ``#`` striped out (comment syntax).
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    66
 * First line with ``ABOUT:`` used as description of dictionary.
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    67
 * First URL (line with ``http://``) used as dictionary home page.
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    68
73
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    69
99
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 95
diff changeset
    70
World wide dictionary formats and standards.
73
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    71
============================================
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    72
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    73
  http://en.wikipedia.org/wiki/Dictionary_writing_system
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    74
                Dictionary writing system
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    75
  http://www.sil.org/computing/shoebox/mdf.html
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    76
                Multi-Dictionary Formatter (MDF). It defines about 100 data
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    77
                field markers.
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    78
  http://fieldworks.sil.org/flex/
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    79
                FieldWorks Language Explorer (or FLEx, for short) is designed
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    80
                to help field linguists perform many common language
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    81
                documentation and analysis tasks.
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    82
  http://code.google.com/p/lift-standard/
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    83
                LIFT (Lexicon Interchange FormaT) is an XML format for storing
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    84
                lexical information, as used in the creation of dictionaries.
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    85
                It's not necessarily the format for your lexicon.
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    86
  http://www.lexiquepro.com/
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    87
                Lexique Pro is an interactive lexicon viewer and editor, with
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    88
                hyperlinks between entries, category views, dictionary
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    89
                reversal, search, and export tools. It's designed to display
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    90
                your data in a user-friendly format so you can distribute it
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    91
                to others.
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    92
  http://deb.fi.muni.cz/index.php
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    93
                DEBII — Dictionary Editor and Browser