Rhetos.I18NFormatter 6.0.0

I18NFormatter

I18NFormatter is a plugin package for Rhetos development platform. It enables localization of Rhetos applications, using message format compatible with https://github.com/turquoiseowl/i18n.

Note that turquoiseowl/i18n currently supports only .NET Framework, and cannot be used directly in a Rhetos v5 app or later:

1. You can still use turquoiseowl/i18n if you have the localization implemented in a separate "frontend" app, for example on ASP.NET MVC, that acts as a proxy for Rhetos REST services. In that case, add Rhetos.I18NFormatter package to the Rhetos app in order to make its messages formatted for localization that occurs in the frontend app.
2. If you want localization implemented directly in the Rhetos app, instead of I18NFormatter package and turquoiseowl/i18n, use any ASP.NET Core localization utility, by configuring Rhetos host with .AddHostLocalization().
   • To use localization with "PO files" (compatible with turquoiseowl/i18n), see Microsoft's recommendations for OrchardCore, and the usage example in Rhetos tutorial: Adding localization.
   • If migrating from turquoiseowl/i18n to OrchardCore, you will need to replace the message parameters in .po files: from %0, %1, ... to {0}, {1}, ...

Features

This plugin formats the Rhetos response messages for end users (for example, a data validation error message) in a specific format to allow the translation of the message by a GetText / PO localization plugin for ASP.NET applications: https://github.com/turquoiseowl/i18n.

For example, the message "Required property {0} is not set", with a parameter value "Name", is reformatted as "[[[Required property %0 is not set|||Name]]]".

GetTranslatableStrings.exe

A command-line utility for extracting translatable strings from the source files. It can be used on generated object model (ServerDom.cs) to extract error messages from miscellaneous business validation.

Installation and configuration

Installing this package to a Rhetos application:

1. Add 'Rhetos.I18NFormatter' NuGet package, available at the NuGet.org on-line gallery.

How to contribute

Contributions are very welcome. The easiest way is to fork this repo, and then make a pull request from your fork. The first time you make a pull request, you may be asked to sign a Contributor Agreement. For more info see How to Contribute on Rhetos wiki.

Building and testing the source code

• Note: This package is already available at the NuGet.org online gallery. You don't need to build it from source in order to use it in your application.
• To build the package from source, run Clean.bat, Build.bat and Test.bat.
• For the test script to work, you need to create an empty database and a settings file test\TestApp\ConnectionString.json with the database connection string (configuration key "ConnectionStrings:RhetosConnectionString").
• The build output is a NuGet package in the "Install" subfolder.