1 2The files in the symbols directory describe possible keyboard layouts 3for a given country or language or script. 4 5The default layout in each file should describe the most common layout 6for its kind, usually the one that matches the symbols printed on the 7keys. Layout variants can describe common deviations that are not 8necessarily printed on the keys (e.g. a phonetic version of Cyrillic). 9 10The names of the files are referenced throughout the XKB rules, and may 11be exposed in the X server configuration and in user configuration tools. 12The filenames use the following convention: 13 14Country layouts: 15 Keyboard layouts for a country must use the 2-letter code from the 16 ISO-3166 standard. 17 18Language layouts: 19 Keyboard layouts for a language must use the 3-letter code from the 20 ISO-639 standard. 21 22Script layouts: 23 Keyboard layouts for a script must use the 4-letter code from the 24 ISO-15924 standard. 25 26Other: 27 Keyboard layouts that do not fit in the above categories must use a 28 filename between 5 and 8 characters. 29 30The relevant ISO codes can be found at the following addresses: 31 32Country layouts: http://www.iso.org/iso/home/standards/country_codes/iso-3166-1_decoding_table.htm 33Language layouts: http://www.loc.gov/standards/iso639-2/php/code_list.php 34Script layouts: http://www.unicode.org/iso15924/iso15924-codes.html 35 36The descriptions of the layouts in the file base.xml.in should match the 37group names in the symbols file. 38 39If the layout is country-based, the group name has to be the full name of 40the country. It is highly discouraged to use forms like "Republic of XXX" 41or "XXX Republic" -- the form "XXX" should be used instead. 42 43If the layout is language-based, the group name has to be the name of the 44language. 45 46Within a single symbols file, all the variants should have the same group name 47(implemented using the "include" directive wherever possible). 48