Translators' Guide to Python.org

Some portions of the Python.org website are made available in multiple languages thanks the volunteered efforts of translators. This document identifies those portions of the site and describes how translators can contribute.

List of Translated Portions

The following portions of the site currently contain translated material:

Additional portions of the site may be offered in translation should contributors step forward and are willing to maintain translations.

How to Contribute

For each translation, we can create a secondary directory structure held in directories named using a two-letter language identifier. Links to the translations will be made from the directory index page to the index of the translations directory as appropriate, and entries will be made in the non-English resources list.

For each HTML file, there is a file of the same name with a ".ht" extension; this is the file that should be translated. The files may be retrieved directly from the Python.org site by simply removing the "ml" at the end of the filename (when a URL ending in a slash is used to access the original page, add "index.ht" to the URL). These files contain some metadata stored as RFC 2822 mail headers followed by a blank line, then the body of the content as either HTML or reStructuredText. For files written as HTML, please notify the pydotorg at python.org mailing list that you're interested in providing a translation; they may want to convert the file to reStructuredText before it's translated; files are generally be converted to reStructuredText as they require maintenance.

In addition to the ".ht" files that contain the content of the site, each directory contains a "links.h" file that contains links which are used to generate the left-hand navigation sidebar. This text in this file should be translated as well; the rest of the file is HTML-like markup. The "links.h" in a directory of translations should include a link to the source directory, links to translated documents should be checked and adjusted if necessary (as will be the case for documents in different directories), and a link to the source directory should be added.

Learning About Site Changes

The bulk of the contents of Python.org is maintained in SVN. It's possible to check out an anonymous copy from <https://svn.python.org/www/trunk>. The mailing list which gets email notifications of changes is not generally accessible. The best way to learn about site changes is currently to monitor the site. Once the webmasters know that a page is being translated, we'll endeavor to make some form of versioning information available on the page.

Some better way to provide change information for translators will be provided in the future, but we don't know what form that will take yet.