mirror of
https://gitlab.freedesktop.org/xorg/lib/libx11.git
synced 2026-05-07 20:18:03 +02:00
specs/XKB: Markup keyboard keys as <keycap> instead of <emphasis>
Also uses <guilabel> for LED names/labels, for lack of a better fit in DocBook. Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
This commit is contained in:
parent
f57b91ee49
commit
ed60df10aa
6 changed files with 54 additions and 53 deletions
|
|
@ -5,10 +5,10 @@
|
|||
Although the core X implementation supports up to 32 LEDs on an input device,
|
||||
it does not provide any linkage between the state of the LEDs and the logical
|
||||
state of the input device. For example, most keyboards have a
|
||||
<emphasis>CapsLock</emphasis>
|
||||
<guilabel>CapsLock</guilabel>
|
||||
LED, but X does not provide a mechanism to make the LED automatically follow
|
||||
the logical state of the
|
||||
<emphasis>CapsLock</emphasis>
|
||||
<keycap>CapsLock</keycap>
|
||||
key.
|
||||
</para>
|
||||
|
||||
|
|
@ -23,9 +23,9 @@ ability to determine what bits in the
|
|||
method for a client to determine what bit to set in the
|
||||
<emphasis>led_mask</emphasis>
|
||||
field to turn on the
|
||||
<emphasis>Scroll Lock</emphasis>
|
||||
<guilabel>Scroll Lock</guilabel>
|
||||
LED or whether the keyboard even has a
|
||||
<emphasis>Scroll Lock</emphasis>
|
||||
<guilabel>Scroll Lock</guilabel>
|
||||
LED.
|
||||
</para>
|
||||
|
||||
|
|
@ -114,7 +114,7 @@ then the associated indicator has a physical LED associated with it. This
|
|||
field is necessary because some indicators may not have corresponding physical
|
||||
LEDs on the keyboard. For example, most keyboards have an LED for indicating
|
||||
the state of
|
||||
<emphasis>CapsLock</emphasis>,
|
||||
<keycap>CapsLock</keycap>,
|
||||
but most keyboards do not have an LED that indicates the current group.
|
||||
Because
|
||||
<structfield>phys_indicators</structfield>
|
||||
|
|
@ -269,25 +269,24 @@ attempt to explicitly change the value of an indicator for which
|
|||
|
||||
<para>
|
||||
For example, a keyboard designer may want to make the
|
||||
<emphasis>CapsLock</emphasis>
|
||||
<guilabel>CapsLock</guilabel>
|
||||
LED controllable only by the server, but allow the
|
||||
<emphasis>Scroll Lock</emphasis>
|
||||
<guilabel>Scroll Lock</guilabel>
|
||||
LED to be controlled by client applications. To do so, the keyboard designer
|
||||
could set the
|
||||
<symbol>XkbIM_NoExplicit</symbol>
|
||||
flag for the
|
||||
<emphasis>CapsLock</emphasis>
|
||||
|
||||
<guilabel>CapsLock</guilabel>
|
||||
LED, but not set it for the
|
||||
<emphasis>Scroll Lock</emphasis>
|
||||
<guilabel>Scroll Lock</guilabel>
|
||||
LED. Or the keyboard designer may wish to allow the
|
||||
<emphasis>CapsLock</emphasis>
|
||||
<guilabel>CapsLock</guilabel>
|
||||
LED to be controlled by both the server and client applications and also have
|
||||
the server to automatically change the
|
||||
<emphasis>CapsLock</emphasis>
|
||||
|
||||
modifier state whenever a client application changes the
|
||||
<emphasis>CapsLock</emphasis>
|
||||
<guilabel>CapsLock</guilabel>
|
||||
LED. To do so, the keyboard designer would not set the
|
||||
<symbol>XkbIM_NoExplicit</symbol>
|
||||
flag, but would instead set the
|
||||
|
|
|
|||
|
|
@ -1224,7 +1224,7 @@ or setting the attribute; instead use
|
|||
produce an
|
||||
<keysym>XK_Pointer_EnableKeys</keysym>
|
||||
keysym. The de facto default standard for this is
|
||||
<emphasis>Shift+Alt+NumLock</emphasis>,
|
||||
<keycombo><keycap>Shift</keycap><keycap>Alt</keycap><keycap>NumLock</keycap></keycombo>,
|
||||
but this may vary depending on the keymap.</para></note>
|
||||
|
||||
</sect2>
|
||||
|
|
@ -1521,7 +1521,8 @@ entering the following standard key sequences:
|
|||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
Holding down a shift key by itself for eight seconds toggles the
|
||||
Holding down a <keycap>Shift</keycap> key by itself for eight seconds
|
||||
toggles the
|
||||
<emphasis>SlowKeys</emphasis>
|
||||
control.
|
||||
</para>
|
||||
|
|
@ -1529,7 +1530,7 @@ Holding down a shift key by itself for eight seconds toggles the
|
|||
<listitem>
|
||||
<para>
|
||||
Pressing and releasing the left or right
|
||||
<symbol>Shift</symbol>
|
||||
<keycap>Shift</keycap>
|
||||
key five times in a row, without any intervening key events and with less than
|
||||
30 seconds delay between consecutive presses, toggles the state of the
|
||||
<emphasis>StickyKeys</emphasis>
|
||||
|
|
@ -2596,9 +2597,9 @@ in the server,
|
|||
<para>
|
||||
Some people find it difficult or even impossible to press two keys at once. For
|
||||
example, a one-fingered typist or someone using a mouth stick cannot press the
|
||||
<symbol>Shift</symbol>
|
||||
<keycap>Shift</keycap>
|
||||
and
|
||||
<emphasis>1</emphasis>
|
||||
<keycap>1</keycap>
|
||||
keys at the same time. The
|
||||
<emphasis>StickyKeys</emphasis>
|
||||
control solves this problem by changing the behavior of the modifier keys.
|
||||
|
|
@ -2607,9 +2608,9 @@ With
|
|||
the user can first press a modifier, release it, then press another key. For
|
||||
example, to get an exclamation point on a PC-style keyboard, the user can press
|
||||
the
|
||||
<symbol>Shift</symbol>
|
||||
<keycap>Shift</keycap>
|
||||
key, release it, and then press the
|
||||
<emphasis>1</emphasis>
|
||||
<keycap>1</keycap>
|
||||
key.
|
||||
</para>
|
||||
|
||||
|
|
@ -2628,35 +2629,36 @@ it one more time.
|
|||
<para>
|
||||
When a modifier is latched, it becomes unlatched when the user presses a
|
||||
nonmodifier key or a pointer button. For instance, to enter the sequence
|
||||
<symbol>Shift</symbol>
|
||||
+
|
||||
<symbol>Control</symbol>
|
||||
+
|
||||
<emphasis>Z</emphasis>
|
||||
<keycombo>
|
||||
<keycap>Shift</keycap>
|
||||
<keycap>Control</keycap>
|
||||
<keycap>Z</keycap>
|
||||
</keycombo>
|
||||
the user could press and release the
|
||||
<symbol>Shift</symbol>
|
||||
<keycap>Shift</keycap>
|
||||
key to latch it, then press and release the
|
||||
<symbol>Control</symbol>
|
||||
key to latch it, and finally press and release the Z key. Because the
|
||||
<symbol>Control</symbol>
|
||||
<keycap>Control</keycap>
|
||||
key to latch it, and finally press and release the
|
||||
<keycap>Z</keycap> key. Because the
|
||||
<keycap>Control</keycap>
|
||||
key is a modifier key, pressing it does not unlatch the
|
||||
<symbol>Shift</symbol>
|
||||
<keycap>Shift</keycap>
|
||||
key. Thus, after the user presses the
|
||||
<symbol>Control</symbol>
|
||||
<keycap>Control</keycap>
|
||||
key, both the
|
||||
<symbol>Shift</symbol>
|
||||
and
|
||||
<symbol>Control</symbol>
|
||||
modifiers are latched. When the user presses the
|
||||
<emphasis>Z</emphasis>
|
||||
<keycap>Z</keycap>
|
||||
key, the effect is as though the user had pressed
|
||||
<symbol>Shift</symbol>
|
||||
+
|
||||
<symbol>Control</symbol>
|
||||
+
|
||||
<emphasis>Z</emphasis>.
|
||||
<keycombo>
|
||||
<keycap>Shift</keycap>
|
||||
<keycap>Control</keycap>
|
||||
<keycap>Z</keycap>
|
||||
</keycombo>.
|
||||
In addition, because the
|
||||
<emphasis>Z</emphasis>
|
||||
<keycap>Z</keycap>
|
||||
key is not a modifier key, the
|
||||
<symbol>Shift</symbol>
|
||||
and
|
||||
|
|
@ -2671,22 +2673,22 @@ button the user presses until the user unlocks it or it is unlocked
|
|||
programmatically. For example, to enter the sequence ("XKB") on a keyboard
|
||||
where ‘(’ is a shifted ‘9’, ‘)’ is a shifted ‘0’, and ‘"’
|
||||
is a shifted single quote, the user could press and release the
|
||||
<symbol>Shift</symbol>
|
||||
<keycap>Shift</keycap>
|
||||
key twice to lock the
|
||||
<symbol>Shift</symbol>
|
||||
modifier. Then, when the user presses the
|
||||
<emphasis>9</emphasis>,
|
||||
<emphasis>‘</emphasis>,
|
||||
<structfield>x</structfield>,
|
||||
<emphasis>k</emphasis>,
|
||||
<emphasis>b</emphasis>,
|
||||
<emphasis>‘</emphasis>,
|
||||
<keycap>9</keycap>,
|
||||
<keycap>'</keycap>,
|
||||
<keycap>x</keycap>,
|
||||
<keycap>k</keycap>,
|
||||
<keycap>b</keycap>,
|
||||
<keycap>'</keycap>,
|
||||
and
|
||||
<emphasis>0</emphasis>
|
||||
<keycap>0</keycap>
|
||||
keys in sequence, it generates ("XKB"). To unlock the
|
||||
<symbol>Shift</symbol>
|
||||
modifier, the user can press and release the
|
||||
<symbol>Shift</symbol>
|
||||
<keycap>Shift</keycap>
|
||||
key.
|
||||
</para>
|
||||
|
||||
|
|
|
|||
|
|
@ -127,11 +127,11 @@ keysym when it is determining the string associated with a keysym. For example,
|
|||
assume the keymap for the ‘A’ key only contains the shift modifier and the
|
||||
<emphasis>ConsumeLookupMods</emphasis>
|
||||
control is enabled. If a user presses the
|
||||
<symbol>Shift</symbol>
|
||||
<keycap>Shift</keycap>
|
||||
key and the
|
||||
<emphasis>A</emphasis>
|
||||
<keycap>A</keycap>
|
||||
key while the
|
||||
<keysym>Num_Lock</keysym>
|
||||
<keycap>Num_Lock</keycap>
|
||||
key is locked,
|
||||
<function>XLookupString</function>
|
||||
uses the
|
||||
|
|
|
|||
|
|
@ -1454,14 +1454,14 @@ key. The per-key
|
|||
<structfield>group_info</structfield>
|
||||
field specifies how a key treats a legal effective group if the key does not
|
||||
have a type specified for the group of concern. For example, the
|
||||
<emphasis>Enter</emphasis>
|
||||
<keycap>Enter</keycap>
|
||||
key usually has just one group defined. If the user performs an action causing
|
||||
the global keyboard group to change to
|
||||
<emphasis>Group2</emphasis>,
|
||||
the
|
||||
<structfield>group_info</structfield>
|
||||
field for the
|
||||
<emphasis>Enter</emphasis>
|
||||
<keycap>Enter</keycap>
|
||||
key describes how to handle this situation.
|
||||
</para>
|
||||
|
||||
|
|
|
|||
|
|
@ -3957,7 +3957,7 @@ a key.</para></note>
|
|||
<para>
|
||||
Key behavior refers to the demeanor of a key. For example, the expected
|
||||
behavior of the
|
||||
<emphasis>CapsLock</emphasis>
|
||||
<keycap>CapsLock</keycap>
|
||||
key is that it logically locks when pressed, and then logically unlocks when
|
||||
pressed again.
|
||||
</para>
|
||||
|
|
|
|||
|
|
@ -160,7 +160,7 @@ in the
|
|||
reports the number of entries that are in the keys array. For each key, the
|
||||
key name links keys with similar functions or in similar positions on keyboards
|
||||
that report different keycodes. For example, the
|
||||
<emphasis>F1</emphasis>
|
||||
<keycap>F1</keycap>
|
||||
key may emit keycode 23 on one keyboard and keycode 86 on another. By naming
|
||||
this key "FK01" on both keyboards, the keyboard layout designer can reuse parts
|
||||
of keyboard descriptions for different keyboards.
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue