Create a language package from blank


WordFrame Integra is a uni-language system. This means that one application can use only one language to translate its resources. Having one Integra page translated in many languages is not supported, and multilingual sites are implemented as a number of localized sites, but each of this sites is uni-language.

If you want to localize the WordFrame Integra platform or one of its components, you will have to create a Language package dedicated to the target language. Contrary to the UI and webframe packages, the creation of a new language package almost always is a customization of already existing one. This is required as the language pack is tightly integrated with the application it supports. The language resource keys from the language XML file should correspond to the ones used during the applications development. So the only thing we could change is to customize the values for each key.

These keys are later used by two functional tags substituted during the page render process: {{translate:key}} and {{snippet: key}}. The difference between the two is just whether they are substituted in textareas or not (the HTML editor is also considered as a textarea)

1. Create the required package contents

Create the required files and folders. More about the wfpack.* files you can learn on this page.

The standard folder structure of the Language package look like this:

  • (the xml file with the pack meta details)
  • wfpack.signature (the pack integrity signature and vendor public key)
  • repository (the pack contents stored as .zip archive in the pack)
    • language_pack.xml (the language resource keys and values)

2. language_pack.xml

This is the file that holds the list of the language keys and their corresponding translations. If a translate enabled language resource is not found in the applied language package, the system will still present the text of the key which value is missing. An example of the file contents is provided bellow:

<?xml version="1.0" encoding="UTF-8"?>
	<key> <![CDATA[followed_by_username_is_required]]> </key>
	<value> <![CDATA[The field "Followed by username" is required]]> </value>

3. Build the new UI package

To build the newly customized UI package and sign it for distribution you need to use the Wordframe Integra packaging tool. The specifics in the language package type is that you have only one file in the repository folder - the language_pack.xml