[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: [RFR] English debconf templates uim



dai@debian.org wrote:
> I would appreciate if you have any time to review
> the new debconf template for uim package.

Okay, patch attached.

> Template: uim/inputmethods
> Type: multiselect
> Choices: byeoru, ipa-x-sampa, latin, look, m17nlib, pinyin, viqr
> Default: byeoru, ipa-x-sampa, latin, look, m17nlib, pinyin, viqr
> _Description: Input methods to register:

What this means isn't clear to me.  Given that it's possible to
"register" multiple input methods, clearly it isn't talking about
selecting one as "active".  And if it just means something like "make
it available", what reason would there ever be for UIM not
automatically registering all of them?

But I'm carrying on in the assumption that this all makes sense to IM
users...

>  The uim package can use various input methods.  The following are currently
>  available:

(The debconf standard is to use only one space after a stop, though it
hardly matters because flowed text gets converted to that format
anyway.)

>  .
>   - byeoru     : byeoru hangul input method
>   - ipa-x-sampa: X-SAMPA IPA input method
>   - latin      : Latin script input method
>   - look       : Dictionary-based completion input method
>   - m17nlib    : m17nlib input method
>   - pinyin     : pinyin input method
>   - viqr       : Vietnamese Quoted-Readable input method

If we're writing lowercase "hanyul" and "pinyin" we definitely
shouldn't capitalise "dictionary".

Explaining "m17nlib" in a list of input methods by saying it provides
the m17nlib input method is a bit uninformative, compared to the way
byeoru (for instance) adds a mention of hangul.  We could at least
hint at the explanation of the name:

    - m17nlib    : m17nlib multilingual input method

>  .
>  The following input methods require package installation.  Automatically
>  registered after package installation:

That last sentence isn't clear (or a sentence).  If I correctly
understand the situation, I'd suggest saying:

   Extra input methods are available for Japanese, and will be registered
   automatically if you install the corresponding package:

>  .
>   - anthy           : Install `uim-anthy` package.
>   - skk             : Install `uim-skk` package.
>   - tcode           : Install `uim-tcode` package.

I could pedantically change a lot of trivial details - the spacing,
the capitalisation, the style of quotation marks... even the dashes
might be better as asterisks.  But more significantly, it seems to be
providing the wrong information.  Once I see that there's a
package named "uim-tcode", it's obvious that there's an input method
known to UIM as "tcode" that requires me to install that plugin
package.  The part that isn't necessarily obvious is that "tcode" is
the input method slightly better known as "TUT-code".

    - install "uim-anthy" for the anthy input method
    - install "uim-skk" for the SKK input method
    - install "uim-tcode" for the T-code/TUT-code input method

(I'm deliberately not making it look like a natural continuation of
the previous list, because we don't want users to see "tcode" at the
bottom of the list of available IMs and immediately expect to be able
to select it from this debconf menu.)
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
--- template	2017-08-17 13:16:47.380252137 +0100
+++ template.jbr	2017-08-17 13:25:25.677315490 +0100
@@ -3,20 +3,20 @@
 Choices: byeoru, ipa-x-sampa, latin, look, m17nlib, pinyin, viqr
 Default: byeoru, ipa-x-sampa, latin, look, m17nlib, pinyin, viqr
 _Description: Input methods to register:
- The uim package can use various input methods.  The following are currently
+ The uim package can use various input methods. The following are currently
  available:
  .
   - byeoru     : byeoru hangul input method
   - ipa-x-sampa: X-SAMPA IPA input method
   - latin      : Latin script input method
-  - look       : Dictionary-based completion input method
-  - m17nlib    : m17nlib input method
+  - look       : dictionary-based completion input method
+  - m17nlib    : m17nlib multilingual input method
   - pinyin     : pinyin input method
   - viqr       : Vietnamese Quoted-Readable input method
  .
- The following input methods require package installation.  Automatically
- registered after package installation:
+ Extra input methods are available for Japanese, and will be registered
+ automatically if you install the corresponding package:
  .
-  - anthy           : Install `uim-anthy` package.
-  - skk             : Install `uim-skk` package.
-  - tcode           : Install `uim-tcode` package.
+  - install "uim-anthy" for the anthy input method
+  - install "uim-skk"  for the SKK input method
+  - install "uim-tcode" for the T-code/TUT-code input method

Reply to: