TFMLhelp

Processing on-line help

  • File types: on-line help (see below)
  • Number of Handoffs: Generally 2
  • 1st after Code freeze
  • 2nd after last RC Go/No Go

Process

Time Allotment Task Comments
Pre-processing of translation see below
2000 words per day per person Translation Translation of new/updated contents
1000 words per hour Linguistic Review Reviewed by linguists or language leads for language accuracy
1000 words per hour Technical Review Reviewed by engineers or developers for technical accuracy
Fixing Translators fix the translations and Translation Memory based on feedback from linguistic and technical reviews
Post-processing of translation see below
Integration into the source tree Integrate NetBeans repository
Verification in the build Check the translated TOC and contents in the build
File bugs and fix


NetBeans on-line help structure

NetBeans on-line help is based on JavaHelp System. It contains some XML files and many HTML files.

File Description
Help set file XML file and .hs is a suffix to identify. The main configuration file for the Help
Map file XML file. The filename is defined in the .hs file. The symbol definition for all the help contents to be linked from TOC
TOC file XML file. The filename is defined in the .hs file. Table of contents (XML)


Example: usersguide module in NetBeans

Directory in the repository usersguide/javahelp/org/netbeans/modules/usersguide
Help set file ide.hs
Map file Map.jhm
TOC file ide-toc.xml


Pre-processing of translation

  • Pick up on-line help from the l10n-kit and create.
  • Add charset attribute in all the HTML files as follows:
    {{<meta http-equiv="content-type" content="text/html; charset=UTF-8">
  • Create zip file which includes only the on-line help files.
  • Post created on-line help kit at http://translatedfiles.netbeans.org. (e.g. 6.1 on-line help)

In every release, we post the on-line help l10n-kit into the http://translatedfiles.netbeans.org. When you localize NetBeans on-line help, you can pick up zip file which has the pre-processing already completed by Sun l10n team.


Post-processing of translation

  • Rename the help set file .hs
    The locale suffix needs to be added (e.g. foo_pt_BR.hs)
  • Locate all the localized cotentents to the language sub-directory
  • Localize links in the help contents
Item English on-line help Localized on-line help
Help set file foo.hs foo_${locale}.hs (e.g. foo_pt_BR.hs)
Help directory foo/javahelp/org/netbeans/modules/foo foo/javahelp/org/netbeans/modules/foo/${locale}
e.g. {{foo/javahelp/org/netbeans/modules/foo/pt_BR


Links

You don't have to localize almost all the links in on-line help contents except below:

  • Link to the style-sheet
    All the HTML files in on-line help has a links to the NetBeans common style-sheet:
    nbdocs://org.netbeans.modules.usersguide/org/netbeans/modules/usersguide/ide.css
    The localized on-line help should have a link to localized style-sheet location:
    nbdocs://org.netbeans.modules.usersguide/org/netbeans/modules/usersguide/ja/ide.css
  • Links which is using "nbdocs". The "nbdocs" points the helpset module. In the localized on-line help, localized helpset module should be pointed.
    e.g.
    nbdocs://org.netbeans.modules.tomcat5/org/netbeans/modules/tomcat5/docs/tomcat/tomcat_addinstall.html
    It needs to be localized as:
    nbdocs://org.netbeans.modules.tomcat5/org/netbeans/modules/tomcat5/docs/ja/tomcat/tomcat_addinstall.html

Tools for post-processing

It automates all the needed post-processing.

Usage

  • Download and extract tool zip file
  • Usage is displayed by '-h' option:
   $ bin/jhpost -h
Not logged in. Log in, Register

By use of this website, you agree to the NetBeans Policies and Terms of Use. © 2012, Oracle Corporation and/or its affiliates. Sponsored by Oracle logo