README.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Thu, 22 Dec 2011 21:25:05 +0200
changeset 72 8a6b62e319ec
parent 69 580cc720c496
child 73 bc24cb491160
permissions -rw-r--r--
g IPA char.
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
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    54
IPA chars.
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    55
==========
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    56
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    57
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
    58
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    59
  θʃŋʧðʒæıʌʊɒɛəɑɜɔˌˈːˑṃṇḷ
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    60
  æɑɒʌәєŋvθðʃʒɚːɡˏˊˋ
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    61
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    62
You can copy/paste they in phonetic string.
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    63
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    64
TODO
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    65
----
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    66
::
15
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    67
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    68
            Front       Central     Back
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    69
         long  short long  short long  short
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    70
  Close   iː    ɪ                 uː    ʊ
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    71
  Mid           e     ɜː    ə     ɔː
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    72
  Open          æ           ʌ     ɑː    ɒ
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    73
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    74
      Diphthong          Triphthong
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    75
  Closing    Centring
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    76
   /eɪ/       /ɪə/        /aɪə/
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    77
   /aɪ/       /eə/        /ɑʊə/
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
   /əʊ/
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    80
   /aʊ/
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    81
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    82
Old vs. new transcription.
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    83
--------------------------
15
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    84
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    85
From "Better English pronunciation."::
15
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    86
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    87
  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
    88
  New  iː ɪ e ɔː ʊ uː eɪ əʊ aɪ aʊ ɔɪ æ ɒ ʌ ɜː ɑː ɪə eə ʊə ə
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    89
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    90
Also from wikipedia::
15
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    91
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    92
  Old  æ e əː ʌɪ ɑʊ ɛə
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    93
  New  a ɛ ɜː aɪ aʊ eə
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    94
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    95
Emacs.
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    96
------
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    97
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    98
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
    99
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   100
  C-u C-\ ipa <enter>
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   101
69
580cc720c496 Fix RST syntax.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 65
diff changeset
   102
All chars from alphabet typed as usual. To type special IPA chars use next key
580cc720c496 Fix RST syntax.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 65
diff changeset
   103
bindings.
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   104
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
   105
For vowel::
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   106
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   107
  æ ae
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   108
  ɑ 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
   109
  ɒ |o () or /A
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   110
  ʊ U (upper-letter-u)
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   111
  ɛ /3 (slash three)
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   112
  ɔ /c
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   113
  ə /e
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   114
  ʌ /v
15
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
   115
  ɪ I
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   116
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
   117
For consonant::
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   118
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   119
  θ th
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   120
  ð dh
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   121
  ʃ sh
15
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
   122
  ʒ zh or 3
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   123
  ŋ ng
72
8a6b62e319ec g IPA char.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   124
  ɡ g
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   125
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
   126
Special chars::
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   127
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   128
  ː : (semicolon)
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   129
  ˈ ' (quote)
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   130
  ˌ ` (back quote)
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   131