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

specs/XKB: Turn Chapter references into xref links

Browse source 
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
This commit is contained in:
Alan Coopersmith 2014-07-06 21:17:18 -07:00
parent b7f00ce5bc
commit 53e931d799
12 changed files with 35 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
specs/XKB/ch06.xml
View file

@ -90,31 +90,31 @@ components of the
<tbody>
<row>
<entry>ctrls</entry>
<entry>Chapter 10</entry>
<entry><xref linkend="Keyboard_Controls" /></entry>
</row>
<row>
<entry>server</entry>
<entry>Chapter 16</entry>
<entry><xref linkend="Xkb_Server_Keyboard_Mapping" /></entry>
</row>
<row>
<entry>map</entry>
<entry>Chapter 15</entry>
<entry><xref linkend="Xkb_Client_Keyboard_Mapping" /></entry>
</row>
<row>
<entry>indicators</entry>
<entry>Chapter 8</entry>
<entry><xref linkend="Indicators" /></entry>
</row>
<row>
<entry>names</entry>
<entry>Chapter 18</entry>
<entry><xref linkend="Symbolic_Names" /></entry>
</row>
<row>
<entry>compat</entry>
<entry>Chapter 17</entry>
<entry><xref linkend="The_Xkb_Compatibility_Map" /></entry>
</row>
<row>
<entry>geom</entry>
<entry>Chapter 13</entry>
<entry><xref linkend="Keyboard_Geometry" /></entry>
</row>
</tbody>
</tgroup>

2
specs/XKB/ch07.xml
View file

@ -94,7 +94,7 @@ using
<emphasis>xkb</emphasis>
argument; to retrieve indicator names, use
<function>XkbGetNames</function>.
These functions are discussed in Chapter 18.
These functions are discussed in <xref linkend="Symbolic_Names" />.
</para>

16
specs/XKB/ch08.xml
View file

@ -51,13 +51,13 @@ doesn’t use these symbolic names for anything; they are there only to help
make the keyboard description comprehensible to humans. To set the names of
specific indicators, use
<function>XkbSetNames</function>
as discussed in Chapter 18. Then set the map using
as discussed in <xref linkend="Symbolic_Names" />. Then set the map using
<function>XkbSetMap</function>
(see section 14.3) or
<function>XkbSetNamedIndicator</function>
(below). To retrieve indicator names, use
<function>XkbGetNames</function>
(Chapter 18). <!-- xref -->
(<xref linkend="Symbolic_Names" />). <!-- xref -->
</para>
@ -80,7 +80,7 @@ to inquire about and control most indicator properties and behaviors.
<para>
The description for all the Xkb indicators is held in the
<emphasis>indicators</emphasis>
field of the complete keyboard description (see Chapter 6), which is defined <!-- xref -->
field of the complete keyboard description (see <xref linkend="Complete_Keyboard_Description" />), which is defined <!-- xref -->
as follows:
</para>
@ -572,8 +572,8 @@ Remember that the
<emphasis>mask</emphasis>
field is comprised of all of the real modifiers specified in the definition
plus any real modifiers that are bound to the virtual modifiers specified in
the definition. (See Chapter 5 for more information on the keyboard state and <!-- xref -->
Chapter 7 for more information on virtual modifiers.) Use a bitwise inclusive
the definition. (See <xref linkend="Keyboard_State" /> for more information on the keyboard state and <!-- xref -->
<xref linkend="Virtual_Modifiers" /> for more information on virtual modifiers.) Use a bitwise inclusive
OR of the following values to compose a value for
<emphasis>which_mods</emphasis>:
</para>
@ -792,7 +792,7 @@ Any modifiers specified in the
<para>
The
<emphasis>ctrls</emphasis>
field specifies what controls (see Chapter 10) the indicator watches and is
field specifies what controls (see <xref linkend="Keyboard_Controls" />) the indicator watches and is
composed using the bitwise inclusive OR of the following values:
</para> <!-- xref -->
@ -1023,7 +1023,7 @@ To free the indicator maps, use
<para>
Xkb also allows applications to refer to indicators by name. Use
<function>XkbGetNames</function>
to get the indicator names (see Chapter 18). Using names eliminates the need
to get the indicator names (see <xref linkend="Symbolic_Names" />). Using names eliminates the need
for hard-coding bitmask values for particular keyboards. For example, instead
of using vendor-specific constants such as
<emphasis>WSKBLed_ScrollLock</emphasis>
@ -2013,7 +2013,7 @@ If the
Most applications do not need to directly allocate the
<emphasis>indicators</emphasis>
member of the keyboard description record (the keyboard description record is
described in Chapter 6). If the need arises, however, use
described in <xref linkend="Complete_Keyboard_Description" />). If the need arises, however, use
<function>XkbAllocIndicatorMaps</function>.
</para>

