Parallels H-Sphere Documentation Customization Guide

 

Context Help Implementation

 
 

Related Docs:   Template Customization Changing Language of Context Help

Last modified: 28 Dec 2007

 

WARNING: This documentation covers Parallels H-Sphere versions up to 3.1. For the latest up-to-date Parallels H-Sphere documentation, please proceed to the official Parallels site.

Context help (or online help) is implemented through 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 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 ~cpanel/shiva/shiva-templates/common/online_help/. You can create new subdirectories for your files where necessary.
  2. In ~cpanel/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. The easiest way to find the name of the template is view html page source code. The templates you need are located in ~cpanel/shiva/shiva-templates/common/control/. More about templates
  4. Add context help function call to the template. The function call has the following syntax:

    <call draw_help("HELP_ID","LABEL")>

    where HELP_ID is the id of the file specified in ~cpanel/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")>

    In plan creation and edit wizard templates, context help file IDs are passed with resource calls:

    <call service(TAG,PARENT,STRMOD,CAN_ENABLED,OH_ID)>

    where OH_ID is the id of the file specified in ~cpanel/shiva/psoft/hsphere/online_help.xml. For example:

    <call service("asp", "hosting","","1","admin-editwizard-w_asp")>

  5. If the edited template is in *.html.in format, run make in this template's directory.
  6. Restart H-Sphere.

Related Docs:   Template Customization Changing Language of Context Help



© Copyright 2017. Parallels Holdings. All rights reserved.