Online, or context, help pages are special templates, each with a topic header and a body. Context help files are located in the /hsphere/local/home/cpanel/shiva/shiva-templates/common/online_help directory. They have .oh extension and contain the text in HTML format. Context help may be implemented in different languages.

This document explains how to add context help pages to H-Sphere interface.

Procedure

1. Create an online help file and put it anywhere inside shiva/shiva-templates/common/online_help/. You can create new subdirectories for your files where necessary.
2. In shiva/psoft/hsphere/online_help.xml, add an id/file correspondence, where file is the path + name of the context help file, and id is the string that will be used in the template.
3. Find the template where the context help icon will be added. Often, this is a challenging task, because templates include each other in cascade style. Here you may find some tips on finding templates.
4. Add context help function call to the template. Most templates you'll need are located in shiva/shiva-templates/common/control/. The function call has the following syntax:
   <call draw_help("HELP_ID","LABEL")>
   where HELP_ID is the id of the file specified in shiva/psoft/hsphere/online_help.xml, and LABEL is the description used as the title in the html link.
   If the second parameter is left empty, the default text ("Click to get help") is used. For example:
   <call draw_help("admin-emanager-l_availableforsignup","")>
   Alternatively, you can call the function that draws help PLUS gives a link to send a trouble ticket:
   <call draw_tt_help("RESOURCE_ID", "HELP_ID", "LABEL")>
5. If the edited template is in *.html.in format, run make in this template's directory.
6. Restart H-Sphere.