10139N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [

10139N/A<!--ArborText, Inc., 1988-1999, v.4002-->

10139N/A<!ENTITY cmd "create-branching-keyboard">

10139N/A<!ENTITY % commonents SYSTEM "smancommon.ent">

10139N/A%commonents;

10139N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">

10139N/A%booktitles;

11929N/A<!ENTITY suncopy "Copyright (c) 2004,2006,2007 Sun Microsystems, Inc. All Rights Reserved.">

10139N/A]>

10139N/A<?Pub UDT _bookmark _target>

10139N/A<?Pub EntList brvbar bull cross dash diam diams frac12 frac13 frac14 hellip

10139N/A laquo lArr loz mdash nabla ndash para pound rArr raquo sect yen eacute>

10139N/A<?Pub Inc>

10139N/A<refentry id="create-branching-keyboard-1">

13805N/A<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>

10139N/A1</manvolnum>

11929N/A<refmiscinfo class="date">13 Nov 2007</refmiscinfo>

10139N/A<refmiscinfo class="sectdesc">&man1;</refmiscinfo>

10139N/A<refmiscinfo class="software">&release;</refmiscinfo>

10139N/A<refmiscinfo class="arch">generic</refmiscinfo>

10139N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>

10139N/A</refmeta>

13805N/A<indexterm><primary>&cmd;</primary></indexterm><indexterm>

10139N/A<primary>create branching keyboards for GOK</primary></indexterm>

13805N/A<refnamediv id="create-branching-keyboard-1-name"><refname>&cmd;</refname>

13805N/A<refpurpose>create branching keyboards for GOK</refpurpose></refnamediv>

10139N/A<refsynopsisdiv id="create-branching-keyboard-1-synp"><title>&synp-tt;</title>

10139N/A<cmdsynopsis><command>&cmd;</command>

10139N/A<arg choice="plain"><replaceable>infile</replaceable></arg><arg choice="opt"><option

10139N/Arole="nodash"><replaceable>n-desired-rows</replaceable></option></arg>

10139N/A</cmdsynopsis></refsynopsisdiv>

10139N/A<refsect1 id="create-branching-keyboard-1-desc"><title>&desc-tt;</title>

10139N/A<para><command>&cmd;</command> takes an input data file and creates a family

10139N/Aof branching keyboard XML files in the format that GOK expects. Given an input

10139N/Afile named test.data, <command>&cmd;</command> creates test.data.kbd, which

10139N/Ain turn refers to a family of *.kbd files that are created based on data in

10139N/Athe input file.</para>

10139N/A</refsect1>

10139N/A<refsect1 id="create-branching-keyboard-1-oper"><title>&oper-tt;</title>

10139N/A<para>The following operands are supported:</para>

10139N/A<variablelist termlength="narrow">

10139N/A<varlistentry><term><option role="nodash"><replaceable>infile</replaceable></option></term>

10139N/A<listitem><para>The name of the input file.</para>

10139N/A</listitem></varlistentry>

10139N/A<varlistentry><term><option role="nodash"><replaceable>n-desired-rows</replaceable></option></term>

15995N/A<listitem><para>

15995N/AIf specified, <command>&cmd;</command> attempts to create keyboards with the

15995N/Aspecified number of rows. The recommended values are between 2 and 6.

15995N/A</para>

10139N/A</listitem></varlistentry>

10139N/A</variablelist></refsect1>

10139N/A<refsect1 id="create-branching-keyboard-1-exde"><title>&exde-tt;</title>

15995N/A<para>

15995N/A<command>&cmd;</command> can be used to create families of branching keyboards

15995N/Afrom UTF-8 input files. The format of the input files is as follows:

10139N/A</para>

10139N/A<itemizedlist>

15995N/A<listitem>Lines beginning with '#' are ignored.</listitem>

15995N/A<listitem>The rest of the input file consists of consecutive pairs of lines.

15995N/AThe first line of a pair is typically ignored, but should serve as a UTF-8

15995N/Alabel describing the "primary key" in the next line. The second line of the

