create-branching-keyboard(1)					   User Commands				      create-branching-keyboard(1)

NAME

       create-branching-keyboard - create branching keyboards for GOK

SYNOPSIS

       create-branching-keyboard [--usage] infile [n-desired-rows]

DESCRIPTION

       create-branching-keyboard  takes  an  input  data file and creates a family of branching keyboard XML files in the format that GOK expects.
       Given an input file named test.data, create-branching-keyboard creates test.data.kbd, which in turn refers to a family of *.kbd files  that
       are created based on data in the input file.

OPTIONS

       The following options are supported:

       --usage	       Display usage information.

OPERANDS

       The following operands are supported:

       infile	       The name of the input file.

       n-desired-rows  If  specified,  create-branching-keyboard  attempts  to create keyboards with the specified number of rows. The recommended
		       values are between 2 and 6.

EXTENDED DESCRIPTION

       create-branching-keyboard can be used to create families of branching keyboards from UTF-8 input files. The format of the input files is as
       follows:

	 o  Lines beginning with '#' are ignored.

	 o  The  rest of the input file consists of consecutive pairs of lines. The first line of a pair is typically ignored, but should serve as
	    a UTF-8 label describing the "primary key" in the next line. The second line of the pair consists of a single UTF-8 character followed
	    by a ':' color delimiter, and a string of UTF-8 characters to which the initial character may branch.

       The  resulting  XML  file,  after  processing, defines .kbd files such that each prefix 'primary key' forms a key on the GOK keyboard whose
       label is the "primary key" UTF-8 character, and which branches to a keyboard consisting of the following UTF-8 characters, one per key.

       create-branching-keyboard is particularly useful in creating branching keyboards for ideographic languages. For instance, the  primary  key
       for a given line may consist of the UTF-8 character for a 'radical' such as hng.

EXAMPLES

       Example 1: Creating Branching Keyboards From a File Called test.data

       example% create-branching-keyboard test.data

EXIT STATUS

       The following exit values are returned:

       0	Application exited successfully

       >0	Application exited with failure

FILES

       The following files are used by this application:

       /usr/bin/create-branchinExecutable to create branching keyboards for GOK

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Availability		     |SUNWgnome-a11y-gok-share	   |
       |			     |				   |
       |			     |SUNWgnome-a11y-gok	   |
       +-----------------------------+-----------------------------+
       |Interface stability	     |External			   |
       +-----------------------------+-----------------------------+

SEE ALSO

       Latest version of the GNOME Desktop User Guide for your platform.

       gok(1)

NOTES

       The create-branching-keyboard utility is experimental and unsupported.

       Written by Bill Haneman, Sun Microsystems Inc., 2004.

SunOS 5.10							    7 Sep 2004					      create-branching-keyboard(1)