Resource Bundle Plugin

Resource Bundle Plugin requires FarCry 5.1. And its only useful in the context of the proposed i18n changes.

Overview

Provides reporting on i18n requests, and simplifies the process of updating resource bundles

Plugin

rbmanage

Version

1.0

Author(s)

Blair McKenzie

Excerpt

Provides reporting on i18n requests, and simplifies the process of updating resource bundles.

Subversion

http://svn1.cvsdude.com/modius/farcry/plugins/rbmanage/

Status

Beta

The default behaviour of the new i18n functionality is to simply return default values if a key isn't found. This plugin extends that functionality with logging. When installed on your dev machine you gain access to reports on the status of i18n requests in your application.

Do not add this plugin to a production application. It will slow down any page that makes use of translations, particularly the webtop.

The reports provided at the moment are:

  • Missing keys - requests that resulted in the default value (or the value from the base bundle instead of the locale bundle) being returned
  • Unused keys - keys that were never requested
  • Changed defaults - if you have already created resource bundles and have changed the default values in code this report will highlight the discrepencies

Generating the resource bundles is as simple as selecting the bundle (core, plugin, or project) and locale, indicating if the keys should be marked as translated in the bundle and clicking update. These keys should then be saved using "Save Changes". The resulting bundles can then be edited with utilities such as ICU's Resource Bundle Manager.

Changes to resource bundles are not tracked within FarCry. If you are editing your resource bundles, it is advised that changes be managed using a version control system like subversion.

If you are creating resource bundles for an extended type, remember to add them to your project/plugin, not to the origonal

Installation

  1. Add the rbmanage directory to your plugins directory
  2. Add rbmanage to the list of plugins defined in your application.cfm file
  3. Restart the application with ?updateapp=1

Release Notes

No release notes.

Issues