added explanatory comments for language mappings

git-svn-id: http://svn.code.sf.net/p/docutils/code/trunk@1510 929543f6-e4f2-0310-98a6-ba3bd3dd1d04

16 files changed, 80 insertions, 0 deletions

diff --git a/docutils/docutils/languages/__init__.py b/docutils/docutils/languages/__init__.py
index eb241a02e..a4d451156 100644
--- a/docutils/docutils/languages/__init__.py
+++ b/docutils/docutils/languages/__init__.py
@@ -4,6 +4,9 @@
 # Date: $Date$
 # Copyright: This module has been placed in the public domain.
 
+# Internationalization details are documented in
+# <http://docutils.sf.net/spec/howto/i18n.html>.
+
 """
 This package contains modules for language-dependent features of Docutils.
 """
diff --git a/docutils/docutils/languages/de.py b/docutils/docutils/languages/de.py
index 9da99b67a..ddffbda74 100644
--- a/docutils/docutils/languages/de.py
+++ b/docutils/docutils/languages/de.py
@@ -4,6 +4,11 @@
 # Date:      $Date$
 # Copyright: This module has been placed in the public domain.
 
+# New language mappings are welcome.  Before doing a new translation, please
+# read <http://docutils.sf.net/spec/howto/i18n.html>.  Two files must be
+# translated for each language: one in docutils/languages, the other in
+# docutils/parsers/rst/languages.
+
 """
 German language mappings for language-dependent features of Docutils.
 """
diff --git a/docutils/docutils/languages/en.py b/docutils/docutils/languages/en.py
index 066c77286..db578810b 100644
--- a/docutils/docutils/languages/en.py
+++ b/docutils/docutils/languages/en.py
@@ -4,6 +4,11 @@
 # Date: $Date$
 # Copyright: This module has been placed in the public domain.
 
+# New language mappings are welcome.  Before doing a new translation, please
+# read <http://docutils.sf.net/spec/howto/i18n.html>.  Two files must be
+# translated for each language: one in docutils/languages, the other in
+# docutils/parsers/rst/languages.
+
 """
 English-language mappings for language-dependent features of Docutils.
 """
