Documentation Page (VI Properties Dialog Box)

Requires: Base Development System

From the front panel or block diagram window of a VI, select File»VI Properties and select Documentation from the Category pull-down menu to display this page.

Use this page to create VI descriptions and to link from VIs to HTML files or to compiled help files.

This page includes the following components:

• VI description—Contains the text that appears in the Context Help window if you move the cursor over the VI icon. Use <B> and </B> tags around any text in the description you want to format as bold. You also can use the VI Description property to edit the VI description programmatically.

  Note  If you do not provide a VI description for a dynamic child member VI in a LabVIEW class, LabVIEW displays the description for the nearest ancestor class dynamic member VI of the same name, if available.

• Help Used—Indicates whether to link a VI to web-based or local custom documentation from the Context Help window.
  
  If you specify to use web-based documentation, enter the URL of the help file in the Help URL text box.
• Help URL—Contains the URL for the web-based help file you want to link to from the Detailed help link and the Detailed help button in the Context Help window.
• Help path—Contains the path or symbolic path to the HTML file or to the compiled help file you want to link to from the Context Help window. If this field is empty, the blue Detailed help link does not appear in the Context Help window, and the Detailed help button is dimmed. You also can use the Help:Document Path property to set the help path programmatically.

  Note  If you do not provide a Detailed help link for a dynamic child member VI in a LabVIEW class or interface, LabVIEW displays the Detailed help link for the nearest ancestor class dynamic member VI of the same name, if available.

• Help tag—Contains the HTML filename or index keyword of the topic you want to link to in a compiled help file (.chm or .hlp). To link to a bookmark within an HTML file, add # followed by the name of the bookmark to the end of the filename. You also can use the Help:Document Tag property to set the help tag programmatically.
• Browse—Displays the Select a Help File dialog box, from which you can browse to the .chm, .hlp, .htm, or .html file you want to link to. The file path appears in the Help path text box.

You also can use the Help:Document Path property to set the help document path programmatically.