Translating Online Help

Files Structure

Online help is presented by 5 sets of files, each designed for displaying to a particular Plesk user and located at a specific folder within LP:

• Administrator (htdocs\locales\lang\help\)
• Reseller (htdocs\locales\lang\help\res\)
• Client (htdocs\locales\lang\help\cl\)
• Domain Administrator (htdocs\locales\lang\help\dl_usr\)
• Mail User (htdocs\locales\lang\help\ml_usr\)

5 different online help systems exist due to the different amount of functionality available to each type of users. In spite of this difference in content, the online help systems are the same in the view of their implementation: All of them are Plesk User's guides compiled of the specific files that build particular structural elements of the guides.

To translate an online help system, you should modify the following files:

1. numerous *.htm files:
   1. <number>.htm (e.g., 33243.htm)

      pages containing the online help contents, displayed in the main (content) frame of the online help window

   2. toc.htm, toc<number>.htm (e.g., toc246135.htm)

      pages containing different states of the Contents tree, displayed in the left frame of the online help window

   3. dhtml_search.htm, index.htm, navigation.htm, tab_search.htm, tab_toc.htm, title.htm

      files that define what is written on the guide structural and navigation parts: Search frame, the guide super heading, navigation links (Next, Previous, etc.), Search and Content links, the guide title

2. *.gif files:

   *.gif images used for online help navigation elements

3. dhtml_search.js

   java script implementing the mechanism of search through the guide

This figure shows the structural elements of the online help system defined by the files listed above.

Translation Tips

The current version of LP Builder does not have an interface designed for translating Online Help. For editing the files that build Plesk help system, we recommend using a WYSIWYG HTML editor which supports working with files in UTF-8. Using such editor makes the process of translation more comfortable because it

• lets you concentrate on modifying the help content without the necessity of separating it from the HTML syntax;
• prevents you from modifying anything besides the help content, which guarantees that the files will not be corrupted somehow.

Important: Do not change the files encoding, it must be UTF-8. Otherwise, the texts you translated may be displayed incorrectly.