Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

Linking Subpalettes to HTML Files or Compiled Help Files

LabVIEW 2013 Help

Edition Date: June 2013

Part Number: 371361K-01

»View Product Info

If you link a subpalette on the Controls and Functions palettes to an HTML file or to a compiled help file, a link to that file appears in the Context Help window when you move the cursor over the subpalette icon or when you move the cursor over an open area of the subpalette.

Complete the following steps to link a subpalette to an HTML file or to a compiled help file.

  1. Select Tools»Advanced»Edit Palette Set to display the Edit Controls and Functions Palette Set dialog box.
  2. Right-click the subpalette and select Edit Palette Documentation from the shortcut menu to display the Palette Documentation dialog box.
  3. Click the Browse button.
  4. Navigate to the .chm, .hlp, .htm, or .html file you want to link to and click the Open button. The file path appears in the Help Path text box.
  5. If Help Path contains a path or symbolic path to a .htm or .html file, LabVIEW ignores the Help Tag text box. If Help Path contains a path to a compiled help file (.chm or .hlp), use the Help Tag text box to link the subpalette to a specific topic in that help file:
    • For .chm files, you can enter a .htm or .html filename or an index keyword in the Help Tag text box. The .htm or .html filename must match the name of an individual, uncompiled HTML file in the HTML Help project. The index keyword must match a keyword in the index of the HTML Help project. To link to a bookmark within an HTML file, add # followed by the name of the bookmark to the end of the filename.

      If you want to link to a .chm file on Windows and link to the uncompiled HTML files on Mac OS X and Linux, enter the HTML filename in the Help Tag text box. (Windows) LabVIEW links to the HTML file inside the .chm file. (Mac OS X and Linux) LabVIEW links to the HTML file, which must be in the help\html\help.chm directory, where help.chm is the .chm filename you entered in the Help Path text box in step 4.
    • For .hlp files, you can enter an index keyword in the Help Tag text box. The index keyword must match a keyword in the index of the WinHelp or HyperHelp project.
  6. Click the OK button.
  7. Click the Save Changes button in the Edit Controls and Functions Palette Set dialog box to open the Preview Palette Changes dialog box and save the changes. When you move the cursor over the subpalette icon or over an open area of the subpalette, a blue Detailed help link appears in the Context Help window, and the Detailed help button is enabled.
  8. Click the blue link or the Detailed help button in the Context Help window to test the link from the subpalette to the HTML or compiled help file.

 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit