ZF-6492: English and French documentation on the translate resource plugin

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@22966 44c647ce-9c0f-0410-b52a-842ac1e357ba

documentation/manual/en/module_specs/Zend_Application-AvailableResources-Translate.xml

@@ -0,0 +1,81 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- Reviewed: no -->
+<sect2 id="zend.application.available-resources.translate">
+    <title>Zend_Application_Resource_Translate</title>
+
+    <para>
+        <classname>Zend_Application_Resource_Translate</classname> will initialize a 
+        <classname>Zend_Translate</classname> adapter based on the options passed to it.
+    </para>
+
+    <para>
+        The following configuration keys are recognized:
+    </para>
+
+    <itemizedlist>
+        <listitem>
+            <para>
+                <emphasis><property>adapter</property></emphasis> : <classname>Zend_Translate
+                </classname> adapter type. The default adapter is array if not specified.
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <emphasis><property>data</property></emphasis> : path to translation.
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <emphasis><property>locale</property></emphasis> : defining the locale to be used 
+                in translation. By default, the locale can be detected automatically or forcing 
+                with a <classname>Zend_Locale</classname> instance store in <classname>
+                Zend_Registry</classname> with a single locale.
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <emphasis><property>options</property></emphasis> : the options are different for 
+                each adapter. See the section <xref linked="zend.translate.additional.options" /> for 
+                more details.
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <emphasis><property>registry</property></emphasis> : the custom key to store the
+                <classname>Zend_Translate</classname> instance in the registry. By default, the 
+                key is Zend_Translate.
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <emphasis><property>cache</property></emphasis> : the name of the cache template 
+                or an instance of <classname>Zend_Cache_Core</classname> to use as cache for 
+                <classname>Zend_Translate_Adapter</classname>. The goal is to accelerate the 
+                loading specialy for the XML based files.
+            </para>
+        </listitem>
+    </itemizedlist>
+
+    <example id="zend.application.available-resources.translate.configExample">
+        <title>Sample translate adapter resource configuration</title>
+
+        <para>
+            Below is an example <acronym>INI</acronym> configuration that can be used to initialize
+            the translate resource. 
+        </para>
+
+        <programlisting language="ini"><![CDATA[
+resources.translate.adapter = tmx
+resources.translate.data = APPLICATION_PATH "/../data/locales"
+resources.translate.scan = Zend_Translate::LOCALE_DIRECTORY
+
+; Optionally you can also the cache template to use for caching:
+resources.translate.cache = "languages"
+]]></programlisting>
+    </example>
+</sect2>

documentation/manual/en/module_specs/Zend_Application-AvailableResources.xml

@@ -21,5 +21,6 @@
     <xi:include href="Zend_Application-AvailableResources-Navigation.xml" />
     <xi:include href="Zend_Application-AvailableResources-Router.xml" />
     <xi:include href="Zend_Application-AvailableResources-Session.xml" />
+    <xi:include href="Zend_Application-AvailableResources-Translate.xml" />
     <xi:include href="Zend_Application-AvailableResources-View.xml" />
 </sect1>

documentation/manual/fr/module_specs/Zend_Application-AvailableResources-Translate.xml

@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- EN-Revision:  -->
+<!-- Reviewed: no -->
+<sect2 id="zend.application.available-resources.translate">
+    <title>Zend_Application_Resource_Translate</title>
+
+    <para>
+        <classname>Zend_Application_Resource_Translate</classname> initialisera un adaptateur
+        <classname>Zend_Translate</classname> basé sur les options qui lui seront fourni.
+    </para>
+
+    <para>
+        Les clés de configuration suivantes sont reconnues :
+    </para>
+
+    <itemizedlist>
+        <listitem>
+            <para>
+                <emphasis><property>adapter</property></emphasis> : le type de l'adaptateur
+                <classname>Zend_Translate</classname>. S'il n'est pas précisé, l'adaptateur 
+                par défaut est de type tableau (array).
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <emphasis><property>data</property></emphasis> : le chemin d'accès aux sources de 
+                traduction.
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <emphasis><property>locale</property></emphasis> : la locale à utiliser pour 
+                choisir la traduction. Ce paramètre est optionnel, car la langue de l'utilisateur 
+                peut être soit détectée automatiquement soit forcée avec une instance <classname>
+                Zend_Locale</classname> placée dans <classname>Zend_Registry</classname> avec une
+                langue choisie.
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <emphasis><property>options</property></emphasis> : les options varient en fonction 
+                de l'adaptateur choisi. Veuillez vous reporter à la section 
+                <xref linked="zend.translate.using.options" /> de ce dernier pour plus de détails.
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <emphasis><property>registry</property></emphasis> : spécifie la clé du registre 
+                pour stocker l'instance de <classname>Zend_Translate</classname>. Ce paramètre 
+                est optionnel, car il sera mis par défaut dans le registre avec la clé 
+                Zend_Translate.
+            </para>
+        </listitem>
+
+        <listitem>
+            <para>
+                <emphasis><property>cache</property></emphasis> : spécifie le nom d'un modèle du 
+                gestionnaire de cache ou l'objet de cache pour les sources de traduction. Cela 
+                permet d'améliorer les performances en particulier pour les formats XML.
+            </para>
+        </listitem>
+    </itemizedlist>
+
+    <example id="zend.application.available-resources.translate.configExample">
+        <title>Exemple de configuration d'une ressource multilingue</title>
+
+        <para>
+            Voici un extrait de configuration <acronym>INI</acronym> montrant comment configurer une
+            ressource multilingue.
+        </para>
+
+        <programlisting language="ini"><![CDATA[
+resources.translate.adapter = tmx
+resources.translate.data = APPLICATION_PATH "/../data/locales"
+resources.translate.scan = Zend_Translate::LOCALE_DIRECTORY
+
+; Optionnellement, on peut utiliser un modèle du gestionnaire de cache :
+resources.translate.cache = "languages"
+]]></programlisting>
+    </example>
+</sect2>

documentation/manual/fr/module_specs/Zend_Application-AvailableResources.xml

@@ -22,5 +22,6 @@
     <xi:include href="Zend_Application-AvailableResources-Navigation.xml" />
     <xi:include href="Zend_Application-AvailableResources-Router.xml" />
     <xi:include href="Zend_Application-AvailableResources-Session.xml" />
+    <xi:include href="Zend_Application-AvailableResources-Translate.xml" />
     <xi:include href="Zend_Application-AvailableResources-View.xml" />
 </sect1>