FORMATS/IM.txt

   1 /* Copyright (C) 2003, 2004, 2005
   2      National Institute of Advanced Industrial Science and Technology (AIST)
   3      Registration Number H15PRO112
   4    See the end for copying conditions.  */
   5
   6 /***en
   7
   8 @page mdbIM Input Method
   9
  10 @section im-description DESCRIPTION
  11
  12 The m17n library provides a driver for input methods that are
  13 dynamically loadable from the m17n database (see @ref m17nInputMethod
  14 @latexonly (P.\pageref{group__m17nInputMethod}) @endlatexonly).
  15
  16 This section describes the data format that defines those input
  17 methods.
  18
  19 @section im-format SYNTAX and SEMANTICS
  20
  21 The following data format defines an input method.  The driver loads a
  22 definition from a file, a stream, etc.  The definition is converted
  23 into the form of plist in the driver.
  24
  25 @verbatim
  26 INPUT-METHOD ::=
  27     IM-DECLARATION ? DESCRIPTION ? VARIABLE-LIST ? COMMAND-LIST ?
  28     TITLE MAP-LIST MACRO-LIST ? MODULE-LIST ? STATE-LIST
  29
  30 IM-DECLARATION ::= '(' 'input-method' LANGUAGE NAME [ VERSION ] ')'
  31 DESCRIPTION ::= '(' 'description' [ MTEXT-OR-GETTEXT | nil] ')'
  32 VARIABLE-LIST ::= '(' 'variable' VARIABLE-DECLARATION * ')'
  33 COMMAND-LIST ::= '(' 'command' COMMAND-DECLARATION * ')'
  34 TITLE ::= '(' 'title' TITLE-TEXT ')'
  35
  36 VARIABLE-DECLARATION ::=
  37     '(' VAR-NAME [ MTEXT-OR-GETTEXT | nil ] VALUE VALUE-CANDIDATE * ')'
  38
  39 COMMAND-DECLARATION ::=
  40     '(' CMD-NAME [ MTEXT-OR-GETTEXT | nil ] KEYSEQ * ')'
  41
  42 MTEXT-OR-GETTEXT ::=
  43     [ MTEXT | '(' '_' MTEXT ')']
  44
  45 LANGUAGE ::= SYMBOL
  46 NAME ::= SYMBOL
  47 VERSION ::= MTEXT
  48 IM-DESCRIPTION ::= MTEXT
  49 VAR-NAME ::= SYMBOL
  50 VAR-DESCRIPTION ::= MTEXT
  51 VALUE ::= MTEXT | SYMBOL | INTEGER
  52 VALUE-CANDIDATE ::= VALUE | '(' RANGE-FROM RANGE-TO ')'
  53 RANGE-FROM ::= INTEGER
  54 RANGE-TO ::= INTEGER
  55 CMD-NAME ::= SYMBOL
  56 CMD-DESCRIPTION ::= MTEXT
  57 TITLE-TEXT ::= MTEXT
  58 @endverbatim
  59
  60 @c VERSION specifies the required minimum version number of the m17n
  61 library.  The format is is "XX.YY.ZZ" where XX is a major version
  62 number, YY is a minor version number, and ZZ is a patch level.
  63
  64 @c IM-DECLARATION specifies the language and name of this input
  65 method.
  66
  67 @c DESCRIPTION specifies the description text of this input method by
  68 MTEXT-OR-GETTEXT.  It it takes the second form, the text is translated
  69 according to the current locale by "gettext" (if the translation is
  70 provided).
  71
  72 @c VARIABLE-DECLARATION declares a variable used in this input method.
  73 If a variable must be initialized to the default value, or is to be
  74 customized by a user, it must be declared here.
  75
  76 @c COMMAND-DECLARATION declares a command used in this input method.
  77 If a command must be bound to the default key sequence, or is to be
  78 customized by a user, it must be declared here.
  79
  80 @c TITLE-TEXT is a text displayed on the screen when this input method
  81 is active.
  82
  83 @verbatim
  84 MAP-LIST ::= '(' 'map' MAP * ')'
  85
  86 MAP ::= '(' MAP-NAME RULE * ')'
  87
  88 MAP-NAME ::= SYMBOL
  89
  90 RULE ::= '(' KEYSEQ MAP-ACTION * ')'
  91
  92 KEYSEQ ::= MTEXT | '(' [ SYMBOL | INTEGER ] * ')'
  93 @endverbatim
  94
  95 @c SYMBOL in the definitions of @c MAP-NAME must not be @c t nor @c
  96 nil.
  97
  98 @c MTEXT in the definition of @c KEYSEQ consists of characters that
  99 can be generated by a keyboard.  Therefore @c MTEXT usually contains
 100 only ASCII characters.  However, if the input method is intended to be
 101 used, for instance, with a West European keyboard, @c MTEXT may
 102 contain Latin-1 characters.
 103
 104 @c SYMBOL in the definition of @c KEYSEQ must be the return value of
 105 the minput_event_to_key () function.  Under the X window system, you
 106 can quickly check the value using the @c xev command.  For example,
 107 the return key, the backspace key, and the 0 key on the keypad are
 108 represented as @c (Return) , @c (BackSpace) , and @c (KP_0)
 109 respectively.  If the shift, control, meta, alt, super, and hyper
 110 modifiers are used, they are represented by the S- , C- , M- , A- , s-
 111 , and H- prefixes respectively in this oreder.  Thus, "return with
 112 shift with meta with hyper" is @c (S-M-H-Return) .  Note that "a with
 113 shift" .. "z with shift" are represented simply as A .. Z . Thus "a
 114 with shift with meta with hyper" is @c (M-H-A) .
 115
 116 @c INTEGER in the definition of @c KEYSEQ must be a valid character
 117 code.
 118
 119 @verbatim
 120 MAP-ACTION ::= ACTION
 121
 122 ACTION ::= INSERT | DELETE | SELECT | MOVE | MARK
 123            | SHOW | HIDE | PUSHBACK | POP | UNDO | UNHANDLE | SHIFT | CALL
 124            | SET | IF | COND | '(' MACRO-NAME ')'
 125
 126 PREDEFINED-SYMBOL ::=
 127     '@0' | '@1' | '@2' | '@3' | '@4'
 128     | '@5' | '@6' | '@7' | '@8' | '@9'
 129     | '@<' | '@=' | '@>' | '@-' | '@+' | '@[' | '@]'
 130     | '@@'
 131     | '@-N' | '@+N'
 132 @endverbatim
 133 @verbatim
 134 MACRO-LIST ::= '(' 'macro' MACRO * ')'
 135
 136 MACRO ::= '(' MACRO-NAME MACRO-ACTION * ')'
 137
 138 MACRO-NAME ::= SYMBOL
 139
 140 MACRO-ACTION ::= ACTION
 141 @endverbatim
 142 @verbatim
 143 MODULE-LIST ::= '(' 'module' MODULE * ')'
 144
 145 MODULE ::= '(' MODULE-NAME FUNCTION * ')'
 146
 147 MODULE-NAME ::= SYMBOL
 148
 149 FUNCTION ::= SYMBOL
 150 @endverbatim
 151
 152 Each @c MODULE declares the name of external module (i.e. dynamic
 153 library) and function names exported by the module.  If a @c FUNCTION has
 154 name "init", it is called with only the default arguments (see the
 155 section about @c CALL) when an input context is created for the input
 156 method.  If a @c FUNCTION has name "fini", it is called with only the
 157 default arguments when an input context is destroyed.
 158
 159 @verbatim
 160 STATE-LIST ::= '(' 'state' STATE * ')'
 161
 162 STATE ::= '(' STATE-NAME [ STATE-TITLE-TEXT ] BRANCH * ')'
 163
 164 STATE-NAME ::= SYMBOL
 165
 166 STATE-TITLE-TEXT ::= MTEXT
 167
 168 BRANCH ::= '(' MAP-NAME BRANCH-ACTION * ')'
 169            | '(' nil BRANCH-ACTION * ')'
 170            | '(' t BRANCH-ACTION * ')'
 171 @endverbatim
 172
 173 The optional @c STATE-TITLE-TEXT specifies a title text displayed on
 174 the screen when the input method is in this state.  If @c
 175 STATE-TITLE-TEXT is omitted, @c TITLE-TEXT is used.
 176
 177 In the first form of @c BRANCH, @c MAP-NAME must be an item that
 178 appears in @c MAP.  In this case, if a key sequence matching one of @c
 179 KEYSEQs of @c MAP-NAME is typed, @c BRANCH-ACTIONs are executed.
 180
 181 In the second form of @c BRANCH, @c BRANCH-ACTIONs are executed if a
 182 key sequence that doesn't match any of @c Branch's of the current
 183 state is typed.
 184
 185 In the third form of @c BRANCH, @c BRANCH-ACTIONs are executed when
 186 shifted to the current state.  If the current state is the initial
 187 state, @c BRANCH-ACTIONs are executed also when an input context of
 188 the input method is created.
 189
 190 @verbatim
 191 BRANCH-ACTION ::= ACTION
 192 @endverbatim
 193
 194 An input method has the following two lists of symbols.
 195
 196 <ul>
 197 <li> marker list
 198
 199 A marker is a symbol indicating a character position in the preediting
 200 text.  The @c MARK action assigns a position to a marker.  The
 201 position of a marker is referred by the @c MOVE and the @c DELETE actions.
 202
 203 <li> variable list
 204
 205 A variable is a symbol associated with an integer value.  The value of
 206 a variable is set by the @c SET action, and is referred by the @c SET,
 207 the @c INSERT, and the @c IF actions.  All variables are implicitly
 208 initialized to zero.
 209
 210 </ul>
 211
 212 Each @c PREDEFINED-SYMBOL has a special meaning when used as a marker.
 213
 214 <ul>
 215 <li> @c @@0, @c @@1, @c @@2, @c @@3, @c @@4, @c @@5, @c @@6, @c @@7, @c @@8, @c @@9
 216
 217 The 0th, 1st, 2nd, ... 9th position respectively.
 218
 219 <li> @c @@<, @c @@=, @c @@>
 220
 221 The first, the current, and the last position.
 222
 223 <li> @c @@-, @c @@+
 224
 225 The previous and the next position.
 226
 227 <li> @c @@[, @c @@]
 228
 229 The previous and the next position where a candidate list changes.
 230 </ul>
 231
 232 Some of the @c PREDEFINED-SYMBOL has a special meaning when used as a candidate
 233 index in the @c SELECT action.
 234
 235 <ul>
 236
 237 <li> @c @@<, @c @@=, @c @@>
 238
 239 The first, the current, and the last candidate of the current candidate group.
 240
 241 <li> @c @@-
 242
 243 The previous candidate.  If the current candidate is the first one in
 244 the current candidate group, then it means the last candidate in the
 245 previous candidate group.
 246
 247 <li> @c @@+
 248
 249 The next candidate.  If the current candidate is the last one in the
 250 current candidate group, then it means the first candidate in the next
 251 candidate group.
 252
 253 <li> @c @@[, @c @@]
 254
 255 The candidate in the previous and the next candidate group having the same
 256 candidate index as the current one.
 257 </ul>
 258
 259 And, this also has a special meaning.
 260
 261 <ul>
 262 <li> @c @@@
 263
 264 Number of handled keys at that moment.
 265
 266 </ul>
 267
 268 These are for supporting surround text handling.
 269
 270 <ul>
 271 <li> @c @@-N
 272
 273 Here, @c N is a positive integer.  The value is a character at Nth
 274 previous position from the current caret of the surrounding text.
 275 When this is used as the argument of @c delete action, it specifies
 276 how many preceding characters in the surround text to delete.
 277
 278 <li> @c @@+N
 279
 280 Here, @c N is a positive integer.  The value is a character at Nth
 281 next position from the current caret of the surrounding text.
 282 When this is used as the argument of @c delete action, it specifies
 283 how many following characters in the surround text to delete.
 284 </ul>
 285
 286 The arguments and the behavior of each action are listed below.
 287
 288 @verbatim
 289 INSERT ::= '(' 'insert' MTEXT ')'
 290            | MTEXT
 291            | INTEGER
 292            | '(' 'insert' SYMBOL ')'
 293            | '(' 'insert' '(' CANDIDATES * ')' ')'
 294            | '(' CANDIDATES * ')'
 295
 296 CANDIDATES ::= MTEXT | '(' MTEXT * ')'
 297 @endverbatim
 298
 299 The first and second forms insert @c MTEXT before the current position.
 300
 301 The third form inserts the character @c INTEGER before the current
 302 position.
 303
 304 The fourth form treats @c SYMBOL as a variable, and inserts its value
 305 (if it is a valid character code) before the current position.
 306
 307 In the fifth and sixth forms, each @c CANDIDATES represents a
 308 candidate group, and each element of @c CANDIDATES represents a
 309 candidate, i.e. if @c CANDIDATES is an M-text, the candidates are the
 310 characters in the M-text; if @c CANDIDATES is a list of M-texts, the
 311 candidates are the M-texts in the list.
 312
 313 These forms insert the first candidate before the current position.
 314 The inserted string is associated with the list of candidates and
 315 the information indicating the currently selected candidate.
 316
 317 The marker positions affected by the insertion are automatically relocated.
 318
 319 @verbatim
 320 DELETE ::= '(' 'delete' SYMBOL ')'
 321            | '(' 'delete' INTEGER ')'
 322 @endverbatim
 323
 324 The first form treats @c SYMBOL as a marker, and deletes characters
 325 between the current position and the marker position.
 326
 327 The second form treats @c INTEGER as a character position, and deletes
 328 characters between the current position and the character position.
 329
 330 The marker positions affected by the deletion are automatically relocated.
 331
 332 @verbatim
 333 SELECT ::= '(' 'select' PREDEFINED-SYMBOL ')'
 334            | '(' 'select' INTEGER ')'
 335 @endverbatim
 336
 337 This action first checks if the character just before the current position
 338 belongs to a string that is associated with a candidate list.  If it is,
 339 the action replaces that string with a candidate specified by the
 340 argument.
 341
 342 The first form treats @c PREDEFINED-SYMBOL as a candidate index (as
 343 described above) that specifies a new candidate in the candidate list.
 344
 345 The second form treats @c INTEGER as a candidate index that specifies a
 346 new candidate in the candidate list.
 347
 348 @verbatim
 349 SHOW ::= '(show)'
 350 @endverbatim
 351
 352 This actions instructs the input method driver to display a candidate
 353 list associated with the string before the current position.
 354
 355 @verbatim
 356 HIDE ::= '(hide)'
 357 @endverbatim
 358
 359 This action instructs the input method driver to hide the currently
 360 displayed candidate list.
 361
 362 @verbatim
 363 MOVE ::= '(' 'move' SYMBOL ')'
 364          | '(' 'move' INTEGER ')'
 365 @endverbatim
 366
 367 The first form treats @c SYMBOL as a marker, and makes the marker
 368 position be the new current position.
 369
 370 The second form treats @c INTEGER as a character position, and makes
 371 that position be the new current position.
 372
 373 @verbatim
 374 MARK ::= '(' 'mark' SYMBOL ')'
 375 @endverbatim
 376
 377 This action treats @c SYMBOL as a marker, and sets its position to the
 378 current position.  @c SYMBOL must not be a @c PREDEFINED-SYMBOL.
 379
 380 @verbatim
 381 PUSHBACK :: = '(' 'pushback' INTEGER ')'
 382               | '(' 'pushback' KEYSEQ ')'
 383 @endverbatim
 384
 385 The first form pushes back the latest @c INTEGER number of key events
 386 to the event queue if @c INTEGER is positive, and pushes back all key
 387 events if @c INTEGER is zero.
 388
 389 The second form pushes back keys in @c KEYSEQ to the event queue.
 390
 391 @verbatim
 392 POP ::= '(' 'pop' ')'
 393 @endverbatim
 394
 395 This action pops the first key event that is not yet handled from the
 396 event queue.
 397
 398 @verbatim
 399 UNDO :: = '(' 'undo' [ INTEGER | SYMBOL ] ')'
 400 @endverbatim
 401
 402 If there's no argument, this action cancels the last two key events
 403 (i.e. the one that invoked this command, and the previous one).
 404
 405 If there's an integer argument NUM, it must be positive or negative
 406 (not zero).  If positive, from the NUMth to the last events are
 407 canceled.  If negative the last (- NUM) events are canceled.
 408
 409 If there's a symbol argument, it must be resolved to an integer number
 410 and the number is treated as the actual argument as above.
 411
 412 @verbatim
 413 UNHANDLE :: = '(unhandle)'
 414 @endverbatim
 415
 416 This action commit the current preedit and return the last key as
 417 unhandled.
 418
 419 @verbatim
 420 SHIFT :: = '(' 'shift' STATE-NAME ')'
 421 @endverbatim
 422
 423 This action shifts the current state to @c STATE-NAME.  @c
 424 STATE-NAME must appear in @c STATE-LIST.
 425
 426 @verbatim
 427 CALL ::= '(' 'call' MODULE-NAME FUNCTION ARG * ')'
 428
 429 ARG ::= INTEGER | SYMBOL | MTEXT | PLIST
 430 @endverbatim
 431
 432 This action calls the function @c FUNCTION of external module @c
 433 MODULE-NAME.  @c MODULE-NAME and @c FUNCTION must appear in @c
 434 MODULE-LIST.
 435
 436 The function is called with an argument of the type (#MPlist *).  The
 437 key of the first element is #Mt and its value is a pointer to an
 438 object of the type #MInputContext.  The key of the second element is
 439 #Msymbol and its value is the current state name.  @c ARGs are used as
 440 the value of the third and later elements.  Their keys are determined
 441 automatically; if an @c ARG is an integer, the corresponding key is
 442 #Minteger; if an @c ARG is a symbol, the corresponding key is
 443 #Msymbol, etc.
 444
 445 The function must return NULL or a value of the type (#MPlist *) that
 446 represents a list of actions to take.
 447
 448 @verbatim
 449 SET ::= '(' CMD SYMBOL1 EXPRESSION ')'
 450
 451 CMD ::= 'set' | 'add' | 'sub' | 'mul' | 'div'
 452
 453 EXPRESSION ::= INTEGER | SYMBOL2 | '(' OPERAND EXPRESSION * ')'
 454
 455 OPERAND ::= '+' | '-' | '*' | '/' | '|' | '&' | '!'
 456             | '=' | '<' | '>' | '<=' | '>='
 457
 458 @endverbatim
 459
 460 This action treats @c SYMBOL1 and @c SYMBOL2 as variables and sets the
 461 value of @c SYMBOL1 as below.
 462
 463 If @c CMD is 'set', it sets the value of @c SYMBOL1 to the value of @c
 464 EXPRESSION.
 465
 466 If @c CMD is 'add', it increments the value of @c SYMBOL1 by the value
 467 of @c EXPRESSION.
 468
 469 If @c CMD is 'sub', it decrements the value of @c SYMBOL1 by the value
 470 of @c EXPRESSION.
 471
 472 If @c CMD is 'mul', it multiplies the value of @c SYMBOL1 by the value
 473 of @c EXPRESSION.
 474
 475 If @c CMD is 'div', it divides the value of @c SYMBOL1 by the value of
 476 @c EXPRESSION.
 477
 478 @verbatim
 479 IF ::= '(' CONDITION ACTION-LIST1 ACTION-LIST2 ')'
 480
 481 CONDITION ::= [ '=' | '<' | '>' | '<=' | '>=' ] EXPRESSION1 EXPRESSION2
 482
 483 ACTION-LIST1 ::= '(' ACTION * ')'
 484
 485 ACTION-LIST2 ::= '(' ACTION * ')'
 486 @endverbatim
 487
 488 This action performs actions in @c ACTION-LIST1 if @c CONDITION is
 489 true, and performs @c ACTION-LIST2 (if any) otherwise.
 490
 491 @c SYMBOL1 and @c SYMBOL2 are treated as variables.
 492
 493 @verbatim
 494 COND ::= '(' 'cond' [ '(' EXPRESSION ACTION * ') ] * ')'
 495 @endverbatim
 496
 497 This action performs the first action @c ACTION whose corresponding
 498 @c EXPRESSION has nonzero value.
 499
 500 @ifnot FOR-MAN
 501
 502 @section im-example1 EXAMPLE 1
 503
 504 This is a very simple example for inputting Latin characters with
 505 diacritical marks (acute and cedilla).  For instance, when you type:
 506 @verbatim
 507     Comme'die-Franc,aise, chic,,
 508 @endverbatim
 509 you will get this:
 510 @if FOR-HTML
 511 @verbatim
 512     Commédie-Française, chic,
 513 @endverbatim
 514 @endif
 515 @if FOR-LATEX
 516 @latexonly
 517 \hskip5mm\texttt{\footnotesize Comm\'{e}die-Fran\c{c}aise, chic,}
 518 @endlatexonly
 519 @endif
 520
 521 The definition of the input method is very simple as below, and it is
 522 quite straight forward to extend it to cover all Latin characters.
 523
 524 @if FOR-HTML
 525 @verbatim
 526 (title "latin-postfix")
 527 (map
 528  (trans
 529   ("a'" ?á) ("e'" ?é) ("i'" ?í) ("o'" ?ó) ("u'" ?ú) ("c," ?ç)
 530   ("A'" ?Á) ("E'" ?É) ("I'" ?Í) ("O'" ?Ó) ("U'" ?Ú) ("C," ?Ç)
 531   ("a''" "a'") ("e''" "e'") ("i''" "i'") ("o''" "o'") ("u''" "u'")
 532   ("c,," "c,")
 533   ("A''" "A'") ("E''" "E'") ("I''" "I'") ("O''" "O'") ("U''" "U'")
 534   ("C,," "C,")))
 535 (state
 536  (init
 537   (trans)))
 538 @endverbatim
 539 @endif
 540 @if FOR-LATEX
 541 @latexonly
 542 \texttt{\footnotesize
 543 \hskip2mm(title "latin-postfix")\\
 544 \hskip2mm(map\\
 545 \hskip4mm (trans\\
 546 \hskip6mm  ("a'" ?\'{a}) ("e'" ?\'{e}) ("i'" ?\'{i}) ("o'" ?\'{o})
 547 ("u'" ?\'{u}) ("c," ?\c{c})\\
 548 \hskip6mm  ("A'" ?\'{A}) ("E'" ?\'{E}) ("I'" ?\'{I}) ("O'" ?\'{O})
 549 ("U'" ?\'{U}) ("C," ?\c{C})\\
 550 \hskip6mm  ("a''" "a'") ("e''" "e'") ("i''" "i'") ("o''" "o'") ("u''" "u'")\\
 551 \hskip6mm  ("c,," "c,")\\
 552 \hskip6mm  ("A''" "A'") ("E''" "E'") ("I''" "I'") ("O''" "O'") ("U''" "U'")\\
 553 \hskip6mm  ("C,," "C,")))\\
 554 \hskip2mm(state\\
 555 \hskip4mm (init\\
 556 \hskip6mm  (trans)))}
 557 @endlatexonly
 558 @endif
 559
 560 @section im-example2 EXAMPLE 2
 561
 562 This example is for inputting Unicode characters by typing C-u
 563 (Control-u) followed by four hexadecimal digits.  For instance, when
 564 you type ("^u" means Control-u):
 565 @verbatim
 566     ^u2190^u2191^u2192^u2193
 567 @endverbatim
 568 you will get this (Unicode arrow symbols):
 569 @verbatim
 570     ←↑→↓
 571 @endverbatim
 572
 573 The definition utilizes @c SET and @c IF commands as below:
 574 @verbatim
 575 (title "UNICODE")
 576 (map
 577  (starter
 578   ((C-U) "U+"))
 579  (hex
 580   ("0" ?0) ("1" ?1) ... ("9" ?9) ("a" ?A) ("b" ?B) ... ("f" ?F)))
 581 (state
 582  (init
 583   (starter (set code 0) (set count 0) (shift unicode)))
 584  (unicode
 585   (hex (set this @-)
 586        (< this ?A
 587           ((sub this 48))
 588           ((sub this 55)))
 589        (mul code 16) (add code this)
 590        (add count 1)
 591        (= count 4
 592           ((delete @<) (insert code) (shift init))))))
 593 @endverbatim
 594
 595 @section im-example3 EXAMPLE 3
 596
 597 This example is for inputting Chinese characters by typing PinYin key
 598 sequence.
 599 @if FOR-HTML
 600 For instance, when you type:
 601 @verbatim
 602     nihaobei2jing2
 603 @endverbatim
 604 you will get:
 605 @verbatim
 606     你好北京
 607 @endverbatim
 608
 609 The definition utilizes @c CANDIDATE and @c SELECT commands as below.
 610 Note that this is just an example, and it ignores such important key
 611 as Backspace.
 612
 613 @verbatim
 614 (title "拼")
 615
 616 (map
 617  ;; The initial character of Pinyin.
 618  (starter
 619   ("a") ("b") ... ("h") ("j") ... ("t") ("w") ("x") ("y") ("z"))
 620
 621  ;; Big table of Pinyin vs the corresponding Chinese characters.
 622  (pinyin
 623   ...
 624   ("bei" ("被北备背悲辈杯倍贝碑" ...))
 625   ("hao" ("好号毫豪浩耗皓嚎昊郝" ...))
 626   ("jing" ("经京精境警竟静惊景敬" ...))
 627   ("ni" ("你呢尼泥逆倪匿拟腻妮" ...))
 628   ...)
 629  ;; Typing 1, 2, ..., 0 selects the 0th, 1st, ..., 9th candidate.
 630  (choose
 631   ("1" (select 0)) ("2" (select 1)) ... ("9" (select 8)) ("0" (select 9))))
 632
 633 (state
 634  (init
 635   ;; When an initial character of Pinyin is typed, re-handle it in
 636   ;; "main" state.  Anything else is just produced as is.
 637   (starter (show) (pushback 1) (shift main)))
 638
 639  (main
 640   ;; When a complete Pinyin sequence is typed, shift to "select" state
 641   ;; to allow users to select one from the candidates.
 642   (pinyin (shift select))
 643
 644   ;; When anything else is typed, produce the current candidate (if
 645   ;; any), and re-handle the last input in "init" state.
 646   (nil (hide) (shift init)))
 647
 648  (select
 649   ;; When a number is typed, select the corresponding canidate,
 650   ;; produce it, and shift to "init" state.
 651   (choose (hide) (shift init))
 652
 653   ;; When anything else is typed, produce the current candidate,
 654   ;; and re-handle the last input in "init" state.
 655   (nil (hide) (shift init))))
 656 @endverbatim
 657
 658 @elseif FOR-LATEX
 659 @latexonly
 660 \begin{center}
 661 \fbox{This example is readable only in the documentation of HTML version.}
 662 \end{center}
 663 @endlatexonly
 664 @endif
 665
 666 @endif
 667
 668 @section im-seealso SEE ALSO
 669
 670 @ref mim-list "Input Methods provided by the m17n database",
 671 @ref mdbGeneral "mdbGeneral(5)"
 672 */
 673
 674 /*
 675 Copyright (C) 2003, 2004, 2005
 676   National Institute of Advanced Industrial Science and Technology (AIST)
 677   Registration Number H15PRO112
 678
 679 This file is part of the m17n database; a sub-part of the m17n
 680 library.
 681
 682 The m17n library is free software; you can redistribute it and/or
 683 modify it under the terms of the GNU Lesser General Public License
 684 as published by the Free Software Foundation; either version 2.1 of
 685 the License, or (at your option) any later version.
 686
 687 The m17n library is distributed in the hope that it will be useful,
 688 but WITHOUT ANY WARRANTY; without even the implied warranty of
 689 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 690 Lesser General Public License for more details.
 691
 692 You should have received a copy of the GNU Lesser General Public
 693 License along with the m17n library; if not, write to the Free
 694 Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 695 Boston, MA 02110-1301, USA.
 696 */
 697
 698 /* Local Variables: */
 699 /* coding: utf-8 */
 700 /* End: */