...
- Follow the instructions in your Web browser's user guide and set the browser's language to a preferred one. For example, in Google Chrome, you set the language using the Settings -> Show advanced settings -> Languages menu.
- Set the browser's encoding type to UTF-8.
Introduction to resource files
- Go to
<AM_HOME>/repository/deployment/server/jaggeryapps/publisher
directory where<AM_HOME>
is the API Manager distribution's home. - There are two types of resource files used to define localization strings in the API Manager.
- The resource file used to store the strings defined in .jag files according to browser locale (For example,
locale_en.json
) is located in.../publisher/site/conf/locales/jaggery
folder. - The resource file i18nResources.json, which is used to store strings defined in client-side javascript files such as pop-up messages when a UI event is triggered, is located in .../publisher/site/conf/locales/js folder.
For example,
To implement localization support for jaggery, we use its in-built script module 'i18n'. For more information, refer to http://jaggeryjs.org/apidocs/i18ndocumentation.jag?api=i18n.
Localizing strings in Jaggery files
- The resource file used to store the strings defined in .jag files according to browser locale (For example,
- To localize the API publisher to Spanish, first localize the strings defined in jaggery files. Create a new file by the name locale_{lolcaleCode}.json inside ...publisher/site/conf/locales/jaggery folder. For example, if the language set in the browser is Spanish, the locale code is es and the file name should be locale_es.json.
- Add the key-value pairs to locale_es.json file. For an example on adding key value pairs, refer to locale_en.json file in ...publisher/site/conf/locales/jaggery folder. It is the default resource file for jaggery.
In addition, a section of a sample locale_es.json file is shown below for your reference.
Localizing strings in client-side Javascript files
- To localize the javascript UI messages, navigate to publisher/site/conf/locales/js folder and update i18nResources.json file with relevant values for the key strings.
- Once done, open the API Publisher web application in your browser (
https:
//<YourHostName>:9443/publisher).
- Note that the UI is now changed to Spanish.