File: quail.el.html

In Quail minor mode, you can input multilingual text easily. By defining a translation table (named Quail map) which maps ASCII key string to multilingual character or string, you can input any text from ASCII keyboard.

We use words "translation" and "conversion" differently. The former is done by Quail package itself, the latter is the further process of converting a translated text to some more desirable text. For instance, Quail package for Japanese (quail-jp) translates Roman text (transliteration of Japanese in Latin alphabets) to Hiragana text, which is then converted to Kanji-and-Kana mixed text or Katakana text by commands specified in CONVERSION-KEYS argument of the Quail package.

[There was an input method for Mule 2.3 called Tamago from the
Japanese TAkusan MAtasete GOmen-nasai, or Sorry for having you wait so long; this couldn't be included in Emacs 20. Tamago is Japanese for egg (implicitly a hen's egg). Handa-san made a smaller and simpler system; the smaller quail egg is also eaten in Japan. Maybe others will be egged on to write more sorts of input methods.]

Defined variables (17)

quail-completion-max-depthThe maximum depth of Quail completion list.
quail-conv-overlayOverlay which covers the text to be converted in Quail mode.
quail-conversion-keymapKeymap used for processing conversion in Quail mode.
quail-current-dataAny Lisp object holding information of current translation status.
quail-current-keyCurrent key for translation in Quail mode.
quail-current-packageThe current Quail package, which depends on the current input method.
quail-current-strCurrently selected translation of the current key.
quail-current-translationsCons of indices and vector of possible translations of the current key.
quail-directory-nameName of Quail directory which contains Quail packages.
quail-keyboard-layoutA string which represents physical key layout of a particular keyboard.
quail-keyboard-layout-alistAlist of keyboard names and corresponding layout strings.
quail-keyboard-layout-standardStandard keyboard layout of printable characters Quail assumes.
quail-keyboard-layout-typeType of keyboard layout used in Quail base input method.
quail-overlayOverlay which covers the current translation region of Quail.
quail-package-alistList of Quail packages.
quail-simple-translation-keymapKeymap used while processing translation in simple Quail modes.
quail-translation-keymapKeymap used processing translation in complex Quail modes.

Defined functions (94)

quail-abort-translation()
quail-activate(&optional ARG)
quail-add-package(PACKAGE)
quail-add-unread-command-events(KEY &optional RESET)
quail-advice(ARGS)
quail-build-decode-map(MAP-LIST KEY DECODE-MAP NUM &optional MAXNUM IGNORES)
quail-char-equal-p(CHAR TARGET)
quail-completion()
quail-completion-1(KEY MAP INDENT)
quail-completion-list-translations(MAP KEY INDENT)
quail-conversion-keymap()
quail-deactivate()
quail-decode-map()
quail-define-package(NAME LANGUAGE TITLE &optional GUIDANCE DOCSTRING TRANSLATION-KEYS FORGET-LAST-SELECTION DETERMINISTIC KBD-TRANSLATE SHOW-LAYOUT CREATE-DECODE-MAP MAXIMUM-SHORTEST OVERLAY-PLIST UPDATE-TRANSLATION-FUNCTION CONVERSION-KEYS SIMPLE)
quail-define-rules(&rest RULES)
quail-defrule(KEY TRANSLATION &optional NAME APPEND)
quail-defrule-internal(KEY TRANS MAP &optional APPEND DECODE-MAP PROPS)
quail-delete-last-char()
quail-delete-region()
quail-deterministic()
quail-do-conversion(FUNC &rest ARGS)
quail-docstring()
quail-error(&rest ARGS)
quail-find-key(CHAR)
quail-find-key1(MAP KEY CHAR KEY-LIST)
quail-forget-last-selection()
quail-gen-decode-map1(MAP KEY TABLE)
quail-get-current-str(LEN DEF)
quail-get-translation(DEF KEY LEN)
quail-get-translations()
quail-guidance()
quail-help(&optional PACKAGE)
quail-help-insert-keymap-description(KEYMAP &optional HEADER)
quail-hide-guidance()
quail-indent-to(COL)
quail-input-method(KEY)
quail-input-string-to-events(STR)
quail-insert-decode-map(DECODE-MAP)
quail-insert-kbd-layout(KBD-LAYOUT)
quail-install-decode-map(DECODE-MAP &optional NAME)
quail-install-map(MAP &optional NAME)
quail-kbd-translate()
quail-keyboard-translate(CHAR)
quail-keyseq-translate(KEYSEQ)
quail-lookup-key(KEY &optional LEN NOT-RESET-INDICES)
quail-lookup-map-and-concat(KEY)
quail-make-guidance-frame()
quail-map()
quail-map-definition(MAP)
quail-map-from-table(TABLE)
quail-map-from-table-1(STATE-ALIST STATE-INFO)
quail-map-from-table-2(STATE-ALIST ELEMENT)
quail-map-p(OBJECT)
quail-maximum-shortest()
quail-minibuffer-message(STRING)
quail-mouse-choose-completion(EVENT)
quail-name()
quail-next-translation()
quail-next-translation-block()
quail-no-conversion()
quail-overlay-plist()
quail-overlay-region-events(OVERLAY)
quail-package(NAME)
quail-point-in-conversion-region()
quail-prev-translation()
quail-prev-translation-block()
quail-require-guidance-buf()
quail-select-current()
quail-select-package(NAME)
quail-self-insert-command()
quail-set-keyboard-layout(KBD-TYPE)
quail-setup-completion-buf()
quail-setup-overlays(CONVERSION-MODE)
quail-show-guidance()
quail-show-key()
quail-show-keyboard-layout(&optional KEYBOARD-TYPE)
quail-show-layout()
quail-simple()
quail-start-conversion(KEY)
quail-start-translation(KEY)
quail-store-decode-map-key(TABLE CHAR KEY)
quail-terminate-translation()
quail-title()
quail-translate-key()
quail-translation-help()
quail-translation-keymap()
quail-update-current-translations(&optional RELATIVE-INDEX)
quail-update-guidance()
quail-update-keyboard-layout(KBD-TYPE)
quail-update-leim-list-file(DIRNAME &rest DIRNAMES)
quail-update-translation(CONTROL-FLAG)
quail-update-translation-function()
quail-use-package(PACKAGE-NAME &rest LIBRARIES)
quail-vunion(V1 V2)

Defined faces (0)