How to translate DocFetcher

  • A preliminary remark: There's quite a lot of text to translate, but it's not all equally important, and partial translations are also welcome. The most important parts are the GUI and the first page of the manual, so focus on these parts if they haven't been translated to your language yet and you don't have time to translate more.
  • The translation of DocFetcher's GUI, manual and website is done completely online. The only requirement is a free registration on the translation site Transifex.com. You can help completing unfinished translations or start new ones.
  • Log into Transifex.com and go to DocFetcher's translation page.
  • On the translation page, either pick a language from the Available Languages list whose translation hasn't been completed yet, or add another language.
  • To add another language, click on the Resources tab at the top, then on one of the resources, and then on the Add new translation link on the right. When adding a language, pick the less specific choice for your language, e.g. Afrikaans (af) instead of Afrikaans (South Africa) (af_ZA).
  • The resources page lists the translatable resources:
    • Resource.properties: The GUI translation.
    • Manual-related files, starting with “Manual:”
    • Website-related files, starting with “Website:”
  • Click on any of these resources, and then on the target language, to start translating. However, before you start, please read the notes below.

GUI translation

  • Refer to this translation help page for further information about specific language strings in the Resource.properties file.
  • Some language strings contain placeholders such as {0} or {1}. These will be filled out dynamically, for example with file paths or filenames.
  • Some language strings contain accelerators, for example &Restore Default. These are used for keyboard navigation in program menus. For example, in the language string &Restore Default the & symbol indicates that the user can press r to select the menu entry Restore Default.
  • Some language strings contain hyperlinks, e.g. <a href="www.google.com">link text</a>. The link text in these hyperlinks should be translated, while the rest of the hyperlinks should be left as is.
  • Pay attention to punctuation: Some language strings end with :, ., ?, and so on. The punctuation should be preserved.
  • Pay attention to uppercase and lowercase.
  • Some language strings contain tabs, e.g. Clipboard… Ctrl+V. The tabs should be preserved. You can enter tabs by clicking on the copy source buttons between the original and the translated strings.
  • You can immediately see what your GUI translation looks like by doing the following:
    • Download the portable version of DocFetcher.
    • Download your translated version of the Resource.properties file from Transifex.com. There should be a link named Download for use if you click on Resource.properties.
    • Rename the translated file to: Resource_XX.properties, where XX is the language code for your language. For example, fr is the language code for French. To determine the language code for your language, refer to this list.
    • Put the file Resource_XX.properties in the folder DocFetcher/lang.
    • Switch your operating system's language to the language of the translation.
    • Start DocFetcher. Now you should see your translation on DocFetcher's GUI.

Manual and website

  • Don't touch the German translations for the manual and website.
  • The manual and website are written in Markdown, a lightweight markup language. Recommended reading on Markdown: Wikipedia article and Markdown basics. All Markdown should be preserved in the translation.
  • There are two special files that are not written in Markdown: Manual: Metadata & Titles and Website: Metadata & Titles. These are so-called properties files which contain, as their names suggest, metadata and page titles for the manual and website, respectively. In these properties files, all lines starting with # are comments for the subsequent line and should be copied verbatim, rather than translated. All other lines are “key=value” pairs, and only the values should be translated, not the keys.
  • To get an idea of what the resulting website will look like after the Markdown has been converted to HTML, go check out the DocFetcher website. To see what the resulting manual will look like, download DocFetcher and open the built-in manual.

What's next?

What happens after translation? Well: Completed translations will be fetched from Transifex.com and included in the next DocFetcher release. Additionally, translations of the website may also be published immediately upon request.

Please inform us of your translation efforts so we can put your name on the credits page (this is because Transifex.com doesn't seem to allow us to get a list of people who have contributed).

Navigation
Print/export
QR Code
QR Code translations (generated for current page)