README.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Thu, 12 Jan 2012 21:50:33 +0200
changeset 95 27117b30660d
parent 73 bc24cb491160
child 99 95027d3ac8f7
permissions -rw-r--r--
Move 'IPA chars' section to HACKING file.
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
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
     8
How install/uninstall?
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
     9
======================
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    10
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    11
To install in /usr/local/ run::
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    12
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    13
  $ make install
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    14
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    15
If you want install in different place run::
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    16
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    17
  $ make install prefix=PREFIX
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    18
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    19
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
    20
run::
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    21
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
    22
  $ make prefix=PREFIX install install-local-symlink
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    23
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    24
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
    25
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    26
  $ make uninstall
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    27
  $ 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
    28
  $ make prefix=PREFIX uninstall uninstall-local-symlink
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    29
64
1174ea277aef .ifo, .tab, .descr file no longer used.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 38
diff changeset
    30
Dictionary source file format.
1174ea277aef .ifo, .tab, .descr file no longer used.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 38
diff changeset
    31
==============================
11
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    32
65
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    33
For source file format used dictd C5 file format. See::
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    34
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    35
  $ man 1 dictfmt
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    36
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    37
Shortly:
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    38
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    39
 * Headwords preceded by 5 or more underscore characters ``_`` and a
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    40
   blank line.
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    41
 * All text until the next headword is considered the definition.
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    42
 * Any leading ``@`` characters are stripped out, but the file is
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    43
   otherwise unchanged.
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    44
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    45
For convenience also used such assumptions:
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    46
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    47
 * Headwords separated by ``;<SPACE>`` (and all was placed on single
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    48
   line).
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    49
 * UTF-8 encoding was used.
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    50
 * Lines started with ``#`` striped out (comment syntax).
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    51
 * First line with ``ABOUT:`` used as description of dictionary.
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    52
 * First URL (line with ``http://``) used as dictionary home page.
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    53
73
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    54
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    55
World wide dictionary formats and standarts.
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    56
============================================
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    57
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    58
  http://en.wikipedia.org/wiki/Dictionary_writing_system
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    59
                Dictionary writing system
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    60
  http://www.sil.org/computing/shoebox/mdf.html
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    61
                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
    62
                field markers.
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    63
  http://fieldworks.sil.org/flex/
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    64
                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
    65
                to help field linguists perform many common language
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    66
                documentation and analysis tasks.
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    67
  http://code.google.com/p/lift-standard/
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    68
                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
    69
                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
    70
                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
    71
  http://www.lexiquepro.com/
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    72
                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
    73
                hyperlinks between entries, category views, dictionary
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    74
                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
    75
                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
    76
                to others.
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    77
  http://deb.fi.muni.cz/index.php
bc24cb491160 World wide dictionary formats and standards.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 72
diff changeset
    78
                DEBII — Dictionary Editor and Browser