]> git.eshelyaron.com Git - emacs.git/commitdiff
(quail-cxterm-package-ext-info): Add extra docstrings for
authorKenichi Handa <handa@m17n.org>
Mon, 11 Sep 2000 23:43:45 +0000 (23:43 +0000)
committerKenichi Handa <handa@m17n.org>
Mon, 11 Sep 2000 23:43:45 +0000 (23:43 +0000)
"chinese-ccdospy", "chinese-ecdict", "chinese-etzy", "chinese-sw", and
"chinese-ziranma".  Modify the docstring of "chinese-py".

lisp/international/titdic-cnv.el

index 697effe127b2b38f810b1118186108e80a733184..9dca0741f26e651ba21ae98481b7cb1408ab6508 100644 (file)
     ("JIS" euc-japan "Japanese")
     ("KS" euc-kr "Korean")))
 
-;; List of package names and the corresponding titles.
+;; Alist of input method names and the corresponding title and extra
+;; docstring.  For each of input method generated from TIT dictionary,
+;; a docstring is automatically generated from the comments in the
+;; dictionary.  The extra docstring in this alist is to add more
+;; information.
+;; The command describe-input-method shows the automatically generated
+;; docstring, then an extra docstrings while replacing the form \<VAR>
+;; by the value of variable VAR.  For instance, the form
+;; \<quail-translation-docstring> is replaced by a description about
+;; how to select a translation from a list of candidates.
+
 (defvar quail-cxterm-package-ext-info
   '(("chinese-4corner" "\e$(0(?-F\e(B")
     ("chinese-array30" "\e$(0#R#O\e(B")
-    ("chinese-ccdospy" "\e$AKuF4\e(B")
+    ("chinese-ccdospy" "\e$AKuF4\e(B"
+     "Pinyin base input method for Chinese charset GB2312 \(`chinese-gb2312').
+
+Pinyin is the standared roman transliteration method for Chinese.
+For the detail of Pinyin system, see the documentation of the input
+method `chinese-py'.
+
+This input method works almost the same way as `chinese-py'.  The
+difference is that you type a single key for these Pinyin spelling.
+    Pinyin:  zh  en  eng ang ch  an  ao  ai  ong sh  ing  yu(\e$A(9\e(B)
+    keyseq:   a   f   g   h   i   j   k   l   s   u   y   v
+For expample:
+    Chinese:  \e$A0!\e(B    \e$A9{\e(B    \e$AVP\e(B    \e$AND\e(B    \e$A9b\e(B    \e$ASq\e(B    \e$AH+\e(B
+    Pinyin:   a    guo   zhong  wen  guang  yu   quan
+    Keyseq:   a1   guo4   as1   wf4  guh1  yu..6 qvj6
+
+\\<quail-translation-docstring>
+
+For double-width GB2312 characters correponding to ASCII, use the
+input method `chinese-qj'.")
+
     ("chinese-ctlau" "\e$AAuTA\e(B")
+
     ("chinese-ctlaub" "\e$(0N,Gn\e(B")
-    ("chinese-ecdict" "\e$(05CKH\e(B")
-    ("chinese-etzy" "\e$(06/0D\e(B")
+
+    ("chinese-ecdict" "\e$(05CKH\e(B"
+"In this input method, you enter a Chinese (Big5) charactere or word
+by typing the corresponding English word.  For example, if you type
+\"computer\", \"\e$(0IZH+\e(B\" is input.
+
+\\<quail-translation-docstring>")
+
+    ("chinese-etzy" "\e$(06/0D\e(B"
+"Zhuyin base input method for Chinese Big5 characters (`chinese-big5-1',
+`chinese-big5-2').
+
+Zhuyin is a kind of phonetic symbol.  One to three Zhuyin symbols
+compose one Chinese character.
+
+In this input method, you enter a Chinese character by first typing
+keys corresponding to Zhuyin symbols (see the above table) followed by
+SPC, 1, 2, 3, or 4 specifing a tone (SPC:\e$(0?v(N\e(B, 1:\e$(0M=Vy\e(B, 2:\e$(0Dm(N\e(B, 3: \e$(0&9Vy\e(B,
+4:\e$(0(+Vy\e(B).
+
+\\<quail-translation-docstring>")
 
     ("chinese-punct-b5" "\e$(0O:\e(BB"
      "Input method for Chinese punctuations and symbols of Big5
@@ -107,7 +157,7 @@ based, but for the character set GB2312 (`chinese-gb2312').")
 Pinyin is the standared roman transliteration method for Chinese.
 Pinyin uses a sequence of Latin alphabetic characters for each Chinese
 character.  The sequence is made by the combination of the initials
-(the beginning sounds) and finals (the ending sounds).
+\(the beginning sounds) and finals \(the ending sounds).
 
   initials: b p m f d t n l z c s zh ch sh r j q x g k h
   finals: a o e i er ai ei oa ou an en ang eng ong i ia iao ie iu ian in
@@ -116,21 +166,20 @@ character.  The sequence is made by the combination of the initials
   (Note: In the correct Pinyin writing, the sequence \"yu\" in the last
    four finals should be written by the character u-umlaut `\e$A(9\e(B'.)
 
-With this input method, each time you type a key, list of Chinese
-characters corresponding to the accumulated key sequence is shown in
-the echo area.  You can then select one character from that list by
-typing an index number or by navigating in the list of candidates with
-C-b, C-f, C-n, and C-p.
+With this input method, you enter a Chinese character by first
+entering its pinyin spelling.
+
+\\<quail-translation-docstring>
 
 For instance, to input \e$ADc\e(B, you type \"n i C-n 3\".  The first \"n i\"
 is a Pinyin, \"C-n\" selects the next group of candidates (each group
 contains at most 10 characters), \"3\" select the third character in
 that group.
 
-This input method supports only Han characters.  The more convenient
-method is `chinese-py-punct', which is the combination of this method
-and `chinese-punct', and supports both Han characters and
-punctuation/symbols.
+This input method supports only Han characters.  The related input
+method which `chinese-py-punct' is the combination of this method and
+`chinese-punct'; it supports both Han characters and punctuation
+characters.
 
 For double-width GB2312 characters corresponding to ASCII, use the
 input method `chinese-qj'.
@@ -142,14 +191,27 @@ to the same key sequence) input.  You may also want to try the input
 method `chinese-tonepy' with which you must specify tones by digits
 \(1..5).")
 
-    ("chinese-qj-b5" "\e$(0)A\e(BB"
-"
-"
-)
-    ("chinese-qj" "\e$AH+\e(BG"
-"")
+    ("chinese-qj-b5" "\e$(0)A\e(BB")
+
+    ("chinese-qj" "\e$AH+\e(BG")
+
     ("chinese-sw" "\e$AJWN2\e(B"
-"")
+"Radical base input method for Chinese charset GB2312 (`chinese-gb2312').
+
+In this input method, you enter a Chinese character byte typing two
+keys.  characters.  The first key corresponds to the first (\e$AJW\e(B)
+radical, the second key corresponds to the last (\e$AN2\e(B) radical.  The
+correspondance of keys and radicals are as below:
+
+ first radical:
+ a  b  c  d  e  f  g  h  i  j  k  l  m  n  o  p  q  r  s  t  u  v  w  x  y  z
\e$APD\e(B \e$AZ"\e(B \e$AJ,\e(B \e$AX<\e(B \e$A;p\e(B \e$A?Z\e(B \e$A^P\e(B \e$Ac_\e(B \e$AZ%\e(B \e$A\3\e(B \e$AXi\e(B \e$AD>\e(B \e$Alj\e(B \e$Ab;\e(B \e$ATB\e(B \e$Afy\e(B \e$AJ/\e(B \e$AMu\e(B \e$A0K\e(B \e$AX/\e(B \e$AHU\e(B \e$AeA\e(B \e$Aak\e(B \e$AVq\e(B \e$AR;\e(B \e$AHK\e(B 
+ last radical:
+ a  b  c  d  e  f  g  h  i  j  k  l  m  n  o  p  q  r  s  t  u  v  w  x  y  z
\e$ASV\e(B \e$AI=\e(B \e$AMA\e(B \e$A56\e(B \e$AZb\e(B \e$A?Z\e(B \e$ARB\e(B \e$Aqb\e(B \e$A4s\e(B \e$A6!\e(B \e$A[L\e(B \e$Ala\e(B \e$AJ.\e(B \e$A4u\e(B \e$AXg\e(B \e$ACE\e(B \e$A=q\e(B \e$AX-\e(B \e$AE.\e(B \e$ARR\e(B \e$A`m\e(B \e$AP!\e(B \e$A3'\e(B \e$A3f\e(B \e$A_.\e(B \e$A27\e(B 
+
+\<quail-translation-docstring>")
+
     ("chinese-tonepy" "\e$A5wF4\e(B"
      "Pinyin base input method for Chinese charset GB2312 (`chinese-gb2312').
 
@@ -158,16 +220,74 @@ For the detail of Pinyin system, see the documentation of the input
 method `chinese-py'.
 
 This input method works almost the same way as `chinese-py'.  The
-difference is that you must type 1..5 after each Pinyin to specify a
-tone.  So, to input \e$ADc\e(B, you type \"n i 3 3\", the first \"n i\" is a
-Pinyin, the next \"3\" specifies tone, and the last \"3\" selects the
-third character from the candidate list.
+difference is that you must type 1..5 after each Pinyin spelling to
+specify a tone (1:\e$ARuF=\e(B, 2:\e$AQtF=\e(B, 3:\e$AIOIy\e(B, 4\e$AOBIy\e(B, 5:\e$AGaIy\e(B).
+
+\<quail-translation-docstring>
+
+For instance, to input \e$ADc\e(B, you type \"n i 3 3\", the first \"n i\" is
+a Pinyin, the next \"3\" specifies tone, and the last \"3\" selects
+the third character from the candidate list.
 
 For double-width GB2312 characters correponding to ASCII, use the
 input method `chinese-qj'.")
 
-    ("chinese-ziranma" "\e$AK+F4\e(B")
-    ("chinese-zozy" "\e$(0I\0D\e(B")))
+    ("chinese-ziranma" "\e$AK+F4\e(B"
+"Pinyin base input method for Chinese GB2312 characters (`chinese-gb2312').
+
+Pinyin is the standared roman transliteration method for Chinese.
+For the detail of Pinyin system, see the documentation of the input
+method `chinese-py'.
+
+In this input method, unlike the standard spelling of Pinyin, all
+initials and finals are assigned to single keys (see the above table).
+For instance, the initial \"ch\" is assigned to the key `i', the final
+\"iu\" is assigned to the key `q'.  And tones 1, 2, 3, 4, and \e$AGaIy\e(B are
+assigned to the keys `q', `w', `e', `r', `t' respectively.
+
+\<quail-translation-docstring>
+
+To input one letter Chinese words, you type 4 keys, the first two for
+the Pinyin of the letter, next one for tone, and the last one is
+always quote (').  For instance, \"vsq'1\" input \e$AVP\e(B.  Exceptions are
+these letters.  You can input them just by typing a single key.
+
+       Character: \e$A04\e(B \e$A2;\e(B \e$A4N\e(B \e$A5D\e(B \e$A6~\e(B \e$A7"\e(B \e$A8v\e(B \e$A:M\e(B \e$A3v\e(B \e$A<0\e(B \e$A?I\e(B \e$AAK\e(B \e$AC;\e(B
+       Key:       a  b  c  d  e  f  g  h  i  j  k  l  m
+       Character: \e$ADc\e(B \e$AE7\e(B \e$AF,\e(B \e$AF_\e(B \e$AHK\e(B \e$AH}\e(B \e$AK{\e(B \e$AJG\e(B \e$AWE\e(B \e$ANR\e(B \e$AP!\e(B \e$AR;\e(B \e$ATZ\e(B
+       Key:       n  o  p  q  r  s  t  u  v  w  x  y  z
+
+To input two letter words, you have two ways.  One way is to type 4
+keys, two for the first Pinyin, two for the second Pinyin.  For
+instance, \"vsgo\" input \e$AVP9z\e(B.  Another is to type 3 keys\; initials
+of two letters, and quote (').  For instance, \"vg'\" also input \e$AVP9z\e(B.
+
+To input three letter words, you type 4 keys\; initials of three
+letters, and the last is quote (').  For instance, \"bjy'2\" input \e$A11\e(B
+\e$A>)Q<\e(B (the last `2' is to select one from candidates).
+
+To input words of more than three letters, you type 4 keys, initials
+of the first three letters and the last letter.  For instance,
+\"bjdt\" input \e$A11>)5gJSL(\e(B.
+
+To input symbols and punctuations, type `/' followed by one of `a' to
+`z', then select one from candidates.
+
+")
+
+    ("chinese-zozy" "\e$(0I\0D\e(B"
+"Zhuyin base input method for Chinese Big5 characters (`chinese-big5-1',
+`chinese-big5-2').
+
+Zhuyin is a kind of phonetic symbol.  One to three Zhuyin symbols
+compose a Chinese character.
+
+In this input method, you enter a Chinese character by first typing
+keys corresponding to Zhuyin symbols (see the above table) followed by
+SPC, 6, 3, 4, or 7 specifing a tone (SPC:\e$(0?v(N\e(B, 6:\e$(0Dm(N\e(B, 3:\e$(0&9Vy\e(B, 4:\e$(0(+Vy\e(B,
+7:\e$(0M=Vy\e(B).
+
+\<quail-translation-docstring>")))
 
 ;; Return a value of the key in the current line.
 (defsubst tit-read-key-value ()