HACKING.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Thu, 12 Jul 2012 23:13:53 +0300
changeset 231 f993fc31e03f
parent 211 3295b34427e7
child 232 81bfc95bd853
permissions -rw-r--r--
Move versioning rules to proper file.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
69
580cc720c496 Fix RST syntax.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 46
diff changeset
     1
.. -*- fill-column: 78 -*-
43
b75220c0eef6 Register gadict dictionaries for dictd under Debian.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     2
206
407f2a82ef26 Include common header for quick links. Exclude unnecessary .html files from build.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
     3
.. include:: header.rst
407f2a82ef26 Include common header for quick links. Exclude unnecessary .html files from build.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 109
diff changeset
     4
43
b75220c0eef6 Register gadict dictionaries for dictd under Debian.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     5
=======================
b75220c0eef6 Register gadict dictionaries for dictd under Debian.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     6
 gadict HACKING guide.
b75220c0eef6 Register gadict dictionaries for dictd under Debian.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     7
=======================
69
580cc720c496 Fix RST syntax.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 46
diff changeset
     8
.. contents::
43
b75220c0eef6 Register gadict dictionaries for dictd under Debian.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
     9
109
5bb58b8d87a7 Add version info into documentation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 95
diff changeset
    10
Document version.
5bb58b8d87a7 Add version info into documentation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 95
diff changeset
    11
=================
5bb58b8d87a7 Add version info into documentation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 95
diff changeset
    12
5bb58b8d87a7 Add version info into documentation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 95
diff changeset
    13
.. include:: VERSION.rst
5bb58b8d87a7 Add version info into documentation.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 95
diff changeset
    14
231
f993fc31e03f Move versioning rules to proper file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 211
diff changeset
    15
Versioning rules.
f993fc31e03f Move versioning rules to proper file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 211
diff changeset
    16
=================
f993fc31e03f Move versioning rules to proper file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 211
diff changeset
    17
f993fc31e03f Move versioning rules to proper file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 211
diff changeset
    18
We use **major.minor** schema.
f993fc31e03f Move versioning rules to proper file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 211
diff changeset
    19
f993fc31e03f Move versioning rules to proper file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 211
diff changeset
    20
Until we reach 5000 words **major** is 0. **minor** updated from time to time.
f993fc31e03f Move versioning rules to proper file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 211
diff changeset
    21
46
86c0184efac7 Comment syntax convention.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 44
diff changeset
    22
Comment syntax convention.
69
580cc720c496 Fix RST syntax.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 46
diff changeset
    23
==========================
46
86c0184efac7 Comment syntax convention.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 44
diff changeset
    24
86c0184efac7 Comment syntax convention.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 44
diff changeset
    25
As 'dictd -c5' format does not support comment syntax we filter out all
86c0184efac7 Comment syntax convention.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 44
diff changeset
    26
lines that start with '#'.
86c0184efac7 Comment syntax convention.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 44
diff changeset
    27
43
b75220c0eef6 Register gadict dictionaries for dictd under Debian.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    28
Register gadict dictionaries for dictd under Debian.
b75220c0eef6 Register gadict dictionaries for dictd under Debian.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    29
====================================================
44
41bcc534528d Fix rst formating.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 43
diff changeset
    30
::
43
b75220c0eef6 Register gadict dictionaries for dictd under Debian.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    31
b75220c0eef6 Register gadict dictionaries for dictd under Debian.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    32
  $ su
b75220c0eef6 Register gadict dictionaries for dictd under Debian.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    33
  $ cat >>etc/dictd/dictd.order <<EOF
44
41bcc534528d Fix rst formating.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 43
diff changeset
    34
  gadict-dictabbr
41bcc534528d Fix rst formating.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 43
diff changeset
    35
  /home/user/usr/share/dictd/
43
b75220c0eef6 Register gadict dictionaries for dictd under Debian.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    36
  $ dictdconfig --write
