Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 3.05 KB

README.md

File metadata and controls

49 lines (33 loc) · 3.05 KB
Raw

RapidMiner Language Pack Template

A template project for creating a RapidMiner Studio language pack.

Prerequisite

  • Requires Gradle 4.10.3+ (use the Gradle wrapper shipped with this template or get it here)

Getting started

  1. Clone the language pack template

  2. Change the language pack settings in build.gradle (e.g. replace 'EN' by the desired language descriptor; you can find supported language locales here. Simple locales like 'EN', 'IT' or 'DE' are allowed as well)

  3. Change how much you want to translate by changing the i18n_pack settings in build.gradle (currently available: core, supported). Check the comment in build.gradle for an explanation of the available i18n packs.

  4. Change the RapidMiner Studio dependency to a version of your liking (must be at least 9.1.0)

  5. Initialize the language pack project by executing the initializeExtensionProject Gradle task (e.g. via 'gradlew initializeExtensionProject')

  6. Provide your translations in the i18n files (by default) located at /src/main/resources/com/rapidminer/extension/resources/i18n. Look for the files that end with "_<language>". Original texts are provided above each key and are preset as well.

  7. Optionally, add an extension icon by placing an image named "icon.png" (48x48 pixels) in src/main/resources/META-INF/.

  8. Build and install your extension by executing the installExtension Gradle task

  9. Start RapidMiner Studio and check whether your extension has been loaded and change the language setting to check your translation after a restart

Sharing your translations

To share your language pack with all RapidMiner users, you can register your extension on the RapidMiner Marketplace. The information that you will need are the following

  • Product Name: The name of your language pack.
  • Product ID: You will need to provide the ID as follows rmx_language_pack_, where the lang placeholder is your language with all separators (like dash "-" and underscore "_") removed and all lower case.
  • A short description of the language pack

You can also set the development stage of your translation and provide a website link if you like.

Resetting extension

You can use the reset Gradle task to reset the extension to its pre-initialized state and start from scratch.

NOTE: This will delete all classes and resources etc-. Be mindful before using this task.

Notes and limitations

  • Not all extensions have proper i18n; e.g. Auto Model/Turbo Prep have a lot of hard coded text
  • New HTML views might not allow translations
  • Operator help xmls cannot be translated at the current state (9.7)
  • Tutorials and Templates cannot be translated at the current state (9.7)
  • Open Sans is the hard coded font in several places. Since this font does not include all UTF8 characters, users would need a modified font installed