15995N/Apair consists of a single UTF-8 character followed by a ':' color delimiter,

10139N/Aand a string of UTF-8 characters to which the initial character may branch.

15995N/A</listitem>

10139N/A</itemizedlist>

15995N/A<para>

15995N/AThe resulting XML file, after processing, defines <filename>.kbd</filename>

10139N/Afiles such that each prefix 'primary key' forms a key on the GOK keyboard

10139N/Awhose label is the "primary key" UTF-8 character, and which branches to a

15995N/Akeyboard consisting of the following UTF-8 characters, one per key.

15995N/A</para>

15995N/A<para>

15995N/A<command>&cmd;</command> is particularly useful in creating branching keyboards

15995N/Afor ideographic languages. For instance, the primary key for a given line may

15995N/Aconsist of the UTF-8 character for a 'radical' such as h&eacute;ng.

10139N/A</para>

10139N/A</refsect1>

10139N/A<refsect1 id="create-branching-keyboard-1-exam"><title>&exam-tt;</title>

10139N/A<example role="example">

10139N/A<title>Creating Branching Keyboards From a File Called test.data</title>

10139N/A<para><screen>example% <userinput>&cmd; test.data</userinput></screen></para>

10139N/A</example>

10139N/A</refsect1>

10139N/A<refsect1 id="create-branching-keyboard-1-exit"><title>&exit-tt;</title>

10139N/A<para>The following exit values are returned:</para>

10139N/A<variablelist termlength="xtranarrow">

10139N/A<varlistentry><term><returnvalue>0</returnvalue></term><listitem><para>Application

10139N/Aexited successfully</para>

10139N/A</listitem></varlistentry>

10139N/A<varlistentry><term><returnvalue>>0</returnvalue></term><listitem><para>Application

10139N/Aexited with failure</para>

10139N/A</listitem></varlistentry>

10139N/A</variablelist></refsect1>

10139N/A<refsect1 id="create-branching-keyboard-1-file"><title>&file-tt;</title>

10139N/A<para>The following files are used by this application:</para>

10139N/A<variablelist termlength="medium">

10139N/A<varlistentry><term><filename>/usr/bin/&cmd;</filename></term><listitem><para>

10139N/AExecutable to create branching keyboards for GOK</para>

10139N/A</listitem></varlistentry>

10139N/A</variablelist></refsect1>

10139N/A<refsect1 id="create-branching-keyboard-1-attr"><title>&attr-tt;</title>

10139N/A<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>

10139N/A<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>

10139N/Afor descriptions of the following attributes:</para>

10139N/A<informaltable frame="all">

10139N/A<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">

10139N/A<colspec colname="COLSPEC1" colwidth="1*">

10139N/A<thead>

10139N/A<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"

10139N/Avalign="middle">ATTRIBUTE VALUE</entry></row>

10139N/A</thead>

10139N/A<tbody>

18745N/A<row><entry><para>Availability</para></entry><entry><para>gnome/accessibility/gok

10139N/A</para><para>SUNWgnome-a11y-gok</para></entry></row>

10139N/A<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry

10139N/Acolname="COLSPEC1"><para>Volatile</para></entry></row>

10139N/A</tbody>

10139N/A</tgroup>

10139N/A</informaltable>

10139N/A</refsect1>

10139N/A<refsect1 id="create-branching-keyboard-1-also"><title>&also-tt;</title>

10139N/A<para>Latest version of the <citetitle>GNOME Desktop User Guide</citetitle>

10139N/Afor your platform.</para>

11929N/A<para>

11929N/A<citerefentry><refentrytitle>gok</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

11929N/A<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>

11929N/A</para>

10139N/A</refsect1>

10139N/A<refsect1 id="create-branching-keyboard-1-note"><title>&note-tt;</title>

11904N/A<para>The <command>&cmd;</command> utility is experimental and

10139N/Aunsupported.</para>

11929N/A<para>Written by Bill Haneman, Sun Microsystems Inc., 2004, 2006, 2007.</para>

10139N/A</refsect1>

10139N/A</refentry>