LoginRegisterCommercial SupportContact Us


Documentation > General Documentation > Webtop > System Messages Module

System Messages Module

posted on 8:37 AM, October 16, 2009
system.gif

This plug-in module allows the system administrator to customize system messages that are printed out by various components and plug-ins. System messages are those messages and other strings of text that are "hard-coded". ("Content", on the other hand, refers to text that is stored in the database, and has its own methods for handling other languages.)

The usual application is to translate system messages into alternate languages so that messages, control panels, prompts, errors, and buttons can be "Internationalized". However you can also employ this feature simply to change messages that you don't like.

Versions

ExSite allows for different "versions" of any piece of text or content. Each version has a name (eg. "French"). You use this name to select alternate versions. It is normal to use the native version of a language name, so that it is more recognizable in language selectors to its native speakers. (So, "Français" would be a better way to specify our example.)

Building a message dictionary

Now you should put the system into another language mode so that it will try to use messages in the alternate languages.

Every time the system tries to output a system message in one of your alternate languages, but cannot find an appropriate translation, it falls back on the English version, and logs the message in the message dictionary for the attention of a translator. This means that you simply have to use your system for a while, and it will automatically log for translation every message that sees common usage.

In administrator control panels, failed translations are highlighted like this so you can spot new translatables as they appear. You can add a CSS class "NoTranslation" to your website stylesheet if you would like the same feature on your regular webpages.

Translating

Once you have accumulated a good number of messages in your translation logs, you can use the System Messages plug-in to perform your translations.

Launch the plug-in, select the language/version you want to translate, and it will show you a list of messages that it has tried unsuccessfully to translate into your preferred language. Click on the missing buttons to translate each message.

The translation form shows the default (English) message, with a text area to enter the equivalent in your selected language. After you submit a translation, it will disappear from the list of required translations, and you can move on to another message.

Templated Messages

Some messages contain tags to insert other data. These might look something like this example:

Please contact the system administrator, at [[admin_email]].

That means that some other data (in this case, an email address) will be substituted into the [[admin_email]] position of the message at a later time. When translating such messages, do not translate/change those tags, or the system will not know where to put the data.

Maintenance

The procedure above will identify the most-viewed messages quickly, but some rare messages (especially error messages) will get missed. Over time, ExSite will slowly uncover more of these messages. Whenever a new message is found, it will be displayed in the special style that indicates a missing translation. You can take this as a hint that you or your translator can visit the System Message plug-in to touch-up the translations.

If you ever need to correct or update a translation, simply use the search tool in the System Messages control panel to find the message of interest.

If system messages get changed or updated, they will usually appear as entirely new messages in the dictionary, requiring translation all over again.