summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorsvu <svu>2004-12-22 23:28:46 +0000
committersvu <svu>2004-12-22 23:28:46 +0000
commit9749aa6e20a687f2e0056f058b3095f00fd04ef5 (patch)
treef386a72a9f645010298a6e1d900cd42e45bcb929 /docs
parent5098fd29d2de79ba090647aa6b5319e57f32ff4e (diff)
downloadxkeyboard-config-9749aa6e20a687f2e0056f058b3095f00fd04ef5.tar.gz
more rules regarding symbols
Diffstat (limited to 'docs')
-rw-r--r--docs/README.symbols15
1 files changed, 14 insertions, 1 deletions
diff --git a/docs/README.symbols b/docs/README.symbols
index 10be81c..749618e 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).