From a08007dcfaebff352947e9528aa981d8784d8e7d Mon Sep 17 00:00:00 2001 From: "Steven R. Loomis" Date: Fri, 9 Feb 2024 11:30:00 -0600 Subject: [PATCH] CLDR-17177 kbd: updates per review comments --- docs/ldml/tr35-keyboards.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/ldml/tr35-keyboards.md b/docs/ldml/tr35-keyboards.md index 626dd8d9aab..0a45bb4635e 100644 --- a/docs/ldml/tr35-keyboards.md +++ b/docs/ldml/tr35-keyboards.md @@ -734,9 +734,9 @@ _Attribute:_ `layerId="shift"` (optional) _Attribute:_ `output` -> The `output` attribute contains the sequence of characters that is emitted when pressing this particular key. Control characters, whitespace (other than the regular space character) and combining marks in this attribute are escaped using the `\u{…}` notation. More than one key may output the same output. +> The `output` attribute contains the sequence of characters that is emitted when pressing this particular key. Control characters, whitespace (other than the regular space character) and combining marks in this attribute are escaped using the `\u{…usv}` notation. More than one key may output the same output. > -> The `output` attribute may also contain the `\m{…}` syntax to insert a marker. See the definition of [markers](#markers). +> The `output` attribute may also contain the `\m{…markerId}` syntax to insert a marker. See the definition of [markers](#markers). _Attribute:_ `width="1.2"` (optional, default "1.0") @@ -1005,17 +1005,19 @@ The `displays` element consists of a list of [`display`](#element-display) subel ### Element: display -The display elements can be used to describe what is to be displayed on the keytops for various keys. For the most part, such explicit information is unnecessary since the `@to` element from the `keys/key` element will be used for keytop display. However some characters, such as diacritics, do not display well on their own. +The `display` elements can be used to describe what is to be displayed on the keytops for various keys. For the most part, such explicit information is unnecessary since the `@to` element from the `keys/key` element will be used for keytop display. -Another useful scenario is where there are doubled diacritics, or multiple characters with spacing issues. +- Some characters, such as diacritics, do not display well on their own. +- Another useful scenario is where there are doubled diacritics, or multiple characters with spacing issues. +- Finally, the `display` element provides a way to specify the keytop for keys which do not otherwise produce output. Keys which switch layers using the `@layerId` attribute typically do not produce output. -Finally, this provides a way to specify the keytop for keys which do not otherwise produce output, which is common for the `@layerId` attribute. +> Note: `displays` elements are designed to be shared across many different keyboard layout descriptions, and imported with `` where needed. -Note: `displays` elements are designed to be shared across many different keyboard layout descriptions, and imported with `` where needed. +#### Non-spacing marks on keytops -For combining characters, U+25CC `◌` is used as a base. It is an error to use a combining character without a base in the `display` attribute. +For non-spacing marks, U+25CC `◌` is used as a base. It is an error to use a combining character without a base in the `display` attribute. For example, `display="\u{0303}"` would produce an error. -For example, a key which outputs a combining tilde (U+0303) can be represented as follows: +A key which outputs a combining tilde (U+0303) could be represented as either of the following: ```xml @@ -1024,8 +1026,7 @@ For example, a key which outputs a combining tilde (U+0303) can be represented a This way, a key which outputs a combining tilde (U+0303) will be represented as `◌̃` (a tilde on a dotted circle). -Some scripts/languages may prefer a different base than U+25CC. -See [``](#element-displayoptions). +Some scripts/languages may prefer a different base than U+25CC. See [``](#element-displayoptions). **Syntax**