fdo-mirrors/xorg-libx11
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/xorg/lib/libx11.git synced 2026-05-07 19:08:11 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

specs/XKB: Turn Table references into links

Browse source 
Adds id attributes to all table tags so we can link to them

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
This commit is contained in:
Alan Coopersmith 2014-07-07 21:30:01 -07:00
parent 135fa07b74
commit 087a233847
19 changed files with 283 additions and 205 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
specs/XKB/ch01.xml
View file

@ -352,7 +352,8 @@ Xkb functions that communicate with the X server check to be sure the Xkb
extension has been properly initialized prior to doing any other operations. If
the extension has not been properly initialized or the application, library,
and server versions are incompatible, these functions return an error
indication as shown in Table 1.1. Because of this test,
indication as shown in <link linkend="table1.1">Table 1.1</link>.
Because of this test,
<errorname>BadAccess</errorname>
and
<errorname>BadMatch</errorname>
@ -360,7 +361,7 @@ indication as shown in Table 1.1. Because of this test,
generated.
</para>
<table frame='topbot'>
<table id='table1.1' frame='topbot'>
<!-- <caption>Function Error Returns Due to Extension Problems</caption> -->
<title>Function Error Returns Due to Extension Problems</title>
<?dbfo keep-together="always" ?>
@ -397,7 +398,8 @@ applications may never actually need to communicate with the server; they
simply use the Xkb library capabilities. The functions that do not communicate
with the server return either a pointer to a structure, a Bool, or a Status.
These functions check that the application has queried the Xkb library version
and return the values shown in Table 1.1 if it has not.
and return the values shown in <link linkend="table1.1">Table 1.1</link>
if it has not.
</para>
</sect2>
</sect1>

10
specs/XKB/ch02.xml
View file

@ -574,10 +574,11 @@ requests in Xlib and the server.
</para>
<para>
Table 2.1 lists the protocol errors that can be generated, and their causes. <!-- xref -->
<link linkend="table2.1">Table 2.1</link>
lists the protocol errors that can be generated, and their causes.
</para>
<table frame='topbot'>
<table id='table2.1' frame='topbot'>
<title>Xkb Protocol Errors</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -675,12 +676,13 @@ additional information is reported in the
<emphasis>resource_id</emphasis>
field. The most significant byte of the
<emphasis>resource_id</emphasis>
is a further refinement of the error cause, as defined in Table 2.2. The least
is a further refinement of the error cause, as defined in
<link linkend="table2.2">Table 2.2</link>. The least
significant byte will contain the device, class, or feedback ID as indicated in
the table.
</para>
<table frame='topbot'>
<table id='table2.2' frame='topbot'>
<title>BadKeyboard Protocol Error resource_id Values</title>
<?dbfo keep-together="always" ?>
<tgroup cols='4' align='left' colsep='0' rowsep='0'>

16
specs/XKB/ch04.xml
View file

@ -65,14 +65,15 @@ constants declared in the header file
<para>
Table 4.1 lists the categories of events defined by Xkb and their associated
<link linkend="table4.1">Table 4.1</link>
lists the categories of events defined by Xkb and their associated
event types, as defined in
<filename class="headerfile">Xkb.h</filename>.
Each event is described in more detail in the section referenced for that
event.
</para>
<table frame='topbot'>
<table id='table4.1' frame='topbot'>
<title>Xkb Event Types</title>
<?dbfo keep-together="always" ?>
<tgroup cols='4' align='left' colsep='0' rowsep='0'>
@ -307,7 +308,8 @@ and
milliseconds. The
<emphasis>xkb_type</emphasis>
field contains the minor extension event code, which is the extension event
type, and is one of the values listed in Table 4.1. The
type, and is one of the values listed in
<link linkend="table4.1">Table 4.1</link>. The
<emphasis>device</emphasis>
field contains the keyboard device identifier associated with the event. This
is never
@ -461,7 +463,8 @@ in the
parameter and do not set the corresponding bit in the
<emphasis>values_for_bits</emphasis>
parameter. The valid values for both of these parameters are an inclusive
bitwise OR of the masks shown in Table 4.2. There is no interface to return
bitwise OR of the masks shown in <link linkend="table4.2">Table 4.2</link>.
There is no interface to return
your client’s current event selection mask. Clients cannot set other
clients’ event selection masks.
</para>
@ -656,12 +659,13 @@ in <link linkend="Selecting_Xkb_Events">section 4.3</link>.
<para>
Table 4.2 lists the event mask constants that can be specified with the <!-- xref -->
<link linkend="table4.2">Table 4.2</link>
lists the event mask constants that can be specified with the
<function>XkbSelectEvents</function>
request and the circumstances in which the mask should be specified.
</para>
<table frame='topbot'>
<table id='table4.2' frame='topbot'>
<title>XkbSelectEvents Mask Constants</title>
<?dbfo keep-together="always" ?>
<tgroup cols='3' align='left' colsep='0' rowsep='0'>

16
specs/XKB/ch05.xml
View file

@ -303,7 +303,7 @@ The functions in this section that change the use of modifiers use a mask in the
It is a bitwise inclusive OR of the legal modifier masks:
</para>
<table frame='none'>
<table id='table5.1' frame='none'>
<title>Real Modifier Masks</title>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
@ -511,7 +511,7 @@ To latch and unlatch any of the eight real keyboard modifiers, use
Reference the keysym group indices with these symbolic constants:
</para>
<table frame='topbot'>
<table id='table5.2' frame='topbot'>
<title>Symbolic Group Names</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -780,10 +780,12 @@ events to clients wanting notification whenever the Xkb state changes. The chang
<para>
There are many different types of Xkb state changes. Xkb defines an event detail mask corresponding to each type of change. The event detail masks are listed in Table 5.3.
There are many different types of Xkb state changes. Xkb defines an event
detail mask corresponding to each type of change. The event detail masks are
listed in <link linkend="table5.3">Table 5.3</link>.
</para>
<table frame='topbot'>
<table id='table5.3' frame='topbot'>
<title>XkbStateNotify Event Detail Masks</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -898,7 +900,7 @@ To receive
<emphasis>bits_to_change</emphasis>
and
<emphasis>values_for_bits</emphasis>
using mask bits from Table 5.3. <!-- xref -->
using mask bits from <link linkend="table5.3">Table 5.3</link>.
</para>
@ -949,8 +951,8 @@ When you receive an
field indicates which elements of keyboard state have changed.
This will be the bitwise inclusive OR of one or more of the
<emphasis>XkbStateNotify</emphasis>
event detail masks shown in Table 5.3. All fields reported in <!-- xref -->
the event are valid, but only those indicated in
event detail masks shown in <link linkend="table5.3">Table 5.3</link>.
All fields reported in the event are valid, but only those indicated in
<emphasis>changed</emphasis>
have changed values.
</para>

11
specs/XKB/ch06.xml
View file

