..:: fubwer documentation ::..

User Manual - Generalities

Welcome to fubwer! This user manual will guide you through the essential features and functionalities of our platform.

Getting Started

• Accessing fubwer: Navigate to our website and log in with your credentials.
• Dashboard Overview: Once logged in, you will see your dashboard, which provides an overview of your projects and recent activity.

Creating a New Project

• New Project Button: Click the -New Project- button on your dashboard.
• Project Details: Enter the name and description of your project.
• Adding Files: Upload your financial documents or translation files - CSV or JSON are supported

Managing Translations

• Translation Editor: Access the online editor to view and edit translations.
• Review and Approve: Review the translated content and approve it when ready.
• Quality Checks: Utilize the built-in quality checks to ensure accuracy.

Translation Workflow & Controls

fubwer allows for a structured translation process with defined phases or stages (like °Draft°, °Review°, °Approved°, °ON°). These stages help track progress and ensure quality.

At fubwer, we can customize these workflows to perfectly match your team specific needs and processes.

Common controls you will encounter:

• Lock Button (): Prevents further edits on a specific translation segment, often used when a translation is finalized or under review by specific roles.
• Edit Button (): Allows you to modify the source text, target translation, or associated notes/context for a segment.
• Add/Edit Components: These are typically forms or input fields that appear when you add a new translation unit or edit an existing one. They provide structured fields for the source text, target language text, context notes, and potentially other metadata relevant to the translation.

Collaboration

• Team Members: Invite team members to collaborate on projects.
• Roles and Permissions: Assign roles and permissions to control access.

Support and Assistance

• Contact Support: If you need further assistance, please contact our support team via the contact form or chat.
• Documentation: Request access to our online documentation for detailed guides and tutorials.

File Formats

XLIFF

What is XLIFF?

XLIFF (XML Localization Interchange File Format) is an industry-standard, XML-based format created to standardize the way localizable data is passed between tools during the localization process. Some people think of it as a common language for translation software and content management systems.

Key benefits:

• Separation: It cleanly separates translatable text from the underlying code or document structure.
• Rich Metadata: It allows embedding context, comments for translators, status (e.g., new, translated, needs review), segment IDs, and more alongside the text.
• Interoperability: It is widely supported by Computer-Assisted Translation (CAT) tools used by professional translators, enabling seamless workflows.
• Structure: Provides defined elements like <file>, <unit>, <source>, and <target> to organize original content and its translation(s).

In essence, XLIFF allows business users and developers to export text content in a structured way, translators to work efficiently using their preferred tools, and developers to easily reintegrate the translated content back into the application.

The XML Localization Interchange File Format developed by fubwer is used for monolingual, bilingual, and multilingual translations.fubwer supports XLIFF enriched with classes of data and translation based on customer bespoke needs.

• Translation flags: Indicate the status or specific attributes of a translation.
• String keys: Must be unique identifiers for each translation unit.
• Context: A short description or note associated with the translation block for clarity.

Example XLIFF

<?xml version="1.0" encoding="UTF-8"?>
        <xliff version="1.2" xmlns="urn:oasis:names:tc:xliff:document:1.2">
            <file original="messages.properties" source-language="en" target-language="de" datatype="plaintext">
                <body>
                <trans-unit id="greeting" resname="greeting">
                    <source>Hello World!</source>
                    <target state="translated">Hallo Welt!</target>
                    <note>A standard greeting message.</note>
                </trans-unit>
                <trans-unit id="farewell" resname="farewell">
                    <source>Goodbye</source>
                    <target state="new">Auf Wiedersehen</target>
                    <note>A standard farewell message.</note>
                </trans-unit>
                <trans-unit id="button.save" resname="button.save" approved="yes">
                    <source>Save Changes</source>
                    <target state="translated">Änderungen speichern</target>
                    <note>Text for the save button.</note>
                </trans-unit>
                </body>
            </file>
        </xliff>
    

<?xml version="1.0" encoding="UTF-8"?>
        <xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" version="1.2">
            <file source-language="en-UK" target-language="de-DE" datatype="plaintext" original="ng2.template">
                <body>
                    <trans-unit id="MURNFRbJvv9ZJjlvGSqb" datatype="html">
                        <sourceLanguage>en-UK</sourceLanguage>
                        <sourceText>hi, how are you?</sourceText>
                        <target>Hallo, wie geht es dir?</target>
                        {/* Corrected typo: Small_talk */}
                        <classification>Small_talk</classification>
                        <createdAt>2020-04-08T09:12:13.867Z</createdAt>
                        <updatedAt>2020-04-09T12:15:16.800Z</updatedAt>
                        <context>Greetings</context>
                        <availableLanguages>it-IT, de-DE</availableLanguages>
                    </trans-unit>
                    {/* ... more trans-unit blocks for other text segments ... */}
                </body>
            </file>
        </xliff>

JSON

JSON format is commonly used for translating applications implemented in JavaScript.fubwer supports several variants of JSON translations:

• Simple key/value files (e.g., used by vue-i18n or react-intl).
• Files with nested keys.
• WebExtension JSON format.
• fubwer enriched JSON with nested dictionaries of data and translation based on customer bespoke needs.

Example JSON

{
        "greeting": {
            "source": "Hello World!",
            "target": "Hallo Welt!",
            "state": "translated",
            "note": "A standard greeting message."
        },
        "farewell": {
            "source": "Goodbye",
            "target": "Auf Wiedersehen",
            "state": "new",
            "note": "A standard farewell message."
        },
        "button.save": {
            "source": "Save Changes",
            "target": "Änderungen speichern",
            "state": "translated",
            "approved": "yes",
            "note": "Text for the save button."
        }
    }