Forum OpenACS Development: Updated internationalization docs

Collapse
Posted by Joel Aufrecht on
A complete, step-by-step guide to internationalizing your package.  https://openacs.org/doc/openacs-HEAD/i18n-convert.html
Collapse
Posted by Matthias Melcher on
Thank you, Joel, for the comprehensive list of automated task
and technical to-do's. However, I find it important to add a
note on HUMAN processing to check the necessarity, quality,
and consistency of the message-keys. Otherwise, the human
translators will soon be very frustrated and will leave their
work to automates, as well, which, in turn, will make
usablility worse again. For instance, the "photo album" is a
bad example how automated tools have thoughtlessly generated
numerous unneccesary keys that just verbatimly duplicate the
corresponding ones from the file store package.

So, somewhere preceding your section #2, developers should be
urged to use the translation server's lookup functionality
to see if the message and words have been used elsewhere
and if the usage is consistent. Also, once you have the
name of the .adp files on your mouse/clipboard, it should
be easy to paste it into "Description" box and give hints how
to reach this page on the normal enduser UI so that translators
can find their context.

See also threads https://openacs.org/forums/message-view?message_id=158580 on duplicates and for instance https://openacs.org/forums/message-view?message_id=125235
and https://openacs.org/forums/message-view?message_id=164973 on context.

Collapse
Posted by Joel Aufrecht on
I've added a note about duplicates to that doc.  Re: adding the adp, perhaps a better fix would be to add a link "show pages where this is used" which then searches the source code, finds usage of the message key, guesses the URL for those pages, and displays them (or their source).  It would work for all keys without additional developer work per key.  It wouldn't help navigating to pages that have required inputs, but neither does putting the adp path in the description.