@@ -11,6 +16,7 @@ English-language mappings for language-dependent features of Docutils.
 __docformat__ = 'reStructuredText'
 
 labels = {
+      # fixed: language-dependent
       'author': 'Author',
       'authors': 'Authors',
       'organization': 'Organization',
@@ -36,6 +42,7 @@ labels = {
 """Mapping of node class name to label text."""
 
 bibliographic_fields = {
+      # language-dependent: fixed
       'author': 'author',
       'authors': 'authors',
       'organization': 'organization',
diff --git a/docutils/docutils/languages/es.py b/docutils/docutils/languages/es.py
index 599345dd5..7505de5da 100644
--- a/docutils/docutils/languages/es.py
+++ b/docutils/docutils/languages/es.py
@@ -4,6 +4,11 @@
 # Date: $Date$
 # Copyright: This module has been placed in the public domain.
 
+# New language mappings are welcome.  Before doing a new translation, please
+# read <http://docutils.sf.net/spec/howto/i18n.html>.  Two files must be
+# translated for each language: one in docutils/languages, the other in
+# docutils/parsers/rst/languages.
+
 """
 Spanish-language mappings for language-dependent features of Docutils.
 """
diff --git a/docutils/docutils/languages/fr.py b/docutils/docutils/languages/fr.py
index 3416b0c6f..4a7f3ba4c 100644
--- a/docutils/docutils/languages/fr.py
+++ b/docutils/docutils/languages/fr.py
@@ -4,6 +4,11 @@
 # Date: $Date$
 # Copyright: This module has been placed in the public domain.
 
+# New language mappings are welcome.  Before doing a new translation, please
+# read <http://docutils.sf.net/spec/howto/i18n.html>.  Two files must be
+# translated for each language: one in docutils/languages, the other in
+# docutils/parsers/rst/languages.
+
 """
 French-language mappings for language-dependent features of Docutils.
 """
diff --git a/docutils/docutils/languages/it.py b/docutils/docutils/languages/it.py
index 1a59b5c7d..d86a5b1ec 100644
--- a/docutils/docutils/languages/it.py
+++ b/docutils/docutils/languages/it.py
@@ -4,6 +4,11 @@
 # Date: $Date$
 # Copyright: This module has been placed in the public domain.
 
+# New language mappings are welcome.  Before doing a new translation, please
+# read <http://docutils.sf.net/spec/howto/i18n.html>.  Two files must be
+# translated for each language: one in docutils/languages, the other in
+# docutils/parsers/rst/languages.
+
 """
 Italian-language mappings for language-dependent features of Docutils.
 """
diff --git a/docutils/docutils/languages/sk.py b/docutils/docutils/languages/sk.py
index e57e3c8cf..20fa645ad 100644
--- a/docutils/docutils/languages/sk.py
+++ b/docutils/docutils/languages/sk.py
@@ -4,6 +4,11 @@
 # :Date: $Date$
 # :Copyright: This module has been placed in the public domain.
 
+# New language mappings are welcome.  Before doing a new translation, please
+# read <http://docutils.sf.net/spec/howto/i18n.html>.  Two files must be
+# translated for each language: one in docutils/languages, the other in
+# docutils/parsers/rst/languages.
+
 """
 Slovak-language mappings for language-dependent features of Docutils.
 """
diff --git a/docutils/docutils/languages/sv.py b/docutils/docutils/languages/sv.py
index 55f25192f..8e8d84f2d 100644
--- a/docutils/docutils/languages/sv.py
+++ b/docutils/docutils/languages/sv.py
@@ -4,6 +4,11 @@
 # Date:      $Date$
 # Copyright: This module has been placed in the public domain.
 
+# New language mappings are welcome.  Before doing a new translation, please
+# read <http://docutils.sf.net/spec/howto/i18n.html>.  Two files must be
+# translated for each language: one in docutils/languages, the other in
+# docutils/parsers/rst/languages.
+
 """
 Swedish language mappings for language-dependent features of Docutils.
 """
diff --git a/docutils/docutils/parsers/rst/languages/__init__.py b/docutils/docutils/parsers/rst/languages/__init__.py
index 86bfd03ba..ea4218657 100644
--- a/docutils/docutils/parsers/rst/languages/__init__.py
+++ b/docutils/docutils/parsers/rst/languages/__init__.py
@@ -4,6 +4,9 @@
 # Date: $Date$
 # Copyright: This module has been placed in the public domain.
 
+# Internationalization details are documented in
+# <http://docutils.sf.net/spec/howto/i18n.html>.
+
 """
 This package contains modules for language-dependent features of
 reStructuredText.
diff --git a/docutils/docutils/parsers/rst/languages/de.py b/docutils/docutils/parsers/rst/languages/de.py
index 7f2a25e78..001b7c3b9 100644
--- a/docutils/docutils/parsers/rst/languages/de.py
+++ b/docutils/docutils/parsers/rst/languages/de.py
@@ -5,6 +5,11 @@
 # Date: $Date$
 # Copyright: This module has been placed in the public domain.
 
+# New language mappings are welcome.  Before doing a new translation, please
+# read <http://docutils.sf.net/spec/howto/i18n.html>.  Two files must be
+# translated for each language: one in docutils/languages, the other in
+# docutils/parsers/rst/languages.
+
 """
 German-language mappings for language-dependent features of
 reStructuredText.
diff --git a/docutils/docutils/parsers/rst/languages/en.py b/docutils/docutils/parsers/rst/languages/en.py
index bc488a53e..a9b060f82 100644
--- a/docutils/docutils/parsers/rst/languages/en.py
+++ b/docutils/docutils/parsers/rst/languages/en.py
@@ -4,6 +4,11 @@
 # Date: $Date$
 # Copyright: This module has been placed in the public domain.
 
+# New language mappings are welcome.  Before doing a new translation, please
+# read <http://docutils.sf.net/spec/howto/i18n.html>.  Two files must be
+# translated for each language: one in docutils/languages, the other in
+# docutils/parsers/rst/languages.
+
 """
 English-language mappings for language-dependent features of
 reStructuredText.
@@ -13,6 +18,7 @@ __docformat__ = 'reStructuredText'
 
 
 directives = {
+      # language-dependent: fixed
       'attention': 'attention',
       'caution': 'caution',
       'danger': 'danger',
@@ -54,6 +60,7 @@ directives = {
 mapping."""
 
 roles = {
+    # language-dependent: fixed
     'abbreviation': 'abbreviation',
     'ab': 'abbreviation',
     'acronym': 'acronym',
diff --git a/docutils/docutils/parsers/rst/languages/es.py b/docutils/docutils/parsers/rst/languages/es.py
index 5f3f964a6..d052d918c 100644
--- a/docutils/docutils/parsers/rst/languages/es.py
+++ b/docutils/docutils/parsers/rst/languages/es.py
@@ -4,6 +4,11 @@
 # Date: $Date$
 # Copyright: This module has been placed in the public domain.
 
+# New language mappings are welcome.  Before doing a new translation, please
+# read <http://docutils.sf.net/spec/howto/i18n.html>.  Two files must be
+# translated for each language: one in docutils/languages, the other in
+# docutils/parsers/rst/languages.
+
 """
 Spanish-language mappings for language-dependent features of
 reStructuredText.
diff --git a/docutils/docutils/parsers/rst/languages/fr.py b/docutils/docutils/parsers/rst/languages/fr.py
index 311c5db0f..f75cf6c78 100644
--- a/docutils/docutils/parsers/rst/languages/fr.py
+++ b/docutils/docutils/parsers/rst/languages/fr.py
@@ -4,6 +4,11 @@
 # Date: $Date$
 # Copyright: This module has been placed in the public domain.
 
+# New language mappings are welcome.  Before doing a new translation, please
+# read <http://docutils.sf.net/spec/howto/i18n.html>.  Two files must be
+# translated for each language: one in docutils/languages, the other in
+# docutils/parsers/rst/languages.
+
 """
 French-language mappings for language-dependent features of
 reStructuredText.
diff --git a/docutils/docutils/parsers/rst/languages/it.py b/docutils/docutils/parsers/rst/languages/it.py
index 21ede5bce..aed0f2be5 100644
--- a/docutils/docutils/parsers/rst/languages/it.py
+++ b/docutils/docutils/parsers/rst/languages/it.py
@@ -4,6 +4,11 @@
 # Date: $Date$
 # Copyright: This module has been placed in the public domain.
 
+# New language mappings are welcome.  Before doing a new translation, please
+# read <http://docutils.sf.net/spec/howto/i18n.html>.  Two files must be
+# translated for each language: one in docutils/languages, the other in
+# docutils/parsers/rst/languages.
+
 """
 Italian-language mappings for language-dependent features of
 reStructuredText.
diff --git a/docutils/docutils/parsers/rst/languages/sk.py b/docutils/docutils/parsers/rst/languages/sk.py
index 772f0433f..eb426ed47 100644
--- a/docutils/docutils/parsers/rst/languages/sk.py
+++ b/docutils/docutils/parsers/rst/languages/sk.py
@@ -4,6 +4,11 @@
 # Date: $Date$
 # Copyright: This module has been placed in the public domain.
 
+# New language mappings are welcome.  Before doing a new translation, please
+# read <http://docutils.sf.net/spec/howto/i18n.html>.  Two files must be
+# translated for each language: one in docutils/languages, the other in
+# docutils/parsers/rst/languages.
+
 """
 Slovak-language mappings for language-dependent features of
 reStructuredText.
diff --git a/docutils/docutils/parsers/rst/languages/sv.py b/docutils/docutils/parsers/rst/languages/sv.py
index e126b9dd1..a2f6b77cc 100644
--- a/docutils/docutils/parsers/rst/languages/sv.py
+++ b/docutils/docutils/parsers/rst/languages/sv.py
@@ -4,6 +4,11 @@
 # Date:      $Date$
 # Copyright: This module has been placed in the public domain.
 
+# New language mappings are welcome.  Before doing a new translation, please
+# read <http://docutils.sf.net/spec/howto/i18n.html>.  Two files must be
+# translated for each language: one in docutils/languages, the other in
+# docutils/parsers/rst/languages.
+
 """
 Swedish language mappings for language-dependent features of reStructuredText.
 """