("japanese"): Docstring augmented.

1 files changed, 209 insertions, 8 deletions

diff --git a/leim/quail/japanese.el b/leim/quail/japanese.el
index 6a6036a3c90..eb231ea9da6 100644
--- a/leim/quail/japanese.el
+++ b/leim/quail/japanese.el
@@ -128,16 +128,217 @@
           (activate-input-method (car pkg))))))
   (throw 'quail-tag nil))
 
+;; $B%m!<%^;zF~NO5Z$S2>L>4A;zJQ49$K$h$kF|K\8lF~NO%a%=%C%I(B
+;;
+;; $B$3$NF~NO%a%=%C%I$G$NF|K\8l$NF~NO$OFs$D$N%9%F!<%8!V%m!<%^;z2>L>JQ49!W(B
+;; $B$H!V2>L>4A;zJQ49!W$+$i$J$k!#:G=i$O%m!<%^;z2>L>JQ49$N%9%F!<%8$G!"%9(B
+;; $B%Z!<%9%-!<$r2!$9$3$H$K$h$j!"<!$N%9%F!<%8!V2>L>4A;zJQ49!W$X?J$`!#(B
+;;
+;; $B!V%m!<%^;z2>L>JQ49!W(B
+;;
+;; $BJ?2>L>$O>.J8;z%-!<!JNs!K$rBG$D$3$H$K$h$jF~NO!#6gFIE@!"3g8LN`$OBP1~(B
+;; $B$9$k1Q;z%-!<$rBG$D$3$H$K$h$jF~NO!#$=$NB>$N%7%s%\%k$O(B `z' $B$KB3$1$F2?(B
+;; $B$l$+$N%-!<$rBG$D$3$H$K$h$jF~NO!#2<$KA4$F$N2DG=$J%-!<%7!<%1%s%9%j%9(B
+;; $B%H%"%C%W$5$l$F$$$k!#F~NO$5$l$?J8;z$O2<@~$G<($5$l$k!#(B
+;;
+;; $B$5$i$K0J2<$N%-!<$GFCJL$J=hM}$r9T$&!#(B
+;;
+;; K    $BJ?2>L>$rJR2>L>$K!"$"$k$$$OJR2>L>$rJ?2>L>$KJQ49(B
+;; qq   $B$3$NF~NO%a%=%C%I$H(B `japanese-ascii' $BF~NO%a%=%C%I$r%H%0%k@ZBX(B
+;; qz   `japanese-zenkaku' $BF~NO%a%=%C%I$K%7%U%H(B
+;;      qh $B$HBG$F$P85$KLa$k(B
+;; RET  $B8=:_$NF~NOJ8;zNs$r3NDj(B
+;; SPC  $B2>L>4A;zJQ49$K?J$`(B
+;;
+;; `japanese-ascii' $BF~NO%a%=%C%I$O(B ASCII $BJ8;z$rF~NO$9$k$N$K;H$&!#$3$l(B
+;; $B$OF~NO%a%=%C%I$r%*%U$K$9$k$N$H$[$H$s$IF1$8$G$"$k!#0[$J$k$N$O(B qq $B$H(B
+;; $BBG$D$3$H$K$h$j!"(B`japanese' $BF~NO%a%=%C%I$KLa$l$kE@$G$"$k!#(B
+;;
+;; `japanese-zenkaku' $BF~NO%a%=%C%I$OA43Q1Q?t;z$rF~NO$9$k$N$K;H$&!#(B
+;;
+;; $B0J2<$K!V%m!<%^;z2>L>JQ49!W%9%F!<%8$G$N%-!<%7!<%1%s%9$r5s$2$k!#(B
+;;
+;; [omitted]
+;;
+;; $B!V2>L>4A;zJQ49!W(B
+;;
+;; $B$3$N%9%F!<%8$G$O!"A0%9%F!<%8$GF~NO$5$l$?J8;zNs$r2>L>4A;zJQ49$9$k!#(B
+;; $BJQ49$5$l$?J8;zNs$O!"CmL\J8@a!JH?E>I=<(!K$H;D$j$NF~NO!J2<@~I=<(!K$K(B
+;; $BJ,$1$i$l$k!#CmL\J8@a$KBP$7$F$O0J2<$N%3%^%s%I$,;H$($k!#(B
+;;
+;; SPC, C-n     kkc-next
+;;      $B<!$NJQ498uJd$rI=<((B
+;; C-p          kkc-prev
+;;      $BA0$NJQ498uJd$rI=<((B
+;; l            kkc-show-conversion-list-or-next-group
+;;      $B:G9b#1#08D$^$G$NJQ498uJd$r%(%3!<%(%j%"$KI=<(!#(B
+;;      $BB3$1$FBG$?$l$l$P!"<!$N#1#08uJd$rI=<(!#(B
+;; L            kkc-show-conversion-list-or-prev-group
+;;      $B:G9b#1#08D$^$G$NJQ498uJd$r%(%3!<%(%j%"$KI=<(!#(B
+;;      $BB3$1$FBG$?$l$l$P!"A0$N#1#08uJd$rI=<(!#(B
+;; 0..9         kkc-select-from-list
+;;      $BBG$?$l$??t;z$NJQ498uJd$rA*Br(B
+;; H            kkc-hiragana
+;;      $BCmL\J8@a$rJ?2>L>$KJQ49(B
+;; K            kkc-katakana
+;;      $BCmL\J8@a$rJR2>L>$KJQ49(B
+;; C-o          kkc-longer
+;;      $BCmL\J8@a$r8e$m$K0lJ8;z?-$P$9(B
+;; C-i          kkc-shorter
+;;      $BCmL\J8@a$r8e$m$+$i0lJ8;z=L$a$k(B
+;; C-f          kkc-next-phrase
+;;      $BCmL\J8@a$r3NDj$5$;$k!#$b$7;D$j$NF~NO$,$^$@$"$l$P!":G=i$NJ8@a$r(B
+;;      $BA*Br$7!"$=$l$rCmL\J8@a$H$7!"$=$N:G=i$NJQ498uJd$rI=<($9$k!#(B
+;; DEL, C-c     kkc-cancel
+;;      $B2>L>4A;zJQ49$r%-%c%s%;%k$7!"%m!<%^;z2>L>JQ49$N%9%F!<%8$KLa$k!#(B
+;; return               kkc-terminate
+;;      $BA4J8@a$r3NDj$5$;$k!#(B
+;; C-SPC, C-@   kkc-first-char-only
+;;      $B:G=i$NJ8;z$r3NDj$5$;!";D$j$O:o=|$9$k!#(B
+;; C-h          kkc-help
+;;      $B$3$l$i$N%-!<%P%$%s%I$N%j%9%H$rI=<($9$k!#$"(B
+
 (quail-define-package
  "japanese" "Japanese" "A$B$"(B"
  nil
- "Romaji -> Hiragana -> Kanji&Kana
----- Special key bindings ----
-qq:     toggle between input methods `japanese' and `japanese-ascii'
-qz:     use `japanese-zenkaku' package, \"qh\" puts you back to `japanese'
-K:      toggle converting region between Katakana and Hiragana
-SPC:    convert to Kanji&Kana
-z:      insert one Japanese symbol according to a key which follows
+ "Japanese input method using Roman transliteration and Kana-Kanji conversion.
+
+When you use this input method, text entry proceeds in two stages:
+Roman-Kana transliteration and Kana-Kanji conversion.  When you start
+to enter text, you are in the first stage, Roman-Kana transliteration.
+Type SPC to proceed to the next stage, Kana-Kanji conversion.
+
+:: Roman-Kana transliteration ::
+
+You can input any Hiragana character as a sequence of lower-case
+letters, Japanese punctuation characters by typing punctuation keys,
+Japanese symbols by typing `z' followed by another key.  See below for
+a list of all available sequences.  The characters you input are
+underlined.
+
+In addition, the following keys provide special effects:
+
+K       Change Hiragana to Katakana or Katakana to Hiragana.
+qq      Toggle between this input method and the `japanese-ascii' input method.
+qz      Shift to the `japanese-zenkaku' input method.
+        Typing \"qh\" will put you back to this input method.
+RET     Accept the current character sequence.
+SPC     Proceed to the next stage, Kana-Kanji conversion.
+
+The `japanese-ascii' input method is used to enter ASCII characters.
+This is almost the same as turning off the input method.  The only
+difference is that typing `qq' will put you back into the Japanese
+input method.
+
+The `japanese-zenkaku' input methods is used to enter full width
+JISX0208 characters corresponding to typed ASCII characters.
+
+Here's a list of key sequences for Roman-Kana transliteration.
+
+a  $B$"(B  i $B$$(B  u $B$&(B  e $B$((B  o $B$*(B
+ka $B$+(B ki $B$-(B ku $B$/(B ke $B$1(B ko $B$3(B     ga $B$,(B gi $B$.(B gu $B$0(B ge $B$2(B go $B$4(B
+sa $B$5(B si $B$7(B su $B$9(B se $B$;(B so $B$=(B     za $B$6(B zi $B$8(B zu $B$:(B ze $B$<(B zo $B$>(B
+ta $B$?(B ti $B$A(B tu $B$D(B te $B$F(B to $B$H(B     da $B$@(B di $B$B(B du $B$E(B de $B$G(B do $B$I(B
+na $B$J(B ni $B$K(B nu $B$L(B ne $B$M(B no $B$N(B
+ha $B$O(B hi $B$R(B hu $B$U(B he $B$X(B ho $B$[(B     ba $B$P(B bi $B$S(B bu $B$V(B be $B$Y(B bo $B$\(B
+ma $B$^(B mi $B$_(B mu $B$`(B me $B$a(B mo $B$b(B     pa $B$Q(B pi $B$T(B pu $B$W(B pe $B$Z(B po $B$](B
+ya $B$d(B       yu $B$f(B       yo $B$h(B
+ra $B$i(B ri $B$j(B ru $B$k(B re $B$l(B ro $B$m(B
+la $B$i(B li $B$j(B lu $B$k(B le $B$l(B lo $B$m(B
+wa $B$o(B wi $B$p(B wu $B$&(B we $B$q(B wo $B$r(B n' $B$s(B                      
+
+kya $B$-$c(B kyu $B$-$e(B kye $B$-$'(B kyo $B$-$g(B
+sha $B$7$c(B shu $B$7$e(B she $B$7$'(B sho $B$7$g(B sya $B$7$c(B syu $B$7$e(B sye $B$7$'(B syo $B$7$g(B 
+cha $B$A$c(B chu $B$A$e(B che $B$A$'(B cho $B$A$g(B tya $B$A$c(B tyu $B$A$e(B tye $B$A$'(B tyo $B$A$g(B
+nya $B$K$c(B nyu $B$K$e(B nye $B$K$'(B nyo $B$K$g(B
+hya $B$R$c(B hyu $B$R$e(B hye $B$R$'(B hyo $B$R$g(B
+mya $B$_$c(B myu $B$_$e(B mye $B$_$'(B myo $B$_$g(B
+rya $B$j$c(B ryu $B$j$e(B rye $B$j$'(B ryo $B$j$g(B lya $B$j$c(B lyu $B$j$e(B lye $B$j$'(B lyo $B$j$g(B
+gya $B$.$c(B gyu $B$.$e(B gye $B$.$'(B gyo $B$.$g(B
+zya $B$8$c(B zyu $B$8$e(B zye $B$8$'(B zyo $B$8$g(B jya $B$8$c(B jyu $B$8$e(B jye $B$8$'(B jyo $B$8$g(B
+ja  $B$8$c(B ju  $B$8$e(B je  $B$8$'(B jo  $B$8$g(B
+bya $B$S$c(B byu $B$S$e(B bye $B$S$'(B byo $B$S$g(B pya $B$T$c(B pyu $B$T$e(B pye $B$T$'(B pyo $B$T$g(B
+                                   
+kwa $B$/$n(B kwi $B$/$#(B kwe $B$/$'(B kwo $B$/$)(B
+tsa $B$D$!(B tsi $B$D$#(B tse $B$D$'(B tso $B$D$)(B
+fa  $B$U$!(B fi  $B$U$#(B fe  $B$U$'(B fo  $B$U$)(B
+gwa $B$0$n(B gwi $B$0$#(B gwe $B$0$'(B gwo $B$0$)(B
+dyi $B$G$#(B dyu $B$I$%(B dye $B$G$'(B dyo $B$I$)(B
+
+shi $B$7(B   tyi $B$F$#(B chi $B$A(B   tsu $B$D(B   ji $B$8(B fu  $B$U(B
+xwi $B$&$#(B xwe $B$&$'(B xwo $B$&$)(B ye  $B$$$'(B
+
+va $B%t$!(B vi $B%t$#(B vu $B%t(B ve $B%t$'(B vo $B%t$)(B
+
+xa  $B$!(B xi  $B$#(B xu  $B$%(B xe  $B$'(B xo  $B$)(B xtu $B$C(B
+xya $B$c(B xyu $B$e(B xyo $B$g(B xwa $B$n(B xka $B%u(B xke $B%v(B
+
+Digists and punctuations:
+
+key:  1 2 3 4 5 6 7 8 9 0 - = \ ` ! @ # $ % ^ & * ( ) _ + | ~
+char: $B#1#2#3#4#5#6#7#8#9#0!<!a!o!.!*!w!t!p!s!0!u!v!J!K!2!\!C!1(B
+
+key:  [ ] { } ; ' : \" , . / < > ?
+char: $B!V!W!P!Q!(!G!"!#!?!'!I!c!d!)(B
+                 
+Symbols (`z' followed by these keys):
+
+Key:  1 2 3 4 5 6 7 8 9 0 - = \ ` ! @ # $ % ^ & * ( ) _ + | ~
+char: $B!{"&"$""!~!y!}!q!i!j!A!b!@!-!|"'"%"#"!!z!r!_!Z![!h!^!B!/(B
+
+Key:  [ ] { } ; ' : \" , . / < > ?
+char: $B!X!Y!L!M!+!F!,!H!E!D!&!e!f!g(B
+
+Key:  b c d f g h j k l m n p q r s t v w B C D F G M N P Q R S T V W
+char: $B!k!;!5!7!>"+"-","*!m!l")!T!9!3!:"(!U"+!n!6"*!="."-",!R!8!4!x!`!S(B
+
+Key:  x   X
+str:  :-  :-)
+
+:: Kana-Kanji conversion ::
+
+You can convert the current Japanese characters (underlined) to
+Kana-Kanji mixed text.  In this stage, the converted text is divided
+into two parts, the current phrase (highlighted) and the remaining
+input (underlined).  The following commands can be used on the
+current phrase.
+
+SPC, C-n        kkc-next
+        Show the next candidate for the current phrase.
+C-p             kkc-prev
+        Show the previous candidate for the current phrase.
+l               kkc-show-conversion-list-or-next-group
+        Show at most 10  candidates for the current phrase in echo area.
+        If typed repeatedly, show the next 10 candidates.
+L               kkc-show-conversion-list-or-prev-group
+        Show at most 10 candidates for the current phrase in echo area.
+        If typed repeatedly, show the previous 10 candidates.
+0..9            kkc-select-from-list
+        Select a candidate corresponding to the typed number.
+H               kkc-hiragana
+        Convert the current phrase to Hiragana
+K               kkc-katakana
+        Convert the current phrase to Katakana
+C-o             kkc-longer
+        Extend the current phrase; pull in the first character of
+        the remaining input.
+C-i             kkc-shorter
+        Contract the current phrase; drop its last character
+        back into the remaining input.
+C-f             kkc-next-phrase
+        Accept the current phrase.  If there remains input, select
+        the first phrase as the current one, and show the first
+        candidate for the conversion.
+DEL, C-c        kkc-cancel
+        Cancel the conversion, shift back to the Roman-Kana
+        transliteration.
+return          kkc-terminate
+        Accept the whole conversion.
+C-SPC, C-@      kkc-first-char-only
+        Accept the first character of the current conversion,
+        delete the remaining input.
+C-h             kkc-help
+        List these key bindings.
 "
  nil t t nil nil nil nil nil
  'quail-japanese-update-translation
@@ -247,7 +448,7 @@ z:	insert one Japanese symbol according to a key which follows
 ("z;" "$B!+(B") ("z:" "$B!,(B")
 ("z\'" "$B!F(B") ("z\"" "$B!H(B")
 
-("zx" ":-") ("zX" ":-)")
+("zx" [":-"]) ("zX" [":-)"])
 ("zc" "$B!;(B") ("zC" "$B!n(B")
 ("zv" "$B"((B") ("zV" "$B!`(B")
 ("zb" "$B!k(B") ("zB" "$B"+(B")