diff options
Diffstat (limited to 'docs/README.symbols')
| -rw-r--r-- | docs/README.symbols | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/docs/README.symbols b/docs/README.symbols index 10be81ce..749618e7 100644 --- a/docs/README.symbols +++ b/docs/README.symbols @@ -3,7 +3,7 @@ The files in the symbols directory describe possible layouts for a given keyboard. The default layout in each file should describe the most common layout -for its kind, ususally the symbols printed on the keys. Layout variants +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). @@ -36,3 +36,16 @@ The ISO codes can be found at the following addressed: 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 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. + +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 language-based, this has to be the name of the language. + +Within single symbols file, all the variants should have the same group name +(implemented using the "include" directive wherever possible). |