Home > Articles > Programming > Java

  • Print
  • + Share This
Like this article? We recommend

Like this article? We recommend

Internationalization of the Eclipse Platform (V 1.0)

The focus of this section is not a "how to" for Eclipse internationalization, but rather a review of the version 1.0 implementation and its translation-related build processes. Some of these topics are quite specific to the platform itself and describes processes that are not relevant to developers simply wishing to NL-enable their plug-ins to the platform. This section is aimed at those who wish to understand how the platform was NL-enabled and want to navigate the considerable number of files, subdirectories, and JARs that encompass the translated product.

The Eclipse Platform comes internationalization-ready including the ability to enter double-byte characters and support bi-directional data. It is available in the following languages:

  • Brazilian Portuguese
  • French
  • German
  • Italian
  • Japanese
  • Korean
  • Simplified Chinese
  • Spanish
  • Traditional Chinese

These are collectively referred to within IBM as the group-1 languages.

What and where are the various elements that were translated?

The Eclipse Platform relies on the internationalization framework provided in the Java SDK. Therefore, the bulk of the translatable text is located in *.properties files. But there are other file formats that include translatable information, such as HTML, XML, and bitmaps (summarized in Table 2. Eclipse-specific (non-Java) translatable resources).

Translation is an art, a balance between time, effort, and costs. It takes into consideration how quickly a product evolved and how quickly it needs to reach the market. There are always analyses and give-and-take decisions about what must be translated and what would be nice to translate.

In a nutshell, Eclipse concentrates its translation in three major areas:

  • Plug-ins
  • Online helps
  • Welcome view

The files involved are:

  • *.properties files
  • *.html files and their associated "wiring" files
  • welcome.xml file

Eclipse plug-ins: .properties files

In Eclipse, each product plug-in contains properties files. Translating the plug-in means translating its properties files. There are two main steps in handling the properties files:

Font related .properties files

Each operating system uses a different set of fonts, and some languages have their own set of fonts (most notably the DBCS languages). The operating system suggests a default font, but the page designer's optimal layout is tied to a specific font, so using it may result in poorly formatted pages. To ensure translated text is displayed correctly, the Eclipse Workbench uses a particular set of fonts consistent with each language/operating system combination.


Only those Eclipse Platform developers that are adding support for a new operating system or language will need to create new jfacefonts* property files. Never modify the contents of another plug-in's subdirectory, including the fonts specified in the JFace properties file that come with the Eclipse Platform.

The various Eclipse fonts are defined in the JFace plug-in. You can find the default Eclipse fonts.properties files in:

Location of the default Eclipse fonts.properties files

    org\eclipse\jface\resources\jfacefonts.properties (OS default)

There are four org.eclipse.ui jfacefonts properties files for each language, all stored in the same NL fragment JAR, <eclipse_root>\fragments\org.eclipse.ui.nl1\nl1.jar.

For example, Italy has jfactfonts_it.properties, jfactfonts_linux_it.properties, jfactfonts_windowsnt_it.properties, and jfactfonts_windows2000_it.properties. Spain has jfactfonts_es.properties, jfactfonts_linux_es.properties, jfactfonts_windowsnt_es.properties, and jfactfonts_windows2000_es.properties, etc.

Add support for a new language by copying the base jfacefonts files above, adding a country suffix (such as jfactfont_linux_xx.properties for country code "xx"), and inserting the new jfacefonts files into the NL fragment JAR.

End-user messages.properties files

To translate the plug-ins' end-user messages:

  1. Translate the .properties files.

  2. Convert the properties files from the locally-encoded codepage to the encoding expected by PropertyResourceBundle.

  3. Follow the Java resource naming convention to rename your files with the correct locale (for example, en = English, de = German, fr = French, it = Italian).

  4. Insert the properties file back into the source directory of your NL fragment JAR that you created with the PDE.

The Java resource file naming conventions allow for a language, region, and variant (basename_language_region_variant), however Eclipse only specifies the language in all but three cases (Portuguese, Chinese/China, and Chinese/Taiwan):


PropertyResourceBundle will automatically find the resource file corresponding to the current locale at runtime. For example, an English plugin.properties would initially be copied to plugin_de.properties for German in preparation for translation.

Eclipse online helps: .HTML and .properties files

Eclipse has five online helps. The base language documentation is delivered as plugin-ins in their own subdirectory, and the translated versions are delivered as plug-in fragments. The "documentation" plug-ins are located as follows:

Table 1. Location of Eclipse documentation plug-ins

Online help


Workbench User Guide


Java Development User Guide


Platform Plug-in Developer Guide


JDT Plug-in Developer Guide


PDE Guide


The plug-in manifest file, plugin.xml in each of the above directories, defines the help contributions. The necessary help infoset and wiring files are defined in the same directory. To translate the online help:

  1. Translate the doc.properties file of each online help.

  2. Convert the translated doc.properties from the locally-encoded codepage and rename according to locale-specific resource file naming convention.

  3. Insert the properties file back into the source directory of your NL fragment JAR that you created with the PDE.

  4. Translate the *.html files of the online help.

  5. Put the translated .html into the corresponding plug-in fragment directory.

If you translate the online help into more than one language, you must create a language directory structure to hold your country-translated HTML. These files are not locale-sensitive like property files, and thus must keep their original file name and extension. To differentiate, for example, the set of Japanese .html files versus those in German, you must save them under a different directory name, each one representing a country.

For example, the German set of Workbench User Guide *.html files are stored in eclipse\fragments\org.eclipse.platform.doc.user.nl1\nl\de. The Japanese welcome.xml is in eclipse\fragments\org.eclipse.platform.doc.user.nl1\nl\ja.

Eclipse's "Help > Welcome" menu choice: welcome.xml file

The welcome.xml is the introductory view that is displayed when the Workbench first opens or when the user selects Help > Welcome. It is located in eclipse\plugins\org.eclipse.sdk_1.0.0.

Here are the steps to translate the welcome.xml file:

  1. Translate the welcome.xml file.

  2. Save the translation in UTF-8 format (using Notepad, for example). If you forget to save it in UTF-8, the XML parsing code will display an error if it encounters an accented character (that is, a codepoint that isn't part of the UTF-8 codepage).

  3. Just like the .html files, if you translate the welcome.xml into many languages, you will need to save each welcome.xml under a locale-specific directory name. For example, the German welcome.xml is in eclipse\fragments\org.eclipse.sdk_1.0.0\nl\de, and the Japanese welcome.xml is in eclipse\fragments\org.eclipse.sdk_1.0.0\nl\ja..

  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020