diff options
Diffstat (limited to 'xorg-server/xkeyboard-config/docs')
| -rw-r--r-- | xorg-server/xkeyboard-config/docs/README.symbols | 45 |
1 files changed, 21 insertions, 24 deletions
diff --git a/xorg-server/xkeyboard-config/docs/README.symbols b/xorg-server/xkeyboard-config/docs/README.symbols index 749618e77..31ca053eb 100644 --- a/xorg-server/xkeyboard-config/docs/README.symbols +++ b/xorg-server/xkeyboard-config/docs/README.symbols @@ -1,51 +1,48 @@ -The files in the symbols directory describe possible layouts for a given -keyboard. +The files in the symbols directory describe possible keyboard layouts +for a given country or language or script. The default layout in each file should describe the most common layout -for its kind, usually the symbols printed on the keys. Layout variants -can describe common differences that are not necessarily printed on the keys. -(e.g. a phonetic version of Cyrillic). +for its kind, usually the one that matches the symbols printed on the +keys. Layout variants can describe common deviations that are not +necessarily printed on the keys (e.g. a phonetic version of Cyrillic). -The names of the files are referenced throughout the XKB rules, and may be -exposed in the X server configuration and in user configuration tools. +The names of the files are referenced throughout the XKB rules, and may +be exposed in the X server configuration and in user configuration tools. The filenames use the following convention: Country layouts: - Keyboard layouts for a country must use the 2-letter code from the ISO-3166 standard. Language layouts: - Keyboard layouts for a language must use the 3-letter code from the ISO-639 standard. Script layouts: - Keyboard layouts for a script must use the 4-letter code from the ISO-15924 standard. Other: + Keyboard layouts that do not fit in the above categories must use a + filename between 5 and 8 characters. - Keyboard layouts that do not fit in the above model and directories - must use a filename between 5 and 8 characters. - -The ISO codes can be found at the following addressed: +The relevant ISO codes can be found at the following addresses: -Country layouts: http://www.iso.org/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/iso_3166-1_decoding_table.html -Language layouts: http://www.loc.gov/standards/iso639-2/langcodes.html +Country layouts: http://www.iso.org/iso/home/standards/country_codes/iso-3166-1_decoding_table.htm +Language layouts: http://www.loc.gov/standards/iso639-2/php/code_list.php Script layouts: http://www.unicode.org/iso15924/iso15924-codes.html -The description in the directory file base.xml.in should match the group names -in the symbols file. +The descriptions of the layouts in the file base.xml.in should match the +group names in the symbols file. -If the layout is country-based, this has to be the full -name of the country. It is highly not recommended to use the forms -"Republic of XXX" or "XXX Republic" - the form "XXX" should be used instead. -The only exception is "United Kingdom". +If the layout is country-based, the group name has to be the full name of +the country. It is highly discouraged to use forms like "Republic of XXX" +or "XXX Republic" -- the form "XXX" should be used instead. The only +exception is "United Kingdom". -If the layout is language-based, this has to be the name of the language. +If the layout is language-based, the group name has to be the name of the +language. -Within single symbols file, all the variants should have the same group name +Within a single symbols file, all the variants should have the same group name (implemented using the "include" directive wherever possible). |