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