[Uim] Improvement of documentation

[YAMAMOTO Kengo / YamaKen]

At Fri, 24 Nov 2006 13:24:46 +0000,
martin at swift.is wrote:
> 
> In particular, I tried to make the Usage section task-oriented as
> opposed to tool-oriented.

Sounds good. And your document organization is reasonable and
personally preferable. Please go ahead.

> Introduction
>  - What does UIM currently do and what is the goal of the project?
>  - (What is the difference between UIM and other IMs such as SCIM)
>  - Which tools are a part of UIM, what do they do and how do they fit
>   together?
>  - Which programs does UIM interface with?
> Installation
>  - From Source

>  - Distro package managers
>     (should this simply refer to distributions' docs for their
>     respective package managers?)

I think it's enough at first.

> Usage
>  - Setup
>     * Environment variables
>       + GTK_IM_MODULE
>       + QT_IM_MODULE
>       + XMODIFIERS
>       + UIM_CANDWIN_PROG
>       (any more?)
>     * Toolbars
>  - Switching between input modes (is this basically direct/anthy/etc.
>    or is there just a direct/dict and the dict is changed by other
>    means?)
>  - Customization

>     * Graphical tools
>      (it doesn't matter which tool -- gtk or qt -- one uses, right?)

Basically yes. But it may indicate some trivial differences.

>     * Text files
> Support
>  - FAQs
>  - Troubleshooting
>  - UIM mailing list.

> In addition to this, I think having a manual page on each tool is a
> very good idea. These can then be made into man pages.

Indeed.

> Manuals
>   Dictionary tools
>     * uim-chardict-qt 
>     * uim-dict-gtk
>   Bridges
>     * uim-fep
>     * uim-xim
>   Preferences 
>     - see also: Usage > Customization > Graphical tools
>     * uim-pref-gtk 
>     * uim-pref-qt
>   Toolbars
>     * uim-helper-toolbar-gtk
>     * uim-helper-toolbar-gtk-systray
>     * uim-toolbar-gtk
>     * uim-toolbar-gtk-systray
>     * uim-toolbar-qt
>   Switchers
>     * uim-im-switcher-gtk 
>     * uim-im-switcher-qt
>   Input pad
>     * uim-input-pad-ja
>   Misc (what are these?)
>     * uim-fep-tick
>     * uim-module-manager
>     * uim-sh

> Finally, there could be a Development section, though this might
> better belong on the Google Code page.

I'll prepare them until uim 2.0.

------------------------------------------------
YAMAMOTO Kengo / YamaKen  yamaken at bp.iij4u.or.jp
FAMILY   Given / Nick