Translatable XML Documentation

e-Spirit AG

2020-02-20
Table of Contents

1. Introduction

FirstSpirit TranslationStudio uses FirstSpirit’s external synchronisation feature to generate a translatable xml file and to import a translated xml file into FirstSpirit again.

However, it is possible to automatically transform the default XML into a much simpler format.

2. Format Description

All translatable texts are enclosed in separate text nodes. Any such node is, in turn, enclosed in a phrase node.

If some texts form a meaningful entity (such as a list), the parent phrase node will enclose several text nodes.

No attribute has to be translated.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<translation-studio>
    <header>
        <attribute name="source-language" value="EN"/>
        <attribute name="target-language" value="DE"/>
        <attribute name="skeleton" value="............"/>
    </header>
    <translatable>
        <phrase>
            <text id="ts-target-text-1">Welcome to Mithras Energy</text>
        </phrase>
        <phrase>
            <text id="ts-target-dom-1">Products you will love </text>
            <text id="ts-target-dom-2">Hightech products for solar energy.</text>
        </phrase>
        <phrase>
            <text id="ts-target-text-2">See more products</text>
        </phrase>
        <phrase>
            <text id="ts-target-dom-3">Mithras Energy</text>
            <text id="ts-target-dom-4">Solar technology, which just thrilled</text>
        </phrase>
        <phrase>
            <text id="ts-target-dom-5">Mithras Energy</text>
            <text id="ts-target-dom-6">We offer individual consultation for solar energy aspects</text>
        </phrase>
        <phrase>
            <text id="ts-target-dom-7">Welcome </text>
            <text id="ts-target-dom-8">to Mithras Energy</text>
            <text id="ts-target-dom-9">!</text>
            <text id="ts-target-dom-10">Solar energy is the energy of the future ― and we have dedicated ourselves to this future. With our solutions and products, we would like to make sure that you are best equipped for this energy of the future. This is the only way for each of us to achieve the highest levels of sustainability and environmental protection for ourselves, our families and our companies</text>
        </phrase>
        <phrase>
            <text id="ts-target-dom-11">Homebuilder</text>
            <text id="ts-target-dom-12">Individual concepts for planning and installation</text>
        </phrase>
        <phrase>
            <text id="ts-target-text-3">more</text>
        </phrase>
        <phrase>
            <text id="ts-target-dom-13">Our services</text>
            <text id="ts-target-dom-14">Our services for sales, marketing and installation branches.</text>
        </phrase>
        <phrase>
            <text id="ts-target-text-4">more</text>
        </phrase>
        <phrase>
            <text id="ts-target-dom-15">Consultations</text>
            <text id="ts-target-dom-16">Get  individual consulting for all aspects of solar energy!</text>
        </phrase>
        <phrase>
            <text id="ts-target-dom-17">Solarmodules</text>
            <text id="ts-target-dom-18">CO2 emissions drop further</text>
        </phrase>
        <phrase>
            <text id="ts-target-text-5">more</text>
        </phrase>
        <phrase>
            <text id="ts-target-dom-19">DS 1400</text>
            <text id="ts-target-dom-20">The thinlayermodule's winner</text>
        </phrase>
        <phrase>
            <text id="ts-target-text-6">more</text>
        </phrase>
        <phrase>
            <text id="ts-target-dom-21">Financing</text>
            <text id="ts-target-dom-22">Your way to your own solar system.</text>
        </phrase>
        <phrase>
            <text id="ts-target-text-7">more</text>
        </phrase>
        <phrase>
            <text id="ts-target-dom-23">Service</text>
            <text id="ts-target-dom-24">Our service for customers and partner.</text>
        </phrase>
        <phrase>
            <text id="ts-target-text-8">more</text>
        </phrase>
        <phrase>
            <text id="ts-target-text-9">Product-Highlights</text>
        </phrase>
        <phrase>
            <text id="ts-target-dom-25">DS 1200 block</text>
            <text id="ts-target-dom-26">A semitransparent module for use on roofs and facades.</text>
        </phrase>
        <phrase>
            <text id="ts-target-text-10">more</text>
        </phrase>
        <phrase>
            <text id="ts-target-dom-27">KM 14 mono</text>
            <text id="ts-target-dom-28">A monochrystalline module for mobile use, which provides an optimum protection against hail and high wind speeds.</text>
        </phrase>
        <phrase>
            <text id="ts-target-text-11">more</text>
        </phrase>
        <phrase>
            <text id="ts-target-dom-29">Accum 1.000 L</text>
            <text id="ts-target-dom-30">The optimum storage concept of this energy storage is impressive due to its consistent reduction of all heat losses.</text>
        </phrase>
        <phrase>
            <text id="ts-target-text-12">more</text>
        </phrase>
        <phrase>
            <text id="ts-target-dom-31">NTI hybrid</text>
            <text id="ts-target-dom-32">This unit has an additional tripping protection element against unacceptable mains voltages.</text>
        </phrase>
        <phrase>
            <text id="ts-target-text-13">more</text>
        </phrase>
    </translatable>
</translation-studio>

The header contains a skeleton node which holds a base64 encoded source XML into which the translated texts will be merged prior the import.