diff --git a/docs/ldml/tr35-keyboards.md b/docs/ldml/tr35-keyboards.md index c16f5b1b913..e138c6a494c 100644 --- a/docs/ldml/tr35-keyboards.md +++ b/docs/ldml/tr35-keyboards.md @@ -624,6 +624,7 @@ This element defines a mapping between an abstract key and its output. This elem stretch="true" layerId="{switch layer id}" output="{the output}" + transform="no" width="{key width}" /> ``` @@ -739,6 +740,18 @@ _Attribute:_ `output` > > The `output` attribute may also contain the `\m{…}` syntax to insert a marker. See the definition of [markers](#markers). +_Attribute:_ `transform="no"` + +> The `transform` attribute is used to define a key that does not participate in a transform. +> Using this attribute causes the marker `\m{no_transform}` to be added after the key’s output. +> In other words, the following produce identical results: +> ```xml +> +> +> ``` +> +> See [Using markers to inhibit other transforms](#using-markers-to-inhibit-other-transforms) for more details about this approach. + _Attribute:_ `width="1.2"` (optional, default "1.0") > The `width` attribute indicates that this key has a different width than other keys, by the specified number of key widths. @@ -1661,7 +1674,7 @@ Consider the following abbreviated example: - … - character `ê` -**Using markers to inhibit other transforms** +##### Using markers to inhibit other transforms Sometimes it is desirable to prevent transforms from having an effect. Perhaps two different keys output the same characters, with different key or modifier combinations, but only one of them is intended to participate in a transform. @@ -1694,7 +1707,9 @@ One strategy would be to use a marker, which won’t be visible in the output, b ``` -Pressing `caret` `e` will result in `^e` (with an invisible _no_transform_ marker — note that any name could be used). The `^e` won’t have the transform applied, at least while the marker’s context remains valid. +Pressing `caret` `e` will result in `^e` (with an invisible _no_transform_ marker). The `^e` won’t have the transform applied, at least while the marker’s context remains valid. + +As a convenience, the above is exactly identical to: `` Another strategy might be to use a marker to indicate where transforms are desired, instead of where they aren't desired. diff --git a/keyboards/dtd/ldmlKeyboard3.dtd b/keyboards/dtd/ldmlKeyboard3.dtd index d5cacaa7e98..8a1f66ffd8e 100644 --- a/keyboards/dtd/ldmlKeyboard3.dtd +++ b/keyboards/dtd/ldmlKeyboard3.dtd @@ -118,6 +118,8 @@ Please view the subcommittee page for the most recent information. + +