Web XML translation with Crowdin

WebXML is a Crowdin-developed XML format designed for translating data structures that may contain HTML or XML formatting. When uploaded to Crowdin, it presents data structures to linguists with comprehensive context, ensuring they understand how the data is used. High-quality context significantly contributes to achieving optimal translation quality.

Here's a preview of a Web XML file as it appears to linguists in the Crowdin Editor.

Note: To upload Web XML, use the API or CLI and set the file type to "webxml".

Structure

There are no strict requirements for WebXML file structure, but the format follows several key concepts:

Core Requirements

• Must be a valid XML file.

• XML attributes are not visible or translatable. Use them to store ID references or other data required for Web XML conversion.

• HTML or XML content must be either HTML-encoded or enclosed in CDATA sections.

Reserved Attributes

The following attributes are reserved for specific functionality:

• crowdinContext - Provides contextual information for the segment (data inside an XML node).

• crowdinTitle - Specifies a tag name to display in the WYSIWYG editor.

• crowdinKey - Defines a Crowdin Key for the segment from the XML node.

• translatable - Boolean value; Controls whether node value can be translated.

• crowdinType - Defines the parser type to apply for a specific XML node; Enables Crowdin to post-process the node content using the specified parser (e.g., html, json3).

Note: When the crowdinType attribute is used, Crowdin will apply the specified parser type as a post-processing step after the default parser for that node. To use this attribute, content segmentation must be disabled for the Web XML file.

Supported parser types mostly match the type values accepted by the Add File API method, excluding the following: auto, xml, csv, docx, xlsx, dita, idml, mif, svg.

If no version is specified (e.g., json instead of json3), Crowdin will use the latest supported parser version.

File Format Details

Sample File

<?xml version="1.0"?>
<content>
        <anyTagName>
                <text>
                        <![CDATA[
<div style="width: 46%; float: left; padding: 0px 10px 0 0; color: #444; line-height: 20px;">
    <p>
        This is a paragraph with some content for translation. <br />
        Some introductory text before the ordered list:
    </p>
    <ul>
        <li>List item #1.</li>
        <li>List item #2.</li>
        <li>List item #3.<br /></li>
    </ul>
</div>
]]>

                </text>
                <error-page>
                        <error-code>500</error-code>
                        <location>/error500.html</location>
                        <pre>
                This section is preformatted and preserves whitespace and line breaks.
                It's commonly used for displaying code snippets
            </pre>
                </error-page>
                <field_name crowdinTitle="PreviewFieldName" crowdinContext="useful context that linguists should know about" crowdinKey="segment_key" >This is also some content for translation.</field_name>
                <any_tag_name translatable="false">Display but do not translate</any_tag_name>
                <field_json crowdinType="json3" crowdinKey="settings_json">
                        {
                                "buttonLabel": "Submit",
                                "tooltip": "Click to proceed"
                        }
                </field_json>
        </anyTagName>
</content>