Localizing the Help

To localize the online help:

  1. Download .zip archives with online help documentation from Parallels Pro Control Panel Documentation page: http://www.parallels.com/en/pro/docs.
  2. Unzip the archives to your local directories and translate all text in .htm files.

    Note: Some .htm files are generated for navigation purposes and don't need to be translated.

    Note: to make the Search option in the Online Help index page work in your language, you need to translate the English text in the Pages array in the dhtml_search.js files.

After the translations have been done, copy the Help files to the online Help document root folder and package the files into a tarball or an RPM.

To package an online Help tarball:

  1. Create a folder where you want to store the Help files for each Help level under the online Help document root folder /usr/share/doc/webppliance-docs-<version>/<lang>.

    For example, you may create the following folders for each Help level.

    Server Administrator: /usr/share/doc/webppliance-docs-<version>/<lang>/appliance

    Reseller: /usr/share/doc/webppliance-docs-<version>/<lang>/reseller

    Site: /usr/share/doc/webppliance-docs-<version>/<lang>/site

    User: /usr/share/doc/webppliance-docs-<version>/<lang>/user

  2. Copy the translated Help files to the corresponding Help folders.
  3. Create a file, for example localization_help.txt, containing the Help folders. The file should be a text file listing the absolute path for each folder, one folder per line.

    Example:

    /usr/share/doc/webppliance-docs-10.3.1/es_ES/appliance

  4. Package the online Help files into a tarball (.tar.gz). The convention used for naming the tarball or the RPM is: webppliance-docs-<lang>-<version>-<release>.tar.gz or webppliance-docs-<lang>-<version>-<release>.i386.rpm.

    Please ensure that the tarball or RPM contains all the files located at /usr/share/doc/webppliance-docs-<version>/<lang>/.

    For example, if you are packaging the online Help for Parallels Pro Control Panel 10.3.1 for the Spanish locale (es_ES), then the tarball or RPM must include all the files within the folder /usr/share/doc/webppliance-docs-10.3.1/es_ES/.

    tar -zcvf webppliance-docs-<lang>-<version>-<release>.tar.gz 'cat localization_help.txt'