.. include:: /Includes.rst.txt


.. _custom-translation-server:

==========================
Custom Translation Servers
==========================

With the usage of XLIFF and the freely available `Pootle <https://pootle.translatehouse.org/>`__
translation server, companies and individuals may easily set up a custom translation server
for their extensions.

There is an event that can be caught to change the translation server URL to use. The first
step is to register one's listener for the event. Such code would be placed in an
extension's :file:`services.yml` file:

.. code-block:: php

   services:
     Company\Extensions\Listener\CustomMirror:
       tags:
         - name: event.listener
           identifier: 'ext-extensions/customMirror'
           method: 'postProcessMirrorUrl'
           event: \TYPO3\CMS\Install\Service\Event\ModifyLanguagePackRemoteBaseUrlEvent


The class (listener) which receives the event
(:file:`EXT:extensions/Classes/Listeners/CustomMirror.php`) could look something like:

.. code-block:: php

   <?php
   namespace Company\Extensions\Listener;
   use \TYPO3\CMS\Install\Service\Event\ModifyLanguagePackRemoteBaseUrlEvent;
   class CustomMirror {
      static protected $extensionKey = 'myext';

      public function postProcessMirrorUrl(ModifyLanguagePackRemoteBaseUrlEvent $event): void
      {
         if ($event->getPackageKey() === self::$extensionKey) {
            $mirrorUrl = 'https://example.org/typo3-packages/';
            $event->setBaseUrl($mirrorUrl);
         }
      }
   }

In the above example, the URL is changed only for a given
extension, but of course it could be changed on a more general basis.

On the custom translation server side, the structure needs to be:

.. code-block:: text

   https://example.org/typo3-packages/
   `-- <first-letter-of-extension-key>
      `-- <second-letter-of-extension-key>
         `-- <extension-key>-l10n
            |-- <extension-key>-l10n-de.zip
            |-- <extension-key>-l10n-fr.zip
            |-- <extension-key>-l10n-it.zip
            `-- <extension-key>-l10n.xml

hence in our example:

.. code-block:: text

   https://example.org/typo3-packages/
   `-- m
      `-- y
         `-- myext-l10n
            |-- myext-l10n-de.zip
            |-- myext-l10n-fr.zip
            |-- myext-l10n-it.zip
            `-- myext-l10n.xml

And the :file:`myext-l10n.xml` file contains something like:

.. code-block:: xml

   <?xml version="1.0" standalone="yes" ?>
   <TERlanguagePackIndex>
      <meta>
         <timestamp>1374841386</timestamp>
         <date>2013-07-26 14:23:06</date>
      </meta>
      <languagePackIndex>
         <languagepack language="de">
            <md5>1cc7046c3b624ba1fb1ef565343b84a1</md5>
         </languagepack>
         <languagepack language="fr">
            <md5>f00f73ae5c43cb68392e6c508b65de7a</md5>
         </languagepack>
         <languagepack language="it">
            <md5>cd59530ce1ee0a38e6309544be6bcb3d</md5>
         </languagepack>
      </languagePackIndex>
   </TERlanguagePackIndex>