Documentation Center

Creating a new context-sensitive help button

To create a new context-sensitive help button, create a topic for the button to point to and add the button to the skin.

Procedure

  1. Create a topic, say, MyCustomTopic.html in the templates\FullSupport\httpdocs\help\ subdirectory of the LiveContent S1000D home directory.
  2. Navigate to your collection directory.
  3. Open wietmsd_prg.xml. This file maps context-sensitive help buttons (identified by an ID) to topics: clicking the button displays the topic.
  4. Add the following:
    <configitem name="help.XXXX">
      <comments>My custom button description</comments>
      <value>/help/MyCustomTopic.html</value>
    </configitem>
    where
    • XXXX is a unique ID of the help button you want to add
    • My custom button description describes the button and its use (for internal use only)
    • MyCustomTopic.html is the topic file you created.
  5. Save and close wietmsd_prg.xml.
  6. Add the following code to your skin file (for example, the default skin.css) to display the button in the user interface.
    <img style="display:none" class="link" cvHelpButton="1"
    src="@APPNAME@?target=resource&action=image&file_name=help.gif"
    onclick="CVPortal.helpFactory().showHelp('XXXX')"/>

    where XXXX is the ID of the help button you just configured. If you want to change the appearance of the help button, replace help.gif with the name of your custom help button image file.