From ed60df10aad15057577d5714c955d22d2a446e51 Mon Sep 17 00:00:00 2001 From: Alan Coopersmith Date: Thu, 10 Jul 2014 15:45:57 -0700 Subject: [PATCH] specs/XKB: Markup keyboard keys as instead of Also uses for LED names/labels, for lack of a better fit in DocBook. Signed-off-by: Alan Coopersmith --- specs/XKB/ch08.xml | 23 ++++++++------- specs/XKB/ch10.xml | 70 ++++++++++++++++++++++++---------------------- specs/XKB/ch11.xml | 6 ++-- specs/XKB/ch15.xml | 4 +-- specs/XKB/ch16.xml | 2 +- specs/XKB/ch18.xml | 2 +- 6 files changed, 54 insertions(+), 53 deletions(-) diff --git a/specs/XKB/ch08.xml b/specs/XKB/ch08.xml index 9bd89b12..dbd5822f 100644 --- a/specs/XKB/ch08.xml +++ b/specs/XKB/ch08.xml @@ -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 -CapsLock +CapsLock LED, but X does not provide a mechanism to make the LED automatically follow the logical state of the -CapsLock +CapsLock key. @@ -23,9 +23,9 @@ ability to determine what bits in the method for a client to determine what bit to set in the led_mask field to turn on the -Scroll Lock +Scroll Lock LED or whether the keyboard even has a -Scroll Lock +Scroll Lock LED. @@ -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 -CapsLock, +CapsLock, but most keyboards do not have an LED that indicates the current group. Because phys_indicators @@ -269,25 +269,24 @@ attempt to explicitly change the value of an indicator for which For example, a keyboard designer may want to make the -CapsLock +CapsLock LED controllable only by the server, but allow the -Scroll Lock +Scroll Lock LED to be controlled by client applications. To do so, the keyboard designer could set the XkbIM_NoExplicit flag for the -CapsLock - +CapsLock LED, but not set it for the -Scroll Lock +Scroll Lock LED. Or the keyboard designer may wish to allow the -CapsLock +CapsLock LED to be controlled by both the server and client applications and also have the server to automatically change the CapsLock modifier state whenever a client application changes the -CapsLock +CapsLock LED. To do so, the keyboard designer would not set the XkbIM_NoExplicit flag, but would instead set the diff --git a/specs/XKB/ch10.xml b/specs/XKB/ch10.xml index 5604048c..c4af77f6 100644 --- a/specs/XKB/ch10.xml +++ b/specs/XKB/ch10.xml @@ -1224,7 +1224,7 @@ or setting the attribute; instead use produce an XK_Pointer_EnableKeys keysym. The de facto default standard for this is -Shift+Alt+NumLock, +ShiftAltNumLock, but this may vary depending on the keymap. @@ -1521,7 +1521,8 @@ entering the following standard key sequences: -Holding down a shift key by itself for eight seconds toggles the +Holding down a Shift key by itself for eight seconds +toggles the SlowKeys control. @@ -1529,7 +1530,7 @@ Holding down a shift key by itself for eight seconds toggles the Pressing and releasing the left or right -Shift +Shift 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 StickyKeys @@ -2596,9 +2597,9 @@ in the server, 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 -Shift +Shift and -1 +1 keys at the same time. The StickyKeys 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 -Shift +Shift key, release it, and then press the -1 +1 key. @@ -2628,35 +2629,36 @@ it one more time. 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 -Shift -+ -Control -+ -Z + +Shift +Control +Z + the user could press and release the -Shift +Shift key to latch it, then press and release the -Control - key to latch it, and finally press and release the Z key. Because the -Control +Control + key to latch it, and finally press and release the +Z key. Because the +Control key is a modifier key, pressing it does not unlatch the -Shift +Shift key. Thus, after the user presses the -Control +Control key, both the Shift and Control modifiers are latched. When the user presses the -Z +Z key, the effect is as though the user had pressed -Shift -+ -Control -+ -Z. + +Shift +Control +Z +. In addition, because the -Z +Z key is not a modifier key, the Shift 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 -Shift +Shift key twice to lock the Shift modifier. Then, when the user presses the -9, -‘, -x, -k, -b, -‘, +9, +', +x, +k, +b, +', and -0 +0 keys in sequence, it generates ("XKB"). To unlock the Shift modifier, the user can press and release the -Shift +Shift key. diff --git a/specs/XKB/ch11.xml b/specs/XKB/ch11.xml index 2277924b..3042aeb4 100644 --- a/specs/XKB/ch11.xml +++ b/specs/XKB/ch11.xml @@ -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 ConsumeLookupMods control is enabled. If a user presses the -Shift +Shift key and the -A +A key while the -Num_Lock +Num_Lock key is locked, XLookupString uses the diff --git a/specs/XKB/ch15.xml b/specs/XKB/ch15.xml index f864d300..f798173c 100644 --- a/specs/XKB/ch15.xml +++ b/specs/XKB/ch15.xml @@ -1454,14 +1454,14 @@ key. The per-key group_info 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 -Enter +Enter key usually has just one group defined. If the user performs an action causing the global keyboard group to change to Group2, the group_info field for the -Enter +Enter key describes how to handle this situation. diff --git a/specs/XKB/ch16.xml b/specs/XKB/ch16.xml index bcd76ff9..fd12a62e 100644 --- a/specs/XKB/ch16.xml +++ b/specs/XKB/ch16.xml @@ -3957,7 +3957,7 @@ a key. Key behavior refers to the demeanor of a key. For example, the expected behavior of the -CapsLock +CapsLock key is that it logically locks when pressed, and then logically unlocks when pressed again. diff --git a/specs/XKB/ch18.xml b/specs/XKB/ch18.xml index 57cb0d85..3c927b69 100644 --- a/specs/XKB/ch18.xml +++ b/specs/XKB/ch18.xml @@ -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 -F1 +F1 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.