Orbeon Search

Comments? Feedback?

This wiki does not yet support public comments (a limitation of Google Sites), so we encourage you to post your comments either:

On Twitter by responding to @orbeon.

On our community mailing list: subscribe sending an email to ops-users-subscribe@ow2.org (content of subject/body doesn't matter), you'll get a response with the email to use to send your message to the community mailing list.

Recent site activity

Localizing Orbeon Forms

Contents

  1. 1 Rationale
  2. 2 Currently supported languages
  3. 3 Files to localize
    1. 3.1 Form Runner and Form Builder resources
    2. 3.2 Calendar resources
    3. 3.3 XBL components
    4. 3.4 Pseudo-XBL components
    5. 3.5 Dates and times
  4. 4 How to localize

Rationale

This document explains how to add a new language to Orbeon Forms.

Currently supported languages

  • English:
    • full
  • French:
    • full
  • Spanish:
    • partial
  • Norwegian:
    • Form Runner, Form Builder, with the exception of the XBL components
  • Russian: full [TODO: a few missing items to document]

Files to localize

Form Runner and Form Builder resources

See these 2 files:
Each file has as series of <resource> elements each with an xml:lang attribute. You need to add your own element. Say you want to localize to Ialian:

<resource xml:lang="it">

You can start by copying an existing <resource> element (for example French).

Calendar resources

See:


Similar idea here, but this is in JavaScript, for client-side calendar support.

XBL components

Orbeon Forms XBL components are located as subdirectories here:


Each subdirectory has a .xbl file with some metadata. For example:


In there, you will notice the localization in English, French, and Russian. Add your own language .

Pseudo-XBL components

Similar to XBL components, XBL files in these subdirectories require localization:


These files are used by the Form Builder toolbox for built-in XForms controls.

Dates and times

For formatting of dates and times, a Java class usually needs to be added. See the example for Norwegian:


How to localize

You can go about this in various ways.

You can just translate all the files and send them to us so we can commit them to github.

But you will want to see the results yourself first. Here you can either work with
  • the source (from github)
  • or a binary build
If working with the source, build Orbeon Forms, localize the files, and test as you go.

If working with a binary build, you can override built-in files by creating your own files under the WAR file's WEB-INF/resources directory:
  • WEB-INF/resources/apps/fr/i18n/resources.xml
  • WEB-INF/resources/forms/orbeon/builder/form/resources.xml
  • WEB-INF/resources/ops/javascript/orbeon/xforms/control/CalendarResources.js
  • WEB-INF/resources/xbl/orbeon/*/*.xbl
  • WEB-INF/resources/forms/orbeon/builder/xbl/*/*.xbl