README.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Fri, 02 Sep 2011 00:29:50 +0300
changeset 38 5f63725f1397
parent 27 README@b5d5bd21717e
child 64 1174ea277aef
permissions -rw-r--r--
Switch docs to RST 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
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    29
What file needed to create dictionary?
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    30
======================================
11
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    31
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    32
.tab_ and .descr, which contain text data in UTF-8 encoding.
27
b5d5bd21717e Descrive .tab_ file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 26
diff changeset
    33
install
b5d5bd21717e Descrive .tab_ file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 26
diff changeset
    34
b5d5bd21717e Descrive .tab_ file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 26
diff changeset
    35
In .tab_ file lines which begin with '#' used as comment; space after '\n'
b5d5bd21717e Descrive .tab_ file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 26
diff changeset
    36
(two chars) removed.
b5d5bd21717e Descrive .tab_ file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 26
diff changeset
    37
b5d5bd21717e Descrive .tab_ file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 26
diff changeset
    38
Words before first TAB character in .tab_ file supposed as translated word,
b5d5bd21717e Descrive .tab_ file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 26
diff changeset
    39
rest text after TAB is word article.
11
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    40
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    41
.tab_ file format.
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    42
------------------
11
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    43
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    44
Used such format:
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    45
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    46
  WORD [TAB] TRANSLATION [LF]
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    47
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    48
When processing TRANSLATION string in all occurrence of "\n " (literary
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    49
back-slash small-letter-n and space) removed space.
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    50
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    51
.descr file format.
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    52
-------------------
11
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    53
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    54
First line added to .ifo file as value of description.
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    55
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    56
Next lines ignored and used for miscellaneous notes.
b08c100852d3 Describe file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    57
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    58
IPA chars.
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    59
==========
12
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
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
    62
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    63
  θʃŋʧðʒæıʌʊɒɛəɑɜɔˌˈːˑṃṇḷ
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    64
  æɑɒʌәєŋvθðʃʒɚːɡˏˊˋ
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    65
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    66
You can copy/paste they in phonetic string.
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
    67
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    68
TODO
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    69
----
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    70
::
15
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    71
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    72
            Front       Central     Back
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    73
         long  short long  short long  short
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    74
  Close   iː    ɪ                 uː    ʊ
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    75
  Mid           e     ɜː    ə     ɔː
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    76
  Open          æ           ʌ     ɑː    ɒ
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
      Diphthong          Triphthong
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    79
  Closing    Centring
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    80
   /eɪ/       /ɪə/        /aɪə/
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    81
   /aɪ/       /eə/        /ɑʊə/
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    82
   /ɔɪ/       /ʊə/
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    83
   /əʊ/
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    84
   /aʊ/
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    85
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    86
Old vs. new transcription.
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    87
--------------------------
15
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
From "Better English pronunciation."::
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  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
    92
  New  iː ɪ e ɔː ʊ uː eɪ əʊ 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
Also from wikipedia::
15
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    95
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    96
  Old  æ e əː ʌɪ ɑʊ ɛə
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    97
  New  a ɛ ɜː aɪ aʊ eə
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
    98
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
    99
Emacs.
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
   100
------
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   101
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
   102
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
   103
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   104
  C-u C-\ ipa <enter>
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   105
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
   106
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
   107
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
   108
For vowel::
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   109
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   110
  æ ae
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   111
  ɑ 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
   112
  ɒ |o () or /A
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   113
  ʊ U (upper-letter-u)
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   114
  ɛ /3 (slash three)
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   115
  ɔ /c
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   116
  ə /e
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   117
  ʌ /v
15
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
   118
  ɪ I
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   119
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
   120
For consonant::
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   121
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   122
  θ th
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   123
  ð dh
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   124
  ʃ sh
15
3b3e166c793e Old vs. new transcription.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 14
diff changeset
   125
  ʒ zh or 3
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   126
  ŋ ng
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   127
38
5f63725f1397 Switch docs to RST file format.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 27
diff changeset
   128
Special chars::
12
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   129
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   130
  ː : (semicolon)
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   131
  ˈ ' (quote)
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   132
  ˌ ` (back quote)
bd6769abcd40 How type special chars in emacs.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 11
diff changeset
   133