README.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Wed, 21 Dec 2011 23:16:32 +0200
changeset 65 2137ea6bb456
parent 64 1174ea277aef
child 69 580cc720c496
permissions -rw-r--r--
Dictionary source file format.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
11
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     1
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
     2
==========================
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
     3
 gadict dictionaries set.
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
     4
==========================
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
     5
.. contents::
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
     6
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
     7
How install/uninstall?
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
     8
======================
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
To install in /usr/local/ run::
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    11
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    12
  $ make install
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    13
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    14
If you want install in different place run::
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    15
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    16
  $ make install prefix=PREFIX
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    17
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    18
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
    19
run::
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    20
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
    21
  $ make prefix=PREFIX install install-local-symlink
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    22
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    23
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
    24
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    25
  $ make uninstall
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    26
  $ 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
    27
  $ make prefix=PREFIX uninstall uninstall-local-symlink
14
a1a505947f5e How install/uninstall?
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 12
diff changeset
    28
64
1174ea277aef .ifo, .tab, .descr file no longer used.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 38
diff changeset
    29
Dictionary source file format.
1174ea277aef .ifo, .tab, .descr file no longer used.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 38
diff changeset
    30
==============================
11
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    31
65
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    32
For source file format used dictd C5 file format. See::
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    33
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    34
  $ man 1 dictfmt
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    35
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    36
Shortly:
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    37
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    38
 * Headwords preceded by 5 or more underscore characters ``_`` and a
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    39
   blank line.
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    40
 * All text until the next headword is considered the definition.
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    41
 * Any leading ``@`` characters are stripped out, but the file is
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    42
   otherwise unchanged.
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    43
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    44
For convenience also used such assumptions:
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    45
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    46
 * Headwords separated by ``;<SPACE>`` (and all was placed on single
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    47
   line).
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    48
 * UTF-8 encoding was used.
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    49
 * Lines started with ``#`` striped out (comment syntax).
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    50
 * First line with ``ABOUT:`` used as description of dictionary.
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    51
 * First URL (line with ``http://``) used as dictionary home page.
2137ea6bb456 Dictionary source file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 64
diff changeset
    52
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    53
IPA chars.
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    54
==========
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    55
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    56
Hare list of spetial IPA chars (code present in UTF-8 encoding):
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    57
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    58
  θʃŋʧðʒæıʌʊɒɛəɑɜɔˌˈːˑṃṇḷ
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    59
  æɑɒʌәєŋvθðʃʒɚːɡˏˊˋ
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    60
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    61
You can copy/paste they in phonetic string.
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    62
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    63
TODO
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    64
----
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    65
::
15
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    66
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    67
            Front       Central     Back
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    68
         long  short long  short long  short
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    69
  Close   iː    ɪ                 uː    ʊ
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    70
  Mid           e     ɜː    ə     ɔː
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    71
  Open          æ           ʌ     ɑː    ɒ
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    72
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    73
      Diphthong          Triphthong
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    74
  Closing    Centring
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    75
   /eɪ/       /ɪə/        /aɪə/
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    76
   /aɪ/       /eə/        /ɑʊə/
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    77
   /ɔɪ/       /ʊə/
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    78
   /əʊ/
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    79
   /aʊ/
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    80
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    81
Old vs. new transcription.
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    82
--------------------------
15
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    83
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    84
From "Better English pronunciation."::
15
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    85
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    86
  Old  iː i e ɔː u uː ei ou ai au ɔi æ ɔ ʌ əː ɑː iə ɛə uə ə
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    87
  New  iː ɪ e ɔː ʊ uː eɪ əʊ aɪ aʊ ɔɪ æ ɒ ʌ ɜː ɑː ɪə eə ʊə ə
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    88
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    89
Also from wikipedia::
15
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    90
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    91
  Old  æ e əː ʌɪ ɑʊ ɛə
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    92
  New  a ɛ ɜː aɪ aʊ eə
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    93
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    94
Emacs.
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    95
------
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    96
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    97
For entering IPA chars use IPA input method. To enable it type::
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    98
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    99
  C-u C-\ ipa <enter>
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   100
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
   101
All chars from alphabet typed as usual. How type special chars see below.
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   102
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
   103
For vowel::
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   104
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   105
  æ ae
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   106
  ɑ o| (small letter o and ) or A (upper letter A)
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   107
  ɒ |o () or /A
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   108
  ʊ U (upper-letter-u)
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   109
  ɛ /3 (slash three)
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   110
  ɔ /c
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   111
  ə /e
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   112
  ʌ /v
15
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
   113
  ɪ I
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   114
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
   115
For consonant::
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   116
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   117
  θ th
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   118
  ð dh
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   119
  ʃ sh
15
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
   120
  ʒ zh or 3
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   121
  ŋ ng
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   122
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
   123
Special chars::
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   124
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   125
  ː : (semicolon)
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   126
  ˈ ' (quote)
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   127
  ˌ ` (back quote)
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   128