@ -69,13 +69,14 @@ keyboard.
<para>
The other fields specify structure components of the keyboard description and
are described in detail in other sections of this document. Table 6.1
are described in detail in other sections of this document.
<link linkend="table6.1">Table 6.1</link>
identifies the subsequent sections of this document that discuss the individual
components of the
<emphasis>XkbDescRec</emphasis>.
</para>
<table frame='topbot'>
<table id='table6.1' frame='topbot'>
<title>XkbDescRec Component References</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -126,10 +127,10 @@ calls to indicate that the structure should be manipulated in some manner, such
as allocating it or freeing it. These masks and their relationships to the
fields in the
<emphasis>XkbDescRec</emphasis>
are shown in Table 6.2. <!-- xref -->
are shown in <link linkend="table6.2">Table 6.2</link>.
</para>
<table frame='topbot'>
<table id='table6.2' frame='topbot'>
<title>Mask Bits for XkbDescRec</title>
<?dbfo keep-together="always" ?>
<tgroup cols='3' align='left' colsep='0' rowsep='0'>
@ -260,7 +261,7 @@ server for those components specified in the
<emphasis>NULL</emphasis>.
The valid masks for
<emphasis>which</emphasis>
are those listed in Table 6.2. <!-- xref -->
are those listed in <link linkend="table6.2">Table 6.2</link>.
</para>

26
specs/XKB/ch08.xml
View file

@ -200,10 +200,10 @@ The
field specifies the conditions under which the indicator can be changed and
the effects of changing the indicator. The valid values for
<emphasis>flags</emphasis>
and their effects are shown in Table 8.1. <!-- xref -->
and their effects are shown in <link linkend="table8.1">Table 8.1</link>.
</para>
<table frame='topbot'>
<table id='table8.1' frame='topbot'>
<title>XkbIndicatorMapRec flags Field</title>
<?dbfo keep-together="always" ?>
<tgroup cols='3' align='left' colsep='0' rowsep='0'>
@ -354,10 +354,10 @@ If
<emphasis>which_groups</emphasis>
and
<emphasis>groups</emphasis>
is shown in Table 8.2. <!-- xref -->
is shown in <link linkend="table8.2">Table 8.2</link>.
</para>
<table frame='topbot'>
<table id='table8.2' frame='topbot'>
<title>XkbIndicatorMapRec which_groups and groups, Keyboard Drives
Indicator</title>
<?dbfo keep-together="always" ?>
@ -432,11 +432,12 @@ The effect of
<emphasis>groups</emphasis>
when you change an indicator for which
<emphasis>XkbIM_LEDDrivesKB</emphasis>
is set (the indicator drives the keyboard) is shown in Table 8.3. The "New
is set (the indicator drives the keyboard) is shown in
<link linkend="table8.3">Table 8.3</link>. The "New
State" column refers to the new state to which you set the indicator.
</para>
<table frame='topbot'>
<table id='table8.3' frame='topbot'>
<title>XkbIndicatorMapRec which_groups and groups, Indicator Drives
Keyboard</title>
<?dbfo keep-together="always" ?>
@ -598,10 +599,10 @@ If
<emphasis>which_mods</emphasis>
and
<emphasis>mods</emphasis>
is shown in Table 8.4 <!-- xref -->
is shown in <link linkend="table8.4">Table 8.4</link>
</para>
<table frame='topbot'>
<table id='table8.4' frame='topbot'>
<title>XkbIndicatorMapRec which_mods and mods, Keyboard Drives Indicator</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -703,11 +704,12 @@ The effect on the keyboard modifiers of
<emphasis>mods</emphasis>
when you change an indicator for which
<emphasis>XkbIM_LEDDrivesKB</emphasis>
is set (the indicator drives the keyboard) is shown in Table 8.5. The "New
is set (the indicator drives the keyboard) is shown in
<link linkend="table8.5">Table 8.5</link>. The "New
State" column refers to the new state to which you set the indicator.
</para> <!-- xref -->
<table frame='topbot'>
<table id='table8.5' frame='topbot'>
<title>XkbIndicatorMapRec which_mods and mods, Indicator Drives Keyboard</title>
<?dbfo keep-together="always" ?>
<tgroup cols='3' align='left' colsep='0' rowsep='0'>
@ -1232,7 +1234,9 @@ or, to reduce network traffic, use an
<para>
This section discusses the effects of explicitly changing indicators depending
upon different settings in the indicator map. See Tables 8.3 and Table 8.5 for
upon different settings in the indicator map. See
<link linkend="table8.3">Table 8.3</link> and
<link linkend="table8.5">Table 8.5</link> for
information on the effects of the indicator map fields when explicit changes
are made.
</para>

12
specs/XKB/ch09.xml
View file

@ -109,13 +109,15 @@ any sounds. Any sounds or other effects (such as visual bells on the screen)
must be generated by a client application upon receipt of the bell event
containing the name. There is no default name for the default keyboard bell.
The server does generate some predefined bells for the AccessX controls (see
<link linkend="The_AccessXFeedback_Control">section 10.6.3</link>). These named bells are shown in Table 9.1; the name is included
<link linkend="The_AccessXFeedback_Control">section 10.6.3</link>).
These named bells are shown in <link linkend="table9.1">Table 9.1</link>;
the name is included
in any bell event sent to clients that have requested to receive
<emphasis>XkbBellNotify</emphasis>
events.
</para>
<table frame='topbot'>
<table id='table9.1' frame='topbot'>
<title>Predefined Bells</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -261,12 +263,12 @@ A device can have more than one feedback of each type; set
</para>
<para>
Table 9.2 shows the conditions that cause a bell to sound or an <emphasis> <!-- xref -->
XkbBellNotifyEvent</emphasis>
<link linkend="table9.2">Table 9.2</link> shows the conditions that cause
a bell to sound or an <emphasis>XkbBellNotifyEvent</emphasis>
to be generated when a bell function is called.
</para>
<table frame='topbot'>
<table id='table9.2' frame='topbot'>
<title>Bell Sounding and Bell Event Generating</title>
<?dbfo keep-together="always" ?>
<tgroup cols='4' align='left' colsep='0' rowsep='0'>

81
specs/XKB/ch10.xml
View file

