Skip to content

Commit

Permalink
doc(keymap): Fix quotes
Browse files Browse the repository at this point in the history
Straight quotations marks `"` are typewriter legacy and should only be
used in programming.
  • Loading branch information
wismill committed Mar 17, 2024
1 parent 41bdd33 commit e5b0215
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions doc/keymap-format-text-v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -782,11 +782,11 @@ be processed (it does not refer to specific keys as specified in the

This section defines [key types], which, given a key and a keyboard
state (i.e. modifier state and group), determine the [shift level] to
be used in translating the key to [keysyms]. These types are assigned to
each group in each key, in the `xkb_symbols` section.
be used in translating the key to [keysyms]. These types are assigned
to each group in each key, in the `xkb_symbols` section.

Key types are called this way because, in a way, they really describe
the "type" of the key (or more correctly, a specific group of the
the type of the key (or more correctly, a specific group of the
key). For example, an ordinary keymap will provide a type called
`KEYPAD`, which consists of two levels, with the second level being
chosen according to the state of the Num Lock (or Shift) modifiers.
Expand Down Expand Up @@ -848,12 +848,12 @@ keysym(s) in the 4th level of the group will be returned to the user.
preserve[Shift+Lock+LevelThree] = Lock;

When a key type is used for keysym translation, its modifiers are said
to be "consumed". For example, in a simple US keymap, the "g" "g" key
to be consumed. For example, in a simple US keymap, the “g” key
is assigned an ordinary `ALPHABETIC` key type, whose modifiers are
Shift and Lock; then for the "g" key, these two modifiers are consumed
Shift and Lock; then for the “g” key, these two modifiers are consumed
by the translation. This information is relevant for applications
which further process the modifiers, since by then the consumed
modifiers have already "done their part" and should be masked out.
modifiers have already done their part and should be masked out.

However, sometimes even if a modifier had already affected the key
translation through the type, it should *not* be reported as consumed,
Expand All @@ -862,7 +862,7 @@ used to augment the map entry. The modifiers inside the square
brackets should match one of the map[] statements in the type (if
there is no matching map entry, one mapping to Level1 is implicitly
added). The right hand side should consists of modifiers from the
type's modifiers; these modifiers are then "preserved" and not
type's modifiers; these modifiers are then preserved and not
reported as consumed.


Expand Down Expand Up @@ -941,7 +941,7 @@ most specific one is used:
- If both the keysyms and the matching operations are the same (but the
modifiers are different), the first interpret is used.

As described above, once an interpret "attaches" to a level, it can bind
As described above, once an interpret attaches to a level, it can bind
an action to that level, add one virtual modifier to the key's vmodmap,
or set the key's repeat setting. You should note the following:

Expand Down Expand Up @@ -1001,7 +1001,7 @@ Statements of the form:
indicator "Shift Lock" { ... }

This statement specifies the behavior and binding of the LED (AKA
[indicator]) with the given name ("Shift Lock" above). The name should
[indicator]) with the given name (Shift Lock above). The name should
have been declared previously in the `xkb_keycodes` section (see
[LED name][indicator name] statement), and given an index there.
If it wasn't, it is created with the next free index.
Expand Down Expand Up @@ -1122,7 +1122,7 @@ Statements of the form:
name[Group1] = "US/ASCII";
groupName[1] = "US/ASCII";

Gives the name "US/ASCII" to the first group of symbols. Other groups can be
Gives the name US/ASCII to the first group of symbols. Other groups can be
named using a different group index (ex: `Group2`), and with a different name.
A group must be named.

Expand Down

0 comments on commit e5b0215

Please sign in to comment.