summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorsvu <svu>2004-06-20 13:57:33 +0000
committersvu <svu>2004-06-20 13:57:33 +0000
commiteb829a739bf948b6dc2c5d03619a51513fb0a678 (patch)
tree4aae1e4761f94fd62e4425eae4c3cd8bf0ec730f /docs
parent8ad31952d068ee8942d93bbf8bd2f51f79a71b13 (diff)
Second phase of i18n. Frank rocks the world:)
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile.am2
-rw-r--r--docs/README.symbols38
2 files changed, 39 insertions, 1 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 73ab7456..5ae0e80a 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1 +1 @@
-EXTRA_DIST= README.config README.enhancing HOWTO.transition HOWTO.testing
+EXTRA_DIST= README.config README.enhancing README.symbols HOWTO.transition HOWTO.testing
diff --git a/docs/README.symbols b/docs/README.symbols
new file mode 100644
index 00000000..10be81ce
--- /dev/null
+++ b/docs/README.symbols
@@ -0,0 +1,38 @@
+
+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
+can describe common differences 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 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 model and directories
+ must use a filename between 5 and 8 characters.
+
+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