b75220c0eef6 Register gadict dictionaries for dictd under Debian.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    37
  $ /etc/init.d/dictd restart
b75220c0eef6 Register gadict dictionaries for dictd under Debian.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    38
  $ ^D
b75220c0eef6 Register gadict dictionaries for dictd under Debian.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    39
  $ dictdconfig --list
b75220c0eef6 Register gadict dictionaries for dictd under Debian.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    40
  $ dict -d gadict-dictabbr v
b75220c0eef6 Register gadict dictionaries for dictd under Debian.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents:
diff changeset
    41
95
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    42
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    43
IPA chars.
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    44
==========
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    45
211
3295b34427e7 Remove duplication from list of IPA chars. Make list look better in '.html'.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 206
diff changeset
    46
Hare list of spetial IPA chars (code present in UTF-8 encoding)::
95
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    47
211
3295b34427e7 Remove duplication from list of IPA chars. Make list look better in '.html'.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 206
diff changeset
    48
  θ ð ʃ ŋ ʧ ʒ ı ɡ ː ˌ ˈ ˑ ˏ ˊ ˋ
3295b34427e7 Remove duplication from list of IPA chars. Make list look better in '.html'.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 206
diff changeset
    49
  æ ɑ ɒ ʌ ʊ ɒ ɛ ə ɜ ɔ ɪ є ɚ
95
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    50
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    51
You can copy/paste they in phonetic string.
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    52
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    53
TODO
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    54
----
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    55
::
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    56
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    57
            Front       Central     Back
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    58
         long  short long  short long  short
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    59
  Close   iː    ɪ                 uː    ʊ
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    60
  Mid           e     ɜː    ə     ɔː
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    61
  Open          æ           ʌ     ɑː    ɒ
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    62
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    63
      Diphthong          Triphthong
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    64
  Closing    Centring
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    65
   /eɪ/       /ɪə/        /aɪə/
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    66
   /aɪ/       /eə/        /ɑʊə/
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    67
   /ɔɪ/       /ʊə/
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    68
   /əʊ/
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    69
   /aʊ/
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    70
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    71
Old vs. new transcription.
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    72
--------------------------
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    73
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    74
From "Better English pronunciation."::
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    75
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    76
  Old  iː i e ɔː u uː ei ou ai au ɔi æ ɔ ʌ əː ɑː iə ɛə uə ə
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    77
  New  iː ɪ e ɔː ʊ uː eɪ əʊ aɪ aʊ ɔɪ æ ɒ ʌ ɜː ɑː ɪə eə ʊə ə
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    78
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    79
Also from wikipedia::
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    80
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    81
  Old  æ e əː ʌɪ ɑʊ ɛə
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    82
  New  a ɛ ɜː aɪ aʊ eə
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    83
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    84
Emacs.
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    85
------
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    86
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    87
For entering IPA chars use IPA input method. To enable it type::
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    88
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    89
  C-u C-\ ipa <enter>
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    90
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    91
All chars from alphabet typed as usual. To type special IPA chars use next key
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    92
bindings.
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    93
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    94
For vowel::
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    95
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    96
  æ ae
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    97
  ɑ o| (small letter o and ) or A (upper letter A)
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    98
  ɒ |o () or /A
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
    99
  ʊ U (upper-letter-u)
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   100
  ɛ /3 (slash three)
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   101
  ɔ /c
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   102
  ə /e
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   103
  ʌ /v
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   104
  ɪ I
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   105
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   106
For consonant::
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   107
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   108
  θ th
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   109
  ð dh
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   110
  ʃ sh
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   111
  ʒ zh or 3
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   112
  ŋ ng
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   113
  ɡ g
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   114
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   115
Special chars::
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   116
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   117
  ː : (semicolon)
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   118
  ˈ ' (quote)
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   119
  ˌ ` (back quote)
27117b30660d Move 'IPA chars' section to HACKING file.
Oleksandr Gavenko <gavenkoa@gmail.com>
parents: 69
diff changeset
   120