2
specs/XKB/ch09.xml
View file

@ -55,7 +55,7 @@ listed.
<para>
You can disable audible bells on a global basis (to set the
<emphasis>AudibleBell</emphasis>
control, see Chapter 10). For example, a client that replaces the keyboard
control, see <xref linkend="Keyboard_Controls" />). For example, a client that replaces the keyboard
bell with some other audible cue might want to turn off the
<emphasis>AudibleBell</emphasis>
control to prevent the server from also generating a sound and avoid

6
specs/XKB/ch10.xml
View file

@ -5,7 +5,7 @@
The Xkb extension is composed of two parts: a server extension, and a
client-side X library extension. This chapter discusses functions used to
modify controls effecting the behavior of the server portion of the Xkb
extension. Chapter 11 discusses functions used to modify controls that affect
extension. <xref linkend="X_Library_Controls" /> discusses functions used to modify controls that affect
only the behavior of the client portion of the extension; those controls are
known as Library Controls.
</para>
@ -599,7 +599,7 @@ bits are valid in the returned values, not just the ones selected in the
<para>
The X server’s generation of sounds is controlled by the
<emphasis>AudibleBell</emphasis>
control. Configuration of different bell sounds is discussed in Chapter 9.
control. Configuration of different bell sounds is discussed in <xref linkend="Bells" />.
</para>
@ -1181,7 +1181,7 @@ and disable them using either the
<emphasis>AutoReset</emphasis>
control discussed in section 10.1.1. The individual keys that simulate <!-- xref -->
different aspects of the pointer device are determined by the keyboard mapping,
discussed in Chapter 16. <!-- xref -->
discussed in <xref linkend="Xkb_Server_Keyboard_Mapping" />. <!-- xref -->
</para>

4
specs/XKB/ch11.xml
View file

@ -3,7 +3,7 @@
<para>
The Xkb extension is composed of two parts: a server extension, and a
client-side X library extension. Chapter 10 discusses functions used to modify
client-side X library extension. <xref linkend="Keyboard_Controls" /> discusses functions used to modify
controls affecting the behavior of the server portion of the Xkb extension.
This chapter discusses functions used to modify controls that affect only the
behavior of the client portion of the extension; these controls are known as
@ -159,7 +159,7 @@ keysym. This behavior mirrors the behavior of
The
<emphasis>ConsumeLookupMods</emphasis>
control is unset by default. For more information on modifier consumption,
refer to Chapter 12.
refer to <xref linkend="Interpreting_Key_Events" />.
</para>

4
specs/XKB/ch13.xml
View file

@ -128,7 +128,7 @@ a top label.
<para>
The top-level keyboard geometry description includes a list of
<emphasis>key aliases</emphasis>
(see Chapter 18). Key aliases allow the keyboard layout designer to assign
(see <xref linkend="Symbolic_Names" />). Key aliases allow the keyboard layout designer to assign
multiple key names to a single key.
</para>
<note><para>Key aliases defined in the geometry component of a keyboard mapping
@ -1132,7 +1132,7 @@ To load a keyboard geometry if you already have the keyboard description, use
<para>
It is also possible to load a keyboard geometry by name. The X server maintains
a database of keyboard components (see Chapter 20). To load a keyboard geometry
a database of keyboard components (see <xref linkend="Server_Database_of_Keyboard_Components" />). To load a keyboard geometry
description from this database by name, use
<function>XkbGetNamedGeometry</function>.
</para>