@ -53,10 +53,11 @@ function to manipulate one control individually, you do not use an
<para>
The Xkb controls are grouped as shown in Table 10.1. <!-- xref -->
The Xkb controls are grouped as shown in
<link linkend="table10.1">Table 10.1</link>.
</para>
<table frame='topbot'>
<table id='table10.1' frame='topbot'>
<title>Xkb Keyboard Controls</title>
<?dbfo keep-together="always" ?>
<tgroup cols='3' align='left' colsep='0' rowsep='0'>
@ -222,7 +223,7 @@ control is enabled, and when turned off, disabled. It corresponds to the
field of an
<emphasis>XkbControlsRec</emphasis>
structure (see <link linkend="The_XkbControlsRec_Structure">section 10.8</link>). The bits describing which controls are turned on
or off are defined in Table 10.7. <!-- xref -->
or off are defined in <link linkend="table10.7">Table 10.7</link>.
</para>
@ -301,7 +302,8 @@ The
<emphasis>values</emphasis>
mask specifies the new state for those controls. Valid values for both of
these masks are composed of a bitwise inclusive OR of bits taken from the set
of mask bits in Table 10.7, using only those masks with "ok" in the
of mask bits in <link linkend="table10.7">Table 10.7</link>,
using only those masks with "ok" in the
<emphasis>enabled_ctrls</emphasis>
column.
</para>
@ -1245,7 +1247,7 @@ mouse-pointer key yields one mouse event. When
structure (see <link linkend="The_XkbControlsRec_Structure">section 10.8</link>). <!-- xref -->
</para>
<table frame='topbot'>
<table id='table10.2' frame='topbot'>
<title>MouseKeysAccel Fields</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -1885,7 +1887,7 @@ on or off by modifying the following bits in the
(see <link linkend="Changing_Controls">section 10.10</link>): <!-- xref -->
</para>
<table frame='topbot'>
<table id='table10.3' frame='topbot'>
<title>AccessXFeedback Masks</title>
<?dbfo keep-together="always" ?>
<tgroup cols='3' align='left' colsep='0' rowsep='0'>
@ -2031,10 +2033,10 @@ typedef struct {
The
<emphasis>detail</emphasis>
field describes what AccessX event just occurred and can be any of the values
in Table 10.4. <!-- xref -->
in <link linkend="table10.4">Table 10.4</link>.
</para>
<table frame='topbot'>
<table id='table10.4' frame='topbot'>
<title>AccessXNotify Events</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -2130,10 +2132,10 @@ To receive
<emphasis>bits_to_change</emphasis>
and
<emphasis>values_for_bits</emphasis>
using mask bits from Table 10.5. <!-- xref -->
using mask bits from <link linkend="table10.5">Table 10.5</link>.
</para>
<table frame='topbot'>
<table id='table10.5' frame='topbot'>
<title>AccessXNotify Event Details</title>
<?dbfo keep-together="always" ?>
<tgroup cols='3' align='left' colsep='0' rowsep='0'>
@ -3476,8 +3478,9 @@ typedef struct {
<para>
The general-purpose functions that work with the
<emphasis>XkbControlsRec</emphasis>
structure use a mask to specify which controls are to be manipulated. Table
10.6 lists these controls, the masks used to select them in the general
structure use a mask to specify which controls are to be manipulated.
<link linkend="table10.6">Table 10.6</link>
lists these controls, the masks used to select them in the general
function calls (
<emphasis>which</emphasis>
parameter), and the data fields in the
@ -3487,7 +3490,7 @@ bit used to turn boolean controls on and off and the section where each control
is described in more detail.
</para>
<table frame='topbot'>
<table id='table10.6' frame='topbot'>
<title>Xkb Controls</title>
<?dbfo keep-together="auto" ?>
<tgroup cols='5' align='left' colsep='0' rowsep='0'>
@ -3670,7 +3673,8 @@ is described in more detail.
</table>
<para>
Table 10.7 shows the actual values for the individual mask bits used to select <!-- xref -->
<link linkend="table10.7">Table 10.7</link>
shows the actual values for the individual mask bits used to select
controls for modification and to enable and disable the control. Note that the
same mask bit is used to specify general modifications to the parameters used
to configure the control (
@ -3682,7 +3686,7 @@ configurable attributes; and for controls that are not boolean controls and
therefore cannot be enabled or disabled.
</para>
<table frame='topbot'>
<table id='table10.7' frame='topbot'>
<title>Controls Mask Bits</title>
<?dbfo keep-together="always" ?>
<tgroup cols='4' align='left' colsep='0' rowsep='0'>
@ -3878,10 +3882,10 @@ computed automatically by the server whenever the keyboard mapping changes.
control (see <link linkend="The_GroupsWrap_Control">section 10.7.1</link>). It specifies the handling of illegal groups on a <!-- xref -->
global basis. Valid values for
<emphasis>groups_wrap</emphasis>
are shown in Table 10.8.
are shown in <link linkend="table10.8">Table 10.8</link>.
</para>
<table frame='topbot'>
<table id='table10.8' frame='topbot'>
<title>GroupsWrap options (groups_wrap field)</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -3970,7 +3974,8 @@ modifier bits:
control (see <link linkend="The_EnabledControls_Control">section 10.1.1</link>). It contains one bit per boolean control. Each <!-- xref -->
bit determines whether the corresponding control is enabled or disabled; a one
bit means the control is enabled. The mask bits used to enable these controls
are listed in Table 10.7, using only those masks with "ok" in the
are listed in <link linkend="table10.7">Table 10.7</link>,
using only those masks with "ok" in the
<emphasis>enabled_ctrls</emphasis>
column.
</para>
@ -4056,10 +4061,10 @@ AccessXFeedback</emphasis>
control (see <link linkend="The_AccessXFeedback_Control">section 10.6.3</link>). The <emphasis> <!-- xref -->
ax_options</emphasis>
field is a bitmask and may include any combination of the bits defined in
Table 10.9. <!-- xref -->
<link linkend="table10.9">Table 10.9</link>.
</para>
<table frame='topbot'>
<table id='table10.9' frame='topbot'>
<title>Access X Enable/Disable Bits (ax_options field)</title>
<?dbfo keep-together="always" ?>
<tgroup cols='3' align='left' colsep='0' rowsep='0'>
@ -4174,8 +4179,9 @@ The
macro is useful for determining whether a particular AccessX option is enabled
or not. It accepts a pointer to an
<emphasis>XkbControlsRec</emphasis>
structure and a valid mask bit from Table 10.9. If the specified mask bit in
the
structure and a valid mask bit from
<link linkend="table10.9">Table 10.9</link>.
If the specified mask bit in the
<emphasis>ax_options</emphasis>
field of the controls structure is set, the macro returns the mask bit.
Otherwise, it returns zero. Thus,
@ -4361,7 +4367,8 @@ and then copies the server’s values for the requested information into the
<emphasis>which</emphasis>
parameter are copied. Valid values for
<emphasis>which</emphasis>
are any combination of the masks listed in Table 10.7 that have "ok" in the
are any combination of the masks listed in
<link linkend="table10.7">Table 10.7</link> that have "ok" in the
<emphasis>which</emphasis>
column.
</para>
@ -4512,7 +4519,8 @@ For each bit that is set in the
<emphasis>ctrls</emphasis>
field to the server. Valid values for
<emphasis>which</emphasis>
are any combination of the masks listed in Table 10.7 that have "ok" in the
are any combination of the masks listed in
<link linkend="table10.7">Table 10.7</link> that have "ok" in the
<emphasis>which</emphasis>
column.
</para>
@ -4615,10 +4623,12 @@ structure have been modified. In this context, modified means
that is, if a value is set to the same value it previously contained, it has
still been modified, and is noted as changed. Valid values for
<emphasis>changed_ctrls</emphasis>
are any combination of the masks listed in Table 10.7 that have "ok" in the
are any combination of the masks listed in
<link linkend="table10.7">Table 10.7</link> that have "ok" in the
<emphasis>changed_ctrls</emphasis>
column. Setting a bit implies the corresponding data fields from the "Relevant
XkbControlsRec Data Fields" column in Table 10.6 have been modified. The
column. Setting a bit implies the corresponding data fields from the
"Relevant XkbControlsRec Data Fields" column in
<link linkend="table10.6">Table 10.6</link> have been modified. The
<emphasis>enabled_ctrls_changes</emphasis>
field specifies which bits in the
<emphasis>enabled_ctrls</emphasis>
@ -4731,7 +4741,7 @@ To receive
<emphasis>bits_to_change</emphasis>
and
<emphasis>values_for_bits</emphasis>
using mask bits from Table 10.7. <!-- xref -->
using mask bits from <link linkend="table10.7">Table 10.7</link>.
</para>
@ -4765,7 +4775,8 @@ typedef struct {
The
<emphasis>changed_ctrls</emphasis>
field specifies the controls components that have changed and consists of bits
taken from the masks defined in Table 10.7 with "ok" in the
taken from the masks defined in
<link linkend="table10.7">Table 10.7</link> with "ok" in the
<emphasis>changed_ctrls</emphasis>
column.
</para>
@ -4779,7 +4790,8 @@ the
<emphasis>enabled_ctrls</emphasis>
field changed), they are flagged in the
<emphasis>enabled_ctrl_changes</emphasis>
field. The valid bits for these fields are the masks listed in Table 10.7 with
field. The valid bits for these fields are the masks listed in
<link linkend="table10.7">Table 10.7</link> with
"ok" in the
<emphasis>enabled_ctrls</emphasis>
column. The
@ -4896,7 +4908,7 @@ When a client receives an
The
<emphasis>wanted</emphasis>
parameter is a bitwise inclusive OR of bits taken from the set of masks
specified in Table 10.7 with "ok" in the
specified in <link linkend="table10.7">Table 10.7</link> with "ok" in the
<emphasis>changed_ctrls</emphasis>
column.
<function>XkbNoteControlsChanges</function>
@ -5091,7 +5103,8 @@ The
mask specifies the individual fields of the
<emphasis>ctrls</emphasis>
structure to be allocated and can contain any of the valid masks defined in
Table 10.7. Because none of the currently existing controls have any structures
<link linkend="table10.7">Table 10.7</link>.
Because none of the currently existing controls have any structures
associated with them, which is currently of little practical value in this call.
</para>
@ -5166,8 +5179,8 @@ The
<emphasis>which</emphasis>
mask specifies the fields of
<emphasis>ctrls</emphasis>
to be freed and can contain any of the controls components specified in Table
10.7.
to be freed and can contain any of the controls components specified in
<link linkend="table10.7">Table 10.7</link>.
</para>

13
specs/XKB/ch11.xml
View file

@ -362,10 +362,10 @@ The
<para>
The Library Controls are manipulated using functions that deal with bitmasks to
indicate which controls to manipulate. The controls are identified by the masks
defined in Table 11.1. <!-- xref -->
defined in <link linkend="table11.1">Table 11.1</link>.
</para>
<table frame='topbot'>
<table id='table11.1' frame='topbot'>
<title>Library Control Masks</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -449,7 +449,8 @@ implemented, use <function>XkbXlibControlsImplemented</function>.
<para>
<function>XkbXlibControlsImplemented</function>
returns a bitmask indicating the controls actually implemented in the Xkb
library and is composed of an inclusive OR of bits from Table 11.1.
library and is composed of an inclusive OR of bits from
<link linkend="table11.1">Table 11.1</link>.
</para>
@ -489,7 +490,8 @@ To determine the current state of the Library Controls, use
<para>
<function>XkbGetXlibControls</function>
returns the current state of the Library Controls as a bit mask that is an
inclusive OR of the control masks from Table 11.1 for the controls that are
inclusive OR of the control masks from
<link linkend="table11.1">Table 11.1</link> for the controls that are
enabled. For the optional compose processing controls, the fact that a control
is enabled does not imply that it is actually implemented.
</para>
@ -564,7 +566,8 @@ corresponding to a control is on in
<emphasis>values_for_bits</emphasis>,
the control is disabled.
<emphasis>bits_to_change</emphasis>
should be an inclusive OR of bits from Table 11.1.
should be an inclusive OR of bits from
<link linkend="table11.1">Table 11.1</link>.
</para>
</sect2>

7
specs/XKB/ch13.xml
View file

@ -550,10 +550,10 @@ specify the interpretation of logo names.
<para>
The structures these doodads are stored in and the values of the
<emphasis>type</emphasis>
fields are shown in Table 13.1.
fields are shown in <link linkend="table13.1">Table 13.1</link>.
</para>
<table frame='topbot'>
<table id='table13.1' frame='topbot'>
<title>Doodad Types</title>
<?dbfo keep-together="always" ?>
<tgroup cols='3' align='left' colsep='0' rowsep='0'>
@ -955,7 +955,8 @@ The doodad arrays in the
<emphasis>XkbGeometryRec</emphasis>
and the
<emphasis>XkbSectionRec</emphasis>
may contain any of the doodad structures and types shown in Table 13.1.
may contain any of the doodad structures and types shown in
<link linkend="table13.1">Table 13.1</link>.
</para>

51
specs/XKB/ch14.xml
View file

@ -294,7 +294,8 @@ populated.
<para>
The
<emphasis>which</emphasis>
mask is a bitwise inclusive OR of the masks defined in Table 14.1. Only those
mask is a bitwise inclusive OR of the masks defined in
<link linkend="table14.1">Table 14.1</link>. Only those
portions of the keyboard server map and the keyboard client maps that are
specified in
<emphasis>which</emphasis>
@ -346,11 +347,12 @@ free the returned data, use
<para>
Xkb also provides convenience functions to get partial component definitions
from the server. These functions are specified in the "convenience functions"
column in Table 14.1. Refer to the sections listed in the table for more
column in <link linkend="table14.1">Table 14.1</link>.
Refer to the sections listed in the table for more
information on these functions.
</para>
<table frame='topbot'>
<table id='table14.1' frame='topbot'>
<title>Xkb Mapping Component Masks and Convenience Functions</title>
<?dbfo keep-together="always" ?>
<tgroup cols='6' align='left' colsep='0' rowsep='0'>
@ -541,8 +543,9 @@ description, use <function>XkbGetUpdatedMap</function>.
<para>
The
<emphasis>which</emphasis>
parameter is a bitwise inclusive OR of the masks in Table 14.1. If the needed
components of the
parameter is a bitwise inclusive OR of the masks in
<link linkend="table14.1">Table 14.1</link>.
If the needed components of the
<emphasis>xkb</emphasis>
structure are not already allocated,
<function>XkbGetUpdatedMap</function>
@ -648,7 +651,8 @@ Use
symbols, all actions, and so on) to the server. The
<emphasis>which</emphasis>
parameter specifies the components to be sent to the server, and is a bitwise
inclusive OR of the masks listed in Table 14.1. The
inclusive OR of the masks listed in
<link linkend="table14.1">Table 14.1</link>. The
<emphasis>xkb</emphasis>
parameter is a pointer to an
<emphasis>XkbDescRec</emphasis>
@ -687,7 +691,8 @@ and
<para>
Key types, symbol maps, and actions are all interrelated; changes in one
require changes in the others. Xkb provides functions to make it easier to edit
these components and handle the interdependencies. Table 14.1 lists these
these components and handle the interdependencies.
<link linkend="table14.1">Table 14.1</link> lists these
helper functions and provides a pointer to where they are defined.
</para>
@ -748,12 +753,14 @@ The
<emphasis>changed</emphasis>
field identifies the map components that have changed in an
<emphasis>XkbDescRec</emphasis>
structure and may contain any of the bits in Table 14.1, which are also shown
in Table 14.2. Every 1 bit in
structure and may contain any of the bits in
<link linkend="table14.1">Table 14.1</link>, which are also shown
in <link linkend="table14.2">Table 14.2</link>. Every 1 bit in
<emphasis>changed</emphasis>
also identifies which other fields in the
<emphasis>XkbMapChangesRec</emphasis>
structure contain valid values, as indicated in Table 14.2. The
structure contain valid values, as indicated in
<link linkend="table14.2">Table 14.2</link>. The
<emphasis>min_key_code</emphasis>
and
<emphasis>max_key_code</emphasis>
@ -762,7 +769,7 @@ server and are always updated by the server whenever it returns the data for an
<emphasis>XkbMapChangesRec</emphasis>.
</para>
<table frame='topbot'>
<table id='table14.2' frame='topbot'>
<title>XkbMapChangesRec Masks</title>
<?dbfo keep-together="always" ?>
<tgroup cols='3' align='left' colsep='0' rowsep='0'>
@ -968,7 +975,8 @@ The Xkb extension reports
events to clients wanting notification whenever a map component of the Xkb
description for a device changes. There are many different types of Xkb
keyboard map changes. Xkb uses an event detail mask to identify each type of
change. The event detail masks are identical to the masks listed in Table 14.1.
change. The event detail masks are identical to the masks listed in
<link linkend="table14.1">Table 14.1</link>.
</para>
@ -999,7 +1007,7 @@ To receive
<emphasis>bits_to_change</emphasis>
and
<emphasis>values_for_bits</emphasis>
using mask bits from Table 14.1.
using mask bits from <link linkend="table14.1">Table 14.1</link>.
</para>
@ -1044,7 +1052,8 @@ typedef struct {
The
<emphasis>changed</emphasis>
field specifies the map components that have changed and is the bitwise
inclusive OR of the mask bits defined in Table 14.1. The other fields in this
inclusive OR of the mask bits defined in
<link linkend="table14.1">Table 14.1</link>. The other fields in this
event are interpreted as the like-named fields in an
<emphasis>XkbMapChangesRec</emphasis>
(see <link linkend="The_XkbMapChangesRec_Structure">section 14.3.1</link>). The
@ -1158,10 +1167,10 @@ The
<emphasis>which</emphasis>
parameter specifies the particular components of the client map structure to
allocate and is a mask composed by a bitwise inclusive OR of one or more of the
masks shown in Table 14.3.
masks shown in <link linkend="table14.3">Table 14.3</link>.
</para>
<table frame='topbot'>
<table id='table14.3' frame='topbot'>
<title>XkbAllocClientMap Masks</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -1357,7 +1366,8 @@ To free memory used by the client map member of an
<emphasis>NULL</emphasis>.
The
<emphasis>which</emphasis>
parameter specifies a combination of the client map masks shown in Table 14.3.
parameter specifies a combination of the client map masks shown in
<link linkend="table14.3">Table 14.3</link>.
</para>
@ -1448,10 +1458,10 @@ To allocate and initialize an empty server map description record, use
The
<emphasis>which</emphasis>
parameter specifies the particular components of the server map structure to
allocate, as specified in Table 14.4.
allocate, as specified in <link linkend="table14.4">Table 14.4</link>.
</para>
<table frame='topbot'>
<table id='table14.4' frame='topbot'>
<title>XkbAllocServerMap Masks</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -1644,7 +1654,8 @@ The
The
<emphasis>which</emphasis>
parameter specifies a combination of the server map masks and is a bitwise
inclusive OR of the masks listed in Table 14.4. If
inclusive OR of the masks listed in
<link linkend="table14.4">Table 14.4</link>. If
<emphasis>free_all</emphasis>
is
<symbol>True</symbol>,

11
specs/XKB/ch15.xml
View file

@ -233,7 +233,7 @@ keyboard mappings in the server database is not specified by the Xkb extension,
although this format is one possible example):
</para>
<table frame='topbot'>
<table id='table15.1' frame='topbot'>
<title>Example Key Type</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -1469,11 +1469,12 @@ Out-of-range groups for individual keys are mapped to a legal group using the
same options as are used for the overall keyboard group. The particular type of
mapping used is controlled by the bits set in the
<emphasis>group_info</emphasis>
flag, as shown in Table 15.2. See <link linkend="The_GroupsWrap_Control">section 10.7.1</link> for more details on the
normalization methods in this table.
flag, as shown in <link linkend="table15.2">Table 15.2</link>.
See <link linkend="The_GroupsWrap_Control">section 10.7.1</link>
for more details on the normalization methods in this table.
</para>
<table frame='topbot'>
<table id='table15.2' frame='topbot'>
<title>group_info Range Normalization</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -2316,7 +2317,7 @@ For convenience, Xkb provides the following constants to use as indices to the
groups:
</para>
<table frame='topbot'>
<table id='table15.3' frame='topbot'>
<title>Group Index Constants</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>

124
specs/XKB/ch16.xml
View file

@ -492,10 +492,11 @@ the
<emphasis>type</emphasis>
field. The valid values for the
<emphasis>type</emphasis>
field, and the data structures associated with them are shown in Table 16.1:
field, and the data structures associated with them are shown in
<link linkend="table16.1">Table 16.1</link>:
</para>
<table frame='topbot'>
<table id='table16.1' frame='topbot'>
<title>Action Types</title>
<?dbfo keep-together="always" ?>
<tgroup cols='4' align='left' colsep='0' rowsep='0'>
@ -642,7 +643,8 @@ In the following description, the term
means the real modifier bits associated with this action. Depending on the
value of
<emphasis>flags</emphasis>
(see Table 16.3), these are designated either in the
(see <link linkend="table16.3">Table 16.3</link>),
these are designated either in the
<emphasis>mask</emphasis>
field of the
<emphasis>XkbModAction</emphasis>
@ -660,10 +662,11 @@ is being used. In the latter case, this is the client
<para>
The
<emphasis>type</emphasis>
field can have any of the values shown in Table 16.2.
field can have any of the values shown in
<link linkend="table16.2">Table 16.2</link>.
</para>
<table frame='topbot'>
<table id='table16.2' frame='topbot'>
<title>Modifier Action Types</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -778,12 +781,13 @@ key press occurred, a key release unlocks them.
<para>
The
<emphasis>flags</emphasis>
field is composed of the bitwise inclusive OR of the masks shown in Table
16.3. A general meaning is given in the table, but the exact meaning depends on
field is composed of the bitwise inclusive OR of the masks shown in
<link linkend="table16.3">Table 16.3</link>.
A general meaning is given in the table, but the exact meaning depends on
the action <emphasis>type</emphasis>.
</para>
<table frame='topbot'>
<table id='table16.3' frame='topbot'>
<title>Modifier Action Flags</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -1012,7 +1016,7 @@ The
field can have any of the following values:
</para>
<table frame='topbot'>
<table id='table16.4' frame='topbot'>
<title>Group Action Types</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -1139,13 +1143,14 @@ A key release has no effect.
<para>
The
<emphasis>flags</emphasis>
field is composed of the bitwise inclusive OR of the masks shown in Table
16.5. A general meaning is given in the table, but the exact meaning depends on
field is composed of the bitwise inclusive OR of the masks shown in
<link linkend="table16.5">Table 16.5</link>.
A general meaning is given in the table, but the exact meaning depends on
the action
<emphasis>type</emphasis>.
</para>
<table frame='topbot'>
<table id='table16.5' frame='topbot'>
<title>Group Action Flags</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -1345,10 +1350,11 @@ The
<para>
The
<emphasis>flags</emphasis>
field is a bitwise inclusive OR of the masks shown in Table 16.6.
field is a bitwise inclusive OR of the masks shown in
<link linkend="table16.6">Table 16.6</link>.
</para>
<table frame='topbot'>
<table id='table16.6' frame='topbot'>
<title>Pointer Action Types</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -1609,10 +1615,11 @@ If the
<para>
The
<emphasis>type</emphasis>
field can have any one of the values shown in Table 16.7.
field can have any one of the values shown in
<link linkend="table16.7">Table 16.7</link>.
</para>
<table frame='topbot'>
<table id='table16.7' frame='topbot'>
<title>Pointer Button Action Types</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -1738,14 +1745,15 @@ a button, the key release is ignored and has no effect.
<para>
The
<emphasis>flags</emphasis>
field is composed of the bitwise inclusive OR of the masks shown in Table
16.8. A general meaning is given in the table, but the exact meaning depends on
field is composed of the bitwise inclusive OR of the masks shown in
<link linkend="table16.8">Table 16.8</link>.
A general meaning is given in the table, but the exact meaning depends on
the action
<emphasis>type</emphasis>.
:
</para>
<table frame='topbot'>
<table id='table16.8' frame='topbot'>
<title>Pointer Button Action Flags</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -1844,11 +1852,12 @@ The
<para>
The
<emphasis>flags</emphasis>
field is composed of the bitwise inclusive OR of the values shown in Table
16.9 (currently there is only one value defined).
field is composed of the bitwise inclusive OR of the values shown in
<link linkend="table16.9">Table 16.9</link>
(currently there is only one value defined).
</para>
<table frame='topbot'>
<table id='table16.9' frame='topbot'>
<title>Pointer Default Flags</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -2076,11 +2085,11 @@ If the
field, the action is used to change the group state. The remaining valid bits
of the
<emphasis>flags</emphasis>
field are composed of a bitwise inclusive OR using the masks shown in Table
16.10.
field are composed of a bitwise inclusive OR using the masks shown in
<link linkend="table16.10">Table 16.10</link>.
</para>
<table frame='topbot'>
<table id='table16.10' frame='topbot'>
<title>ISO Action Flags when XkbSA_ISODfltIsGroup is Set</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -2187,11 +2196,11 @@ If the
field, the action is used to change the modifier state and the remaining valid
bits of the
<emphasis>flags</emphasis>
field are composed of a bitwise inclusive OR using the masks shown in Table
16.11.
field are composed of a bitwise inclusive OR using the masks shown in
<link linkend="table16.11">Table 16.11</link>.
</para>
<table frame='topbot'>
<table id='table16.11' frame='topbot'>
<title>ISO Action Flags when XkbSA_ISODfltIsGroup is Not Set</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -2342,11 +2351,11 @@ the two formats as shown in <link linkend="Actions_for_Changing_Modifiers_State"
<para>
The
<emphasis>affect</emphasis>
field is composed of a bitwise inclusive OR using the masks shown in Table
16.11.
field is composed of a bitwise inclusive OR using the masks shown in
<link linkend="table16.11">Table 16.11</link>.
</para>
<table frame='topbot'>
<table id='table16.12' frame='topbot'>
<title>ISO Action Affect Field Values</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -2461,11 +2470,11 @@ The
<para>
The
<emphasis>flags</emphasis>
field is composed of the bitwise inclusive OR of the masks shown in Table
16.13.
field is composed of the bitwise inclusive OR of the masks shown in
<link linkend="table16.13">Table 16.13</link>.
</para>
<table frame='topbot'>
<table id='table16.13' frame='topbot'>
<title>Switch Screen Action Flags</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -2623,10 +2632,11 @@ typedef struct _XkbCtrlsAction {
<para>
The
<emphasis>type</emphasis>
field can have any one of the values shown in Table 16.14.
field can have any one of the values shown in
<link linkend="table16.14">Table 16.14</link>.
</para>
<table frame='topbot'>
<table id='table16.14' frame='topbot'>
<title>Controls Action Types</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -2708,11 +2718,11 @@ This action can cause
<para>
The
<emphasis>flags</emphasis>
field is composed of the bitwise inclusive OR of the masks shown in Table
16.15.
field is composed of the bitwise inclusive OR of the masks shown in
<link linkend="table16.15">Table 16.15</link>.
</para>
<table frame='topbot'>
<table id='table16.15' frame='topbot'>
<title>Control Action Flags</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -2892,11 +2902,11 @@ The
<para>
The
<emphasis>flags</emphasis>
field is composed of the bitwise inclusive OR of the masks shown in Table
16.16.
field is composed of the bitwise inclusive OR of the masks shown in
<link linkend="table16.16">Table 16.16</link>.
</para>
<table frame='topbot'>
<table id='table16.16' frame='topbot'>
<title>Message Action Flags</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -3379,10 +3389,11 @@ typedef struct _XkbDeviceBtnAction {
<para>
The
<emphasis>type</emphasis>
field can have any one of the values shown in Table 16.17.
field can have any one of the values shown in
<link linkend="table16.17">Table 16.17</link>.
</para>
<table frame='topbot'>
<table id='table16.17' frame='topbot'>
<title>Device Button Action Types</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -3492,11 +3503,11 @@ the key release is ignored and has no effect.
<para>
The
<emphasis>flags</emphasis>
field is composed of the bitwise inclusive OR of the masks shown in Table
16.18.
field is composed of the bitwise inclusive OR of the masks shown in
<link linkend="table16.18">Table 16.18</link>.
</para>
<table frame='topbot'>
<table id='table16.18' frame='topbot'>
<title>Device Button Action Flags</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -3575,7 +3586,8 @@ The low four bits of
<emphasis>v2_what</emphasis>
specify the corresponding scale value (denoted
<emphasis>val&lt;n&gt;Scale</emphasis>
in Table 16.17), if needed. The high four bits of
in <link linkend="table16.17">Table 16.17</link>), if needed.
The high four bits of
<emphasis>v1_what</emphasis>
and
<emphasis>v2_what</emphasis>
@ -3583,12 +3595,13 @@ The low four bits of
<emphasis>v1_what</emphasis>
and
<emphasis>v2_what</emphasis>
can have the values shown in Table 16.17; the use of
can have the values shown in <link linkend="table16.17">Table 16.17</link>;
the use of
<emphasis>val&lt;n&gt;Scale</emphasis>
is shown in that table also.
</para>
<table frame='topbot'>
<table id='table16.19' frame='topbot'>
<title>Device Valuator v&lt;n&gt;_what High Bits Values</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -3652,7 +3665,7 @@ absolute valuators. For relative valuators, only
<emphasis>XkbSA_SetValRelative</emphasis>
is permitted. Part of the input extension description of a device is the range
of legal values for all absolute valuators, whence the maximum and minimum
legal values shown in Table 16.17.
legal values shown in <link linkend="table16.17">Table 16.17</link>.
</para>
@ -4020,10 +4033,11 @@ The
<emphasis>data</emphasis>
field depends on the
<emphasis>type</emphasis>.
Xkb supports the key behaviors shown in Table 16.20.
Xkb supports the key behaviors shown in
<link linkend="table16.20">Table 16.20</link>.
</para>
<table frame='topbot'>
<table id='table16.20' frame='topbot'>
<title>Key Behaviors</title>
<?dbfo keep-together="always" ?>
<tgroup cols='2' align='left' colsep='0' rowsep='0'>
@ -4274,10 +4288,10 @@ The explicit components masks are held in the
<emphasis>explicit</emphasis>
field of the server map, which is an array indexed by keycode. Each entry in
this array is a mask that is a bitwise inclusive OR of the values shown in
Table 16.21.
<link linkend="table16.21">Table 16.21</link>.
</para>
<table frame='topbot'>
<table id='table16.21' frame='topbot'>
<title>Explicit Component Masks</title>
<?dbfo keep-together="always" ?>
<tgroup cols='3' align='left' colsep='0' rowsep='0'>

20
specs/XKB/ch17.xml
View file

@ -464,12 +464,13 @@ modifiers match the criteria specified by
<para>
<emphasis>match</emphasis>
must be one of the values shown in Table 17.1 and specifies how the real
must be one of the values shown in
<link linkend="table17.1">Table 17.1</link> and specifies how the real
modifiers specified in <emphasis>mods</emphasis>
are to be interpreted.
</para>
<table frame='topbot'>
<table id='table17.1' frame='topbot'>
<title>Symbol Interpretation Match Criteria</title>
<?dbfo keep-together="always" ?>
<tgroup cols='3' align='left' colsep='0' rowsep='0'>
@ -814,10 +815,11 @@ explicit override components of the server state.</para></note>
<emphasis>xkb</emphasis>.
Valid values for
<emphasis>which</emphasis>
are an inclusive OR of the values shown in Table 17.2.
are an inclusive OR of the values shown in
<link linkend="table17.2">Table 17.2</link>.
</para>
<table frame='topbot'>
<table id='table17.2' frame='topbot'>
<title>Compatibility Map Component Masks</title>
<?dbfo keep-together="always" ?>
<tgroup cols='3' align='left' colsep='0' rowsep='0'>
@ -1366,7 +1368,7 @@ Unless you have specifically modified this field, it is the default keyboard
device.
<emphasis>which</emphasis>
specifies the compatibility map components to be set, and is an inclusive OR
of the bits shown in Table 17.2.
of the bits shown in <link linkend="table17.2">Table 17.2</link>.
</para>
@ -1547,7 +1549,7 @@ To receive
<emphasis>bits_to_change</emphasis>
and
<emphasis>values_for_bits</emphasis>
using mask bits from Table 17.2.
using mask bits from <link linkend="table17.2">Table 17.2</link>.
</para>
@ -1692,7 +1694,8 @@ allocated. The compatibility map is the
<function>XkbGetCompatMap</function>,
in <link linkend="Getting_Compatibility_Map_Components_From_the_Server">section 17.2</link>).
<emphasis>which</emphasis>
is an inclusive OR of the bits shown in Table 17.2.
is an inclusive OR of the bits shown in
<link linkend="table17.2">Table 17.2</link>.
</para>
@ -1798,7 +1801,8 @@ To free an entire compatibility map or selected portions of one, use
<function>XkbGetCompatMap</function>,
in <link linkend="Getting_Compatibility_Map_Components_From_the_Server">section 17.2</link>).
<emphasis>which</emphasis>
is an inclusive OR of the bits shown in Table 17.2
is an inclusive OR of the bits shown in
<link linkend="table17.2">Table 17.2</link>
</para>

26
specs/XKB/ch18.xml
View file

@ -231,10 +231,10 @@ and
Xkb provides several functions that work with symbolic names. Each of these
functions uses a mask to specify individual fields of the structures described
above. These masks and their relationships to the fields in a keyboard
description are shown in Table 18.1.
description are shown in <link linkend="table18.1">Table 18.1</link>.
</para>
<table frame='topbot'>
<table id='table18.1' frame='topbot'>
<title>Symbolic Names Masks</title>
<?dbfo keep-together="always" ?>
<tgroup cols='4' align='left' colsep='0' rowsep='0'>
@ -421,7 +421,7 @@ X server. The
parameter specifies the name components to be updated in the
<emphasis>xkb</emphasis>
parameter, and is the bitwise inclusive OR of the valid names mask bits
defined in Table 18.1.
defined in <link linkend="table18.1">Table 18.1</link>.
</para>
@ -670,12 +670,14 @@ typedef struct _XkbNameChanges {
The
<emphasis>changed</emphasis>
field specifies the name components that have changed and is the bitwise
inclusive OR of the valid names mask bits defined in Table 18.1. The rest of
inclusive OR of the valid names mask bits defined in
<link linkend="table18.1">Table 18.1</link>. The rest of
the fields in the structure specify the ranges that have changed for the
various kinds of symbolic names, as shown in Table 18.2.
various kinds of symbolic names, as shown in
<link linkend="table18.2">Table 18.2</link>.
</para>
<table frame='topbot'>
<table id='table18.2' frame='topbot'>
<title>XkbNameChanges Fields</title>
<?dbfo keep-together="always" ?>
<tgroup cols='4' align='left' colsep='0' rowsep='0'>
@ -856,7 +858,8 @@ and set both the
<emphasis>bits_to_change </emphasis>
and
<emphasis>values_for_bits</emphasis>
detail parameter to a mask composed of a bitwise OR of masks in Table 18.1.
detail parameter to a mask composed of a bitwise OR of masks in
<link linkend="table18.1">Table 18.1</link>.
</para>
@ -904,7 +907,8 @@ that have changed */
The
<emphasis>changed</emphasis>
field specifies the name components that have changed and is the bitwise
inclusive OR of the valid names mask bits defined in Table 18.1. The other
inclusive OR of the valid names mask bits defined in
<link linkend="table18.1">Table 18.1</link>. The other
fields in this event are interpreted as the like-named fields in an
<emphasis>XkbNameChangesRec</emphasis> , as previously defined.
</para>
@ -969,7 +973,7 @@ When your application receives a X
The
<emphasis>wanted</emphasis>
parameter is the bitwise inclusive OR of the valid names mask bits shown in
Table 18.1.
<link linkend="table18.1">Table 18.1</link>.
<function>XkbNoteNameChanges</function>
copies any changes that are reported in
<emphasis>new</emphasis>
@ -1142,7 +1146,7 @@ from the X server. Instead use
The
<emphasis>which</emphasis>
parameter is the bitwise inclusive OR of the valid names mask bits defined in
Table 18.1.
<link linkend="table18.1">Table 18.1</link>.
</para>
@ -1207,7 +1211,7 @@ Use
The
<emphasis>which</emphasis>
parameter is the bitwise inclusive OR of the valid names mask bits defined in
Table 18.1.
<link linkend="table18.1">Table 18.1</link>.
</para>
</sect1>
</chapter>

5
specs/XKB/ch19.xml
View file

@ -203,10 +203,11 @@ and set both the
<emphasis>bits_to_change </emphasis>
and
<emphasis>values_for_bits</emphasis>
detail parameter to a mask composed of a bitwise OR of masks in Table 19.1.
detail parameter to a mask composed of a bitwise OR of masks in
<link linkend="table19.1">Table 19.1</link>.
</para>
<table frame='topbot'>
<table id='table19.1' frame='topbot'>
<title>XkbNewKeyboardNotifyEvent Details</title>
<?dbfo keep-together="always" ?>
<tgroup cols='3' align='left' colsep='0' rowsep='0'>

28
specs/XKB/ch20.xml
View file

@ -5,11 +5,11 @@
The X server maintains a database of keyboard components, identified by
component type. The database contains all the information necessary to build a
complete keyboard description for a particular device, as well as to assemble
partial descriptions. Table 20.1 identifies the component types and the type of
information they contain.
partial descriptions. <link linkend="table20.1">Table 20.1</link>
identifies the component types and the type of information they contain.
</para>
<table frame='topbot'>
<table id='table20.1' frame='topbot'>
<title>Server Database Keyboard Components</title>
<?dbfo keep-together="always" ?>
<tgroup cols='3' align='left' colsep='0' rowsep='0'>
@ -115,7 +115,8 @@ hand, this partial map can be used to configure
<para>
When a keyboard description is built, the components are processed in the order
in which they appear in Table 20.1; later definitions override earlier ones.
in which they appear in <link linkend="table20.1">Table 20.1</link>;
later definitions override earlier ones.
</para>
<sect1 id='Component_Names'>
@ -400,8 +401,10 @@ masks in the flags field of the
<function>XkbListComponents</function>.
The least significant byte of the flags field has the same meaning for all
types of keyboard components; the interpretation of the most significant byte
is dependent on the type of component. The flags bits are defined in Table
20.2. The symbols hints in Table 20.2 apply only to partial symbols components
is dependent on the type of component. The flags bits are defined in
<link linkend="table20.2">Table 20.2</link>.
The symbols hints in <link linkend="table20.2">Table 20.2</link>
apply only to partial symbols components
(those with
<emphasis>XkbLC_Partial</emphasis>
also set); full symbols components are assumed to specify all of the pieces.
@ -421,7 +424,7 @@ few modifier keys as well; such mappings should set only the
may be combined with any of the other flags).
</para>
<table frame='topbot'>
<table id='table20.2' frame='topbot'>
<title>XkbComponentNameRec Flags Bits</title>
<?dbfo keep-together="always" ?>
<tgroup cols='4' align='left' colsep='0' rowsep='0'>
@ -795,7 +798,8 @@ the server ORs the bits in
<emphasis>need</emphasis>
together and examines the result in relationship to the expressions in
<emphasis>names</emphasis>.
Table 20.3 identifies the components that are required for each of the
<link linkend="table20.3">Table 20.3</link>
identifies the components that are required for each of the
possible bits in
<emphasis>want</emphasis>
or
@ -826,7 +830,7 @@ and
<emphasis>compat</emphasis>.
</para>
<table frame='topbot'>
<table id='table20.3' frame='topbot'>
<title>Want and Need Mask Bits and Required Names Components</title>
<?dbfo keep-together="always" ?>
<tgroup cols='3' align='left' colsep='0' rowsep='0'>
@ -973,13 +977,13 @@ The information returned to the client in the
<emphasis>XkbDescRec</emphasis>
is essentially the result of a series of calls to extract information from a
fictitious device whose description matches the one just built. The calls
corresponding to each of the mask bits are summarized in Table 20.4, together
with the
corresponding to each of the mask bits are summarized in
<link linkend="table20.4">Table 20.4</link>, together with the
<emphasis>XkbDescRec</emphasis>
components that are filled in.
</para>
<table frame='topbot'>
<table id='table20.4' frame='topbot'>
<title>XkbDescRec Components Returned for Values of Want &amp; Needs</title>
<?dbfo keep-together="always" ?>
<tgroup cols='3' align='left' colsep='0' rowsep='0'>

18
specs/XKB/ch21.xml
View file

@ -216,14 +216,15 @@ the state of the core keyboard is used. The
and
<emphasis>unsupported</emphasis>
fields are masks where each bit indicates a capability. The meaning of the
mask bits is listed in Table 21.1, together with the fields in the
mask bits is listed in <link linkend="table21.1">Table 21.1</link>,
together with the fields in the
<emphasis>XkbDeviceInfoRec</emphasis>
structure that are associated with the capability represented by each bit. The
same bits are used to indicate the specific information desired in many of the
functions described subsequently in this section.
</para>
<table frame='topbot'>
<table id='table21.1' frame='topbot'>
<title>XkbDeviceInfoRec Mask Bits</title>
<?dbfo keep-together="always" ?>
<tgroup cols='4' align='left' colsep='0' rowsep='0'>
@ -457,7 +458,8 @@ The
<emphasis>which </emphasis>
parameter
is a mask specifying optional information to be returned. It is an inclusive OR
of one or more of the values from Table 21.1 and causes the returned
of one or more of the values from <link linkend="table21.1">Table 21.1</link>
and causes the returned
<emphasis>XkbDeviceInfoRec</emphasis>
to contain values for the corresponding fields specified in the table.
</para>
@ -486,7 +488,8 @@ Other fields are filled in as specified by
<para>
Upon return, the
<emphasis>supported</emphasis>
field will be set to the inclusive OR of zero or more bits from Table 21.1;
field will be set to the inclusive OR of zero or more bits from
<link linkend="table21.1">Table 21.1</link>;
each bit set indicates an optional Xkb extension device feature supported by
the server implementation, and a client may modify the associated behavior.
</para>
@ -1312,7 +1315,8 @@ the
<symbol>False</symbol>,
the value of which determines which subcomponents are freed.
<emphasis>which </emphasis>
is an inclusive OR of one or more of the values from Table 21.1. If which
is an inclusive OR of one or more of the values from
<link linkend="table21.1">Table 21.1</link>. If which
contains XkbXI_ButtonActionsMask, all button actions associated with
<emphasis>device_info</emphasis>
are freed,
@ -1474,7 +1478,7 @@ set in
<emphasis>which</emphasis>
and take their values from the relevant fields in
<emphasis>device_info</emphasis>
(see Table 21.1).
(see <link linkend="table21.1">Table 21.1</link>).
<function>XkbSetDeviceInfo</function>
returns
<symbol>True</symbol>
@ -1939,7 +1943,7 @@ To note device changes reported in an
The wanted field specifies the changes that should be noted in
<emphasis>old</emphasis>,
and is composed of the bitwise inclusive OR of one or more of the masks from
Table 21.1.
<link linkend="table21.1">Table 21.1</link>.
The
<emphasis>reason</emphasis>
field of the event in

5
specs/XKB/ch22.xml
View file

@ -179,10 +179,11 @@ Xkb modifies its behavior according to each controls bit.
<emphasis>mask</emphasis>
and
<emphasis>flags</emphasis>
are. The valid controls bits are defined in Table 22.1.
are. The valid controls bits are defined in
<link linkend="table22.1">Table 22.1</link>.
</para>
<table frame='topbot'>
<table id='table22.1' frame='topbot'>
<title>Debug Control Masks</title>
<?dbfo keep-together="always" ?>
<tgroup cols='3' align='left' colsep='0' rowsep='0'>