cgit.sxemacs.org Git - packages/blob - mule-packages/mule-base/texi/egg.texi

   1 \input texinfo  @c -*-texinfo-*-
   2 @setfilename ../info/egg
   3 @settitle EGG -- Japanese/Chinese inputting methods using Wnn/cWnn
   4
   5 @titlepage
   6 @sp 6
   7 @center @titlefont{EGG -- Japanese/Chinese inputting methods using Wnn/cWnn}
   8 @sp 4
   9 @center Version 2.0
  10 @sp 5
  11 @center Ken'ichi HANDA
  12 @center handa@@etl.go.jp
  13 @page
  14
  15 @end titlepage
  16
  17 @node Top, , , (mule)
  18 @section EGG -- Japanese/Chinese inputting methods using Wnn/cWnn
  19
  20 This documents describes briefly how to use EGG.
  21
  22 Before using EGG, you must, at first, install Wnn/cWnn Ver.4.108 or the
  23 higher version.  Then install Mule after configuring by argument
  24 `--wnn'.  See the file `INSTALL' for more detail.
  25
  26 @subsection Getting start with EGG
  27
  28 At first, check if your mule has already loaded necessary
  29 ITS (Input Translation System) modes.  By 'C-x C-k m'.  You
  30 can see the list at the echo area.  'C-n' will show you the
  31 rest.  To input Chinese, you need 'PinYin' mode.  If it
  32 can't be found in the list,
  33 @quotation
  34 @code{M-x load-library<CR>chinese<CR>}
  35 @end quotation
  36 is the easiest way.
  37
  38 Next you should tell the system a hostname on which cserver
  39 is running by:
  40
  41 @example
  42 M-x set-cserver-host-name<CR>hostname<CR>
  43 @end example
  44
  45 Putting
  46
  47 @example
  48 (set-cserver-host-name "hostname")
  49 @end example
  50
  51 in your .emacs may be easier.
  52
  53 Then type @code{C-\}.  You'll see the change in the left of
  54 modeline.  The text in brackets shows the current mode.  If
  55 it is not the mode you want to use, select any mode (for
  56 instance @code{PinYin}) by @code{C-x C-k m} and @code{C-n}, @code{C-f} (for
  57 moving around the cursor at the echo area) and @code{<CR>} (for
  58 selecting).  If you chose @code{PinYin}, you'll see Chinese
  59 character "QuanPin" at the modeline.
  60
  61 Now you can type in PinYin.  Long sequence is ok.  For
  62 instance,
  63
  64 @example
  65 nihaobeijing<SP>
  66 @end example
  67
  68 will build Chinese text for "Ni Hao Bei Jing".
  69
  70 Reversed region shows the current target word.  @code{C-f}, @code{C-b}
  71 moves cursor to another word.  @code{<SP>} select next candidate of
  72 Chinese text.  @code{M-s} (or @code{ESC s}) shows list of candidates at
  73 the echo area.  @code{C-n}, @code{C-p} chose another candidate.
  74 @code{M-i}/@code{M-o} change the length of word shorter/longer.
  75 @code{<CR>} or another alphabet key settles the current text, @code{C-g}
  76 cancels.
  77
  78
  79 @subsection Four phases
  80
  81 While you are using EGG, you'll move around four phases: normal-phase,
  82 transition-phase, fence-phase, and translation-phase.
  83
  84 @itemize
  85 @item  normal-phase
  86
  87 Left edge of modeline is something like:
  88
  89 @example
  90 [--]J.:--**-Mule: ...
  91 @end example
  92
  93 In this phase, all the keys typed are processed as normal.
  94 You won't be conscious of the existence of EGG.
  95
  96 @item transition-phase
  97
  98 When you type @code{C-\ (toggle-egg-mode)} at normal-phase, you'll
  99 be in translation-phase.
 100 Left edge of modeline shows something like:
 101
 102 @example
 103 [ITS_MODE_INDICATOR]J.:--**-Mule: ...
 104 @end example
 105
 106 where ITS_MODE_INDICATOR is a multilingual string indicating
 107 the current its-mode.  For instance, if the current its-mode
 108 is PinYin, Chinese text "QuanPin" is shown.  In this phase,
 109 all your editing commands (say, delete, next-line, ...)  are
 110 still processed as normal.  But, once you type any graphic
 111 key ('0'..'~'), you are thrown into fence-phase.
 112
 113 @item fence-phase
 114
 115 The modeline is the same as in transition-phase.  But, the last
 116 character you typed is surrounded by '|' (fence), or underlined if your
 117 are using @code{face}.  Any more graphic characters you type are
 118 translated along rules defined in the current its-mode.  For instance,
 119 your type @code{n} in transition-phase, the buffer will change as follows:
 120
 121 @example
 122 YourKey n   i    3     h      a       o        3
 123 Buffer  |n| |ni| |Ni | |Ni h| |Ni ha| |Ni hao| |Ni Hao |
 124                    ^     ^      ^       ^        ^   ^
 125 @end example
 126
 127 where @code{i} and @code{a} characters at @code{^} are shown with tone
 128 marks.  This is because its-mode for PinYin has rules:
 129
 130 @example
 131         ni3 -> Ni , hao3 -> Hao
 132                 ^            ^
 133 @end example
 134
 135 If you are not sure about tones, you can omit them.
 136
 137 In this phase, you can move cursor only within the fence (or underlined
 138 region) by @code{C-a}, @code{C-e}, @code{C-f}, and @code{C-b}.
 139
 140 When you type @code{<SPC>}, the string in the fence are sent to
 141 background `cserver' and a converted string appears in the fence.  At
 142 the same time, you are thrown into translation-phase
 143
 144 Hitting C-g will let you go back to transition-phase after
 145 deleting the fence (and its contents).
 146
 147 @item translation-phase
 148
 149 Left edge of the modeline is something like:
 150
 151 @example
 152 [TRS_MODE_INDICATOR]J.:--**-Mule: ...
 153 @end example
 154
 155 where TRS_MODE_INDICATOR is a string indicating the server.
 156 In the case of 'cserver', Chinese character "Han" of "Hanzi"
 157 is shown.  Now you are seeing Chinese text in the fence (or highlighted
 158 region).  The text in the fence may have the form:
 159
 160 @example
 161 |A-B-CD-E FG|
 162 @end example
 163
 164 where @code{A..G} are Chinese characters.  In this case, the text
 165 is divided into two BIG-PHRASEs @code{A-B-CD-E} and @code{FG}, and the
 166 former is divided into 5 SMALL-PHRASEs @code{A}, @code{B}, @code{CD},
 167 and @code{E}.
 168 You can change the division point of current phase (which
 169 your cursor is on) by:
 170
 171 @example
 172         C-i: make BIG-PHRASE shorter
 173         C-o: make BIG-PHRASE longer
 174         M-i: make SMALL-PHRASE shorter
 175         M-o: make SMALL-PHRASE longer
 176 @end example
 177
 178 When you get a desired text, fix it by typing @code{<CR>} or @code{C-l}.
 179 Just type another graphic key is also ok.  In the former case, you are
 180 moved to transition-phase, and in the latter case, you are moved to
 181 fence-phase.
 182
 183 Hitting @code{C-g} will let you go back to fence-phase.
 184 @end itemize
 185
 186 Here's a summary of the phases:
 187
 188 @example
 189         normal-phase
 190              ^
 191              |
 192             C-\
 193              |
 194              V
 195         transition-phase -- graphic-key --> fence-phase
 196                         \                    |      ^
 197                          \                 <SPC>    |
 198                           \                  |    graphic-key
 199                            \                 V      |
 200                             `<-- <CR> --- translation-phase
 201 @end example
 202
 203 @contents
 204 @bye