Translation

From RSSOwl

Jump to: navigation, search

Contents

Introduction

This page outlines the details on how to translate RSSOwl to new languages. If RSSOwl is not translated into your language, you can help out!

  • Upon submission of your completed translation you will get an exclusive free RSSOwl T-Shirt from ooshirts.com

How to Translate RSSOwl

Please only contact me if you can do the translation and are willing to translate ~3200 entries

  1. Again understand that RSSOwl requires 3200 words and sentences to be translated
  2. Send a Mail to Benjamin Pasero with your language to translate
  3. Receive a Zip file with the files to translate if you know you can do it
  4. Follow the instructions below to translate
  5. Take your time for the translation! Quality is more important than speed.
  6. Send the Zip file back to Benjamin Pasero

How to Improve existing Translations of RSSOwl

You might be using a translated version of RSSOwl that is not yet completly translated. In this case you can provide the additional translations to the RSSOwl team easily.

  • Use your favorite subversion client and connect to [1]
  • Check out the two projects org.rssowl.core.nls and org.rssowl.ui.nls for your language
  • Then continue reading this wiki page, it contains all the instructions how to do additional translations and how to test them
  • Note: Various locations in the user interface of RSSOwl are translated through other plugins than the two you downloaded. The additional plugins

are contained in a file called dependencies_*.zip in the org.rssowl.ui.nls plugin.

Translation Editor (Eclipse)

  • Using Eclipse makes it easy to test your translation in RSSOwl
    • But any other Editor can be used too!
  • Install Eclipse 3.7
  • Import the ZIP file that Ben sent you into Eclipse
    • File | Import | Existing Projects Into Workspace | Select Archive File
    • Select all Projects included in the Archive File
    • Finish
  • Note: If you see an error in Eclipse that some bundles are missing after import, this is ok. It just complains that it does not find the RSSOwl source code.
  • Edit the Properties file as described in the Translation Instructions

Translation Editor (Eclipse with TapiJI)

  • TapiJI is an editor on top of Eclipse that helps translating
  • Installation instructions
    • Follow the previous instructions to install Eclipse
    • Select Help | Install New Software
    • Click the Add button
    • Select everything from the list and follow the instructions for installation
    • Eclipse will ask for a restart
    • Restart to finish the installation
    • Open Window | Preferences
    • Go to General | Editors | File Associations
    • Select *.properties or add it if not showing up yet
    • From the list of Associated Editors select ResourceBundle editor and click Default
    • Click OK to close the preferences dialog
  • Now open a properties file from the two projects imported
    • For example plugin.de.properties in org.rssowl.ui.nls.<language>
    • The editor nicely shows the entries in a list or tree structure on the left hand side
    • In the middle you can translate the english words into your language
    • On the bottom you can click on the second tab to see the raw content of the properties file
    • Press Ctrl+S as usual to save your changes
  • Edit the Properties file as described in the Translation Instructions

Translation Instructions

  • If you are not using Eclipse, please ensure to edit the files with UTF-8 encoding
  • Every properties file needs to be translated except for build.properties
    • 23 files in org.rssowl.ui.nls.<language>
    • 13 files in org.rssowl.core.nls.<language>
  • You will translate a total of 3200 entries
    • we apologize that many entries are in fact showing up as duplicates
    • only ~1300 are unique entries
    • make sure to use the same translation for identical words and sentences
  • The following are not needed for translation
    • any entry starting with extension-point.name in the plugin.properties
    • names that refer to a service or company (e.g. Google, Bing, Newsvine)
    • Bundle-Vendor and Bundle-Name in plugin.properties
  • Only translate the right side of a value in the properties file, for example:
    • WebBrowserView_BACK=Back
  • Do not add leading or trailing whitespaces
  • Be consistent with your words across all properties files
  • Short translations are better than long ones
    • Consider keeping an english word if a direct translation is not possible or results in a very long confusing translation
  • Some words contain an ampersand (&) to mark a mnemonic
    • Do not remove the ampersand, its transformed in the UI to an underline if the ALT key is pressed
    • Rather add the ampersand to the beginning of the word you translate
  • Some properties contain \t which indicates a tab-stop character or \n which indicates a newline
    • Do not remove these special character sequences
  • Dynamic content is surrounded by curly brackets so that you can move it around as appropiate, for example:
    • Do you want to delete {0}?
    • {0}: {1}
    • Simply translate anything before and after the curly brackets and move them around so that they fit for your language
  • If you are using a single quote (') together with a curly brackets, it needs to be escaped by using another single quote
    • for example: Download Attachments to ''{0}''
  • Some properties make use of HTML Tags, keep them functional and only translate words inside
    • for example: <a>{0}</a> (<a href="play">Play Now</a>)
  • The tutorial surrounds some words in # or %
    • you also need to translate these words
    • they typically point to a location in the menu so its critical that the translation matches with the menu path
    • you can see it in action pressing F1 from the running application

How to Test your Translation in RSSOwl

  • Export the two projects that you translated to use them in RSSOwl
    • First we have to fix the directory structure of the two projects
      • Move the folder org from src to top level if it is not already top level
      • You can delete the folder src after doing so
      • Open the file build.properties
      • Make sure that all entries have a checkmark for the binary build
      • Save the build.properties
    • Second we hav e ensure the two projects run well in RSSOwl 2.1
      • Open the MANIFEST.MF in each project
      • Find the line starting with Fragment-Host
      • Replace any 2.1.1 or 2.1.2 with 2.1 if you can find it
      • Save both files
    • You also need to Import RSSOwl
      • Download the RSSOwl Source from SourceForge
      • Import the Zip file into Eclipse via File | Import | Existing Projects Into Workspace | Select Archive File
      • Select all Projects included in the Archive File
      • Finish
    • File | Export | Plug-in Development | Deployable plug-ins and fragments
    • Select the two projects (org.rssowl.core.nls.* and org.rssowl.ui.nls.*)
    • Select e.g. your Desktop as Directory for the export
    • Finish
  • Install your translation into RSSOwl
    • Note: If you are not so experienced in Eclipse you can send Benjamin Pasero a mail to bundle a RSSOwl with your translation
      • If you send a mail, don't forget the two projects from the export as attachment
    • Download a fresh RSSOwl 2.1.x from [2]
    • Copy the two JAR files from the Export into the folder "plugins" of the RSSOwl installation
    • Download the language pack for Eclipse in your language
      • Go to [3]
      • Select your language from the links on top
      • Download the entry named BabelLanguagePack-eclipse-<LANG>_3.4.0..
      • Add all files of the plugins folder to the folder "plugins" of the RSSOwl installation
    • Start RSSOwl with parameters: rssowl -clean -nl <ISO Language Code>
      • For example rssowl -clean -nl de (for german)
      • Find guidance how to start RSSOwl with a specific parameter in our FAQ
  • Do not hesitate to contact Benjamin Pasero for any questions

How to Send your Translation back to RSSOwl.org

  • Export the two projects that you translated to use them in RSSOwl
    • File | Export | Plug-in Development | Deployable plug-ins and fragments
    • Select the two projects (org.rssowl.core.nls.* and org.rssowl.ui.nls.*)
    • Select e.g. your Desktop as Directory for the export
    • Finish
  • Send a Mail to Benjamin Pasero with the two projects attached
Personal tools