[Uim] Improvement of documentation

[Martin Swift]

On Sun, Nov 19, 2006 at 11:26:36PM +0900, YAMAMOTO Kengo / YamaKen wrote:
> At Sun, 19 Nov 2006 12:03:55 +0000,
> martin at swift.is wrote:
> > I'm wanting to completely rewrite them. I'll put an outline up soon.
> 
> I look forward to read it.

OK, I sat down, did some brain storming and have come up with the
following suggestion for a documentation structure. I tried to focus
on accessibility for users new to the software

In particular, I tried to make the Usage section task-oriented as
opposed to tool-oriented.

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?)
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?)
    * 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.

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.

Cheers,
Martin

-- 
\u270C