Author: Derick Rethans Date: 2006-01-24 17:10:00 +0100 (Tue, 24 Jan 2006) New Revision: 2020
Log: - Part 1 of the translation tutorial. Modified: packages/Execution/trunk/docs/tutorial.txt packages/Translation/trunk/docs/tutorial.txt Modified: packages/Execution/trunk/docs/tutorial.txt =================================================================== --- packages/Execution/trunk/docs/tutorial.txt 2006-01-24 16:09:47 UTC (rev 2019) +++ packages/Execution/trunk/docs/tutorial.txt 2006-01-24 16:10:00 UTC (rev 2020) @@ -1,6 +1,8 @@ eZ components - Execution ~~~~~~~~~~~~~~~~~~~~~~~~~ +.. contents:: Table of Contents + Introduction ============ Modified: packages/Translation/trunk/docs/tutorial.txt =================================================================== --- packages/Translation/trunk/docs/tutorial.txt 2006-01-24 16:09:47 UTC (rev 2019) +++ packages/Translation/trunk/docs/tutorial.txt 2006-01-24 16:10:00 UTC (rev 2020) @@ -1,16 +1,63 @@ eZ components - Translation ~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.. contents:: Table of Contents + Introduction ============ +Many Web applications require the use of translated GUI elements. There are +several traditional ways of providing this functionality but none of them are +really easy to use or maintain. This component provides functionality for +retrieving translated data through multiple (extendable) backends and filtering +translatable data. It also allows translated strings with parameters so that it +is possible to swap the order in different languages but still keep the +parameters correct. +Dependencies +============ +This component has an optional dependency on the Cache component by means of +the TranslationCacheTiein component. When the latter is installed the +Translation system can make use of a cache to store data to, and retrieve data +from. + +The Template component also has an optional dependency on this component, by +means of the TemplateTranslationTiein component. This component adds a template +function that uses the Translation component to fetch translated data. + Class overview ============== +ezcTranslationManager + The main class of this component. It is responsible for calling the + configured backends to read in translation data and return a translation + context in the form of an ezcTranslation object. +ezcTranslationCacheBackend, ezcTranslationTsBackend + These classes implement backends that delete data from a specific source. The + ezcTranslationTsBackend reads its data from `Qt's Linguist files`_ - an XML + based format for storing original text and translated text. The + ezcTranslationCacheBackend handler reads translation data through the Cache + mechanism. +ezcTranslation + Objects of this class are returned by the ezcTranslationManager::getContext() + method. The ezcTranslationManager uses the backend's getContext() method on + its turn to retrieve data. + +ezcTranslationComplementEmptyFilter + This class implements a filter that substitutes a missing translated string + with its untranslated source. This filter makes sure all translatable strings + return a text, even if this particular string was not translated yet. + +ezcTranslationBorkFilter, ezcTranslationLeetFilter + These two classes serve as an example on how to implement filters. Besides + serving as an example they have very little function. + + +.. _`Qt's Linguist files`: http://www.trolltech.com/products/qt/internationalization.html + Installation ============ @@ -20,10 +67,18 @@ .. _Components Introduction: http://ez.no/community/articles/an_introduction_to_ez_components -Usage -===== +Basic Usage +=========== +Iteration +========= + + +Caching +======= + + .. Local Variables: -- svn-components mailing list [email protected] http://lists.ez.no/mailman/listinfo/svn-components
