updating docs on how to handle l10n
Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/82f10664 Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/82f10664 Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/82f10664 Branch: refs/heads/master Commit: 82f106646f39341de7f2b07fb40c48af5408d90b Parents: bfc79f5 Author: David Nalley <[email protected]> Authored: Wed Sep 26 02:09:13 2012 -0400 Committer: David Nalley <[email protected]> Committed: Wed Sep 26 02:09:13 2012 -0400 ---------------------------------------------------------------------- docs/README.txt | 22 +++++++++++++++++++++- 1 files changed, 21 insertions(+), 1 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/82f10664/docs/README.txt ---------------------------------------------------------------------- diff --git a/docs/README.txt b/docs/README.txt index 7fcfff8..41bf749 100644 --- a/docs/README.txt +++ b/docs/README.txt @@ -111,9 +111,29 @@ LOCALIZATION ---------------------------------- -Localized versions of the documentation files can be stored in appropriately named subdirectories parallel to en-US. The language code names to use for these directories are listed in Publican documentation, http://jfearn.fedorapeople.org/en-US/Publican/2.7/html/Users_Guide/appe-Users_Guide-Language_codes.html. +Localized versions of the documentation files can be stored in appropriately +named subdirectories parallel to en-US. The language code names to use for +these directories are listed in Publican documentation, +http://jfearn.fedorapeople.org/en-US/Publican/2.7/html/Users_Guide/appe-Users_Guide-Language_codes.html. For example, Japanese XML files would be stored in the docs/ja-JP directory. +Localization currently happens using Transifex and you can find the strings +to be translated at this location: +https://www.transifex.com/projects/p/ACS_DOCS/ + +In preparation for l10n, authors and docs folks must take not of a number of +things. +All .xml files must contain a translatable string. <xi:include> tags are not enough. +All new .xml files must have a corresponding entry in docs/.tx/config +Filenames should be less than 50 characters long. + +To generate new POT files and upload source do the following: +publican update_pot --config=./publican-all.cfg +tx push -s + +To receive translated files from publican, run the following command: +tx pull + ----------------------------------