6
specs/XKB/ch14.xml
View file

@ -25,8 +25,8 @@ the virtual modifiers and the per-key virtual modifier mapping.
<para>
For detailed information on particular components of the keyboard map, refer to
Chapter 15, "Xkb Client Keyboard Mapping" and Chapter 16, "Xkb Server Keyboard
Mapping."
<xref linkend="Xkb_Client_Keyboard_Mapping" />, and
<xref linkend="Xkb_Server_Keyboard_Mapping" />.
</para>
<sect1 id='Notation_and_Terminology'>
@ -170,7 +170,7 @@ group. Most keys will only have a few shift levels.
</para></footnote>. In
addition, Xkb provides precise specifications regarding the behavior of keys.
In Xkb, modifier state and the current group are independent (with the
exception of compatibility mapping, discussed in Chapter 17).
exception of compatibility mapping, discussed in <xref linkend="The_Xkb_Compatibility_Map" />).
</para>

4
specs/XKB/ch15.xml
View file

@ -1439,7 +1439,7 @@ out-of-range groups, use
<para>
The keyboard controls (see Chapter 10) contain a
The keyboard controls (see <xref linkend="Keyboard_Controls" />) contain a
<emphasis>groups_wrap</emphasis>
field specifying the handling of illegal groups on a global basis. That is,
when the user performs an action causing the effective group to go out of the
@ -2537,7 +2537,7 @@ If a bit is set in a
Pressing or releasing the key bound to a modifier changes the modifier set and
unset state. The particular manner in which the modifier set and unset state
changes is determined by the behavior and actions assigned to the key (see
Chapter 16).
<xref linkend="Xkb_Server_Keyboard_Mapping" />).
</para>

8
specs/XKB/ch16.xml
View file

@ -622,7 +622,7 @@ have an associated data structure.
Actions associated with the
<emphasis>XkbModAction</emphasis>
structure change the state of the modifiers when keys are pressed and released
(see Chapter 7 for a discussion of modifiers):
(see <xref linkend="Virtual_Modifiers" /> for a discussion of modifiers):
</para>
<para><programlisting>
@ -995,7 +995,7 @@ type XkbAction, these macros may be used only with Actions of type
Actions associated with the
<emphasis>XkbGroupAction</emphasis>
structure change the current group state when keys are pressed and released
(see Chapter 5 for a description of groups and keyboard state):
(see <xref linkend="Keyboard_State" /> for a description of groups and keyboard state):
</para>
<para><programlisting>
@ -3179,7 +3179,7 @@ The
<emphasis>vmods_mask1</emphasis>
fields actually represent one
<emphasis>vmods_mask</emphasis>
value, as described in Chapter 7. Xkb provides the following macros, to
value, as described in <xref linkend="Virtual_Modifiers" />. Xkb provides the following macros, to
convert between the two formats:
</para>
@ -3274,7 +3274,7 @@ Similarly, the
<emphasis>vmods1</emphasis>
fields actually represent one
<emphasis>vmods </emphasis>
value, as described in Chapter 7. To convert between the two formats, Xkb
value, as described in <xref linkend="Virtual_Modifiers" />. To convert between the two formats, Xkb
provides the following convenience macros:
</para>

2
specs/XKB/ch18.xml
View file

@ -192,7 +192,7 @@ name LEFT as an alias for A31 in the
</para>
<note><para>Key aliases defined in the geometry component of a keyboard mapping
(see Chapter 13) override those defined in the keycodes component of the server
(see <xref linkend="Keyboard_Geometry" />) override those defined in the keycodes component of the server
database, which are stored in the
<emphasis>XkbNamesRec</emphasis>
(

2
specs/XKB/ch20.xml
View file

@ -947,7 +947,7 @@ The
<emphasis>names</emphasis>
structure in an
<emphasis>XkbDescRec</emphasis>
keyboard description record (see Chapter 18) contains one field for each of
keyboard description record (see <xref linkend="Symbolic_Names" />) contains one field for each of
the five component types used to build a keyboard description. When a keyboard
description is built from a set of database components, the corresponding
fields in this