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

specs/XKB: fixup various formatting issues in <literallayout>s

Browse source 
Including translating some that are really just lists into
<simplelist> markup.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
This commit is contained in:
Alan Coopersmith 2014-07-18 23:56:29 -07:00
parent 94b5677478
commit 70c648ff85
6 changed files with 91 additions and 98 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
specs/XKB/ch05.xml
View file

@ -253,19 +253,15 @@ The
and
<symbol>KeyRelease</symbol>
events, the lookup modifiers are computed as:
</para>
<literallayout>
((base | latched | locked) &amp; ~<emphasis>server_internal_modifiers</emphasis>)
</literallayout>
<literallayout> ((base | latched | locked) &amp; ~<emphasis>server_internal_modifiers</emphasis>)</literallayout>
</para>
<para>
Otherwise the lookup modifiers are computed as:
</para>
<literallayout>
(((base | latched | (locked &amp; ~<emphasis>ignore_locks</emphasis>)) &amp; ~<emphasis>server_internal_modifiers</emphasis>)
</literallayout>
<literallayout> (((base | latched | (locked &amp; ~<emphasis>ignore_locks</emphasis>)) &amp; ~<emphasis>server_internal_modifiers</emphasis>)</literallayout>
</para>
<para>
The lookup group is the same as the effective group.
@ -303,11 +299,9 @@ The
<indexterm significance="preferred" zone="grab_state">
<primary>group</primary><secondary>grab</secondary></indexterm>
are represented in the state field of core X events; otherwise, the lookup state is used. The grab modifiers are computed as:
</para>
<literallayout>
(((base | latched | (locked &amp; ~ignore_locks)) &amp; ~server_internal_modifiers)
</literallayout>
<literallayout> (((base | latched | (locked &amp; ~ignore_locks)) &amp; ~server_internal_modifiers)</literallayout>
</para>
<para>
If the server’s

25
specs/XKB/ch07.xml
View file

@ -353,12 +353,11 @@ An unbound virtual modifier is one that is not bound to any real modifier
<para>
Some Xkb operations ignore modifier definitions in which the virtual modifiers
are unbound. Consider this example:
</para>
<literallayout>
if (state matches {Shift}) Do OneThing;
if (state matches {Shift+NumLock}) Do Another;
<literallayout> if (state matches {Shift}) Do OneThing;
if (state matches {Shift+NumLock}) Do Another;
</literallayout>
</para>
<para>
If the
@ -382,16 +381,16 @@ virtual modifiers are bound.
The Xkb extension does not require any specific virtual modifier names.
However, everyone benefits if the same names are used for common modifiers. The
following names are suggested:
</para>
<literallayout class='monospaced'>
<emphasis>NumLock</emphasis>
<emphasis>ScrollLock</emphasis>
<emphasis>Alt</emphasis>
<emphasis>Meta</emphasis>
<emphasis>AltGr</emphasis>
<emphasis>LevelThree</emphasis>
</literallayout>
<simplelist type='vert' columns='1'>
<member><emphasis>NumLock</emphasis></member>
<member><emphasis>ScrollLock</emphasis></member>
<member><emphasis>Alt</emphasis></member>
<member><emphasis>Meta</emphasis></member>
<member><emphasis>AltGr</emphasis></member>
<member><emphasis>LevelThree</emphasis></member>
</simplelist>
</para>
</sect1>
<sect1 id='Example'>

54
specs/XKB/ch15.xml
View file

@ -432,11 +432,11 @@ following:
</para>
<literallayout>
type "ONE_LEVEL" {
modifiers = None;
map[None]= Level1;
level_name[Level1]= "Any";
};
type "ONE_LEVEL" {
modifiers = None;
map[None]= Level1;
level_name[Level1]= "Any";
};
</literallayout>
<para>
@ -464,12 +464,12 @@ could look like the following:
</para>
<literallayout>
type "TWO_LEVEL" {
modifiers = Shift;
map[Shift]= Level2;
level_name[Level1]= "Base";
level_name[Level2]= "Shift";
};
type "TWO_LEVEL" {
modifiers = Shift;
map[Shift]= Level2;
level_name[Level1]= "Base";
level_name[Level2]= "Shift";
};
</literallayout>
<para>
@ -540,13 +540,13 @@ A symbolic representation of this key type could look like the following:
</para>
<literallayout>
type "ALPHABETIC" {
modifiers = Shift+Lock;
map[Shift]= Level2;
preserve[Lock]= Lock;
level_name[Level1]= "Base";
level_name[Level2]= "Caps";
};
type "ALPHABETIC" {
modifiers = Shift+Lock;
map[Shift]= Level2;
preserve[Lock]= Lock;
level_name[Level1]= "Base";
level_name[Level2]= "Caps";
};
</literallayout>
<para>
@ -613,15 +613,15 @@ A symbolic representation of this key type could look like the following:
</para>
<literallayout>
type "KEYPAD" {
modifiers = Shift+NumLock;
map[None]= Level1;
map[Shift]= Level2;
map[NumLock]= Level2;
map[Shift+NumLock]= Level1;
level_name[Level1]= "Base";
level_name[Level2]= "Caps";
};
type "KEYPAD" {
modifiers = Shift+NumLock;
map[None]= Level1;
map[Shift]= Level2;
map[NumLock]= Level2;
map[Shift+NumLock]= Level1;
level_name[Level1]= "Base";
level_name[Level2]= "Caps";
};
</literallayout>
<para>

50
specs/XKB/ch16.xml
View file

@ -2028,14 +2028,14 @@ release
<para>
The default behavior is to convert:
</para>
<literallayout>
{Set,Latch}Mods to: LockMods
{Set,Latch}Group to: LockGroup
SetPtrBtn to: LockPtrBtn
SetControls to: LockControls
</literallayout>
<simplelist type='vert' columns='1'>
<member>{Set,Latch}Mods to: LockMods</member>
<member>{Set,Latch}Group to: LockGroup</member>
<member>SetPtrBtn to: LockPtrBtn</member>
<member>SetControls to: LockControls</member>
</simplelist>
</para>
<para>
The
@ -3317,11 +3317,11 @@ provides the following convenience macros:
</varlistentry>
</variablelist>
<literallayout>
<para>
<function>XkbSARedirectVModsMask</function> returns the <structfield>vmods0</structfield>
and <structfield>vmods1</structfield> fields of <parameter>act</parameter>
converted to an unsigned int.
</literallayout>
</para>
<indexterm significance="preferred" zone="XkbSARedirectSetVMods"><primary><function>XkbSARedirectSetVMods</function></primary></indexterm>
<funcsynopsis id="XkbSARedirectSetVMods">
@ -3357,10 +3357,10 @@ provides the following convenience macros:
</listitem>
</varlistentry>
</variablelist>
<literallayout>
<para>
<function>XkbSARedirectSetVModsMask</function> sets the <structfield>vmods0</structfield>
and <structfield>vmods1</structfield> of <parameter>act</parameter> from <parameter>v</parameter>.
</literallayout>
</para>
</sect2>
<sect2 id='Actions_for_Generating_DeviceButtonPress_and_DeviceButtonRelease'>
@ -3682,12 +3682,12 @@ of
or
<structfield>v2_what</structfield>
:
</para>
<literallayout>
#define XkbSA_ValOpMask (0x70)
<programlisting>
#define XkbSA_ValOpMask (0x70)
#define XkbSA_ValScaleMask (0x07)
</literallayout>
</programlisting>
</para>
<para>
<structfield>v1_ndx</structfield>
@ -4513,16 +4513,16 @@ of the virtual modifier to the real modifier bits. Each entry in the
array is a bitwise inclusive OR of the legal modifier masks:
</para>
<literallayout>
<symbol>ShiftMask</symbol>
<symbol>LockMask</symbol>
<symbol>ControlMask</symbol>
<symbol>Mod1Mask</symbol>
<symbol>Mod2Mask</symbol>
<symbol>Mod3Mask</symbol>
<symbol>Mod4Mask</symbol>
<symbol>Mod5Mask</symbol>
</literallayout>
<simplelist type='vert' columns='1'>
<member><symbol>ShiftMask</symbol></member>
<member><symbol>LockMask</symbol></member>
<member><symbol>ControlMask</symbol></member>
<member><symbol>Mod1Mask</symbol></member>
<member><symbol>Mod2Mask</symbol></member>
<member><symbol>Mod3Mask</symbol></member>
<member><symbol>Mod4Mask</symbol></member>
<member><symbol>Mod5Mask</symbol></member>
</simplelist>
<para>
The

14
specs/XKB/ch17.xml
View file

@ -428,14 +428,14 @@ server when it starts. A client may add new ones using
Symbol interpretations result in key semantics being set. When a symbol
interpretation is applied, the following components of server key event
processing may be modified for the particular key involved:
</para>
<literallayout>
Virtual modifier map
Auto repeat
Key behavior (may be set to <symbol>XkbKB_Lock</symbol>)
Key action (see <link linkend="Key_Actions">section 16.1</link>)
</literallayout>
<simplelist type='vert' columns='1'>
<member>Virtual modifier map</member>
<member>Auto repeat</member>
<member>Key behavior (may be set to <symbol>XkbKB_Lock</symbol>)</member>
<member>Key action (see <link linkend="Key_Actions">section 16.1</link>)</member>
</simplelist>
</para>
<para>
The <structname>XkbSymInterpretRec</structname>

28
specs/XKB/glossary.xml
View file

@ -355,12 +355,12 @@ If a group index exceeds the maximum number of groups permitted for the
specified keyboard, it is wrapped or truncated back into range as specified by
the global <emphasis>GroupsWrap</emphasis> control.
<emphasis>GroupsWrap</emphasis> can have the following values:
<simplelist type='vert' columns='1'>
<member><emphasis>WrapIntoRange</emphasis></member>
<member><emphasis>ClampIntoRange</emphasis></member>
<member><emphasis>RedirectIntoRange</emphasis></member>
</simplelist>
</para>
<literallayout>
<emphasis>WrapIntoRange</emphasis>
<emphasis>ClampIntoRange</emphasis>
<emphasis>RedirectIntoRange</emphasis>
</literallayout>
</glossdef>
</glossentry>
@ -599,16 +599,16 @@ and
<glossdef>
<para>
A keyboard feedback includes the following:
<simplelist type='vert' columns='1'>
<member>Keyclick volume</member>
<member>Bell volume</member>
<member>Bell pitch</member>
<member>Bell duration</member>
<member>Global auto-repeat</member>
<member>Per key auto-repeat</member>
<member>32 LEDs</member>
</simplelist>
</para>
<literallayout>
Keyclick volume
Bell volume
Bell pitch
Bell duration
Global auto-repeat
Per key auto-repeat
32 LEDs
</literallayout>
</glossdef>
</glossentry>