LabVIEW

cancel
Showing results for 
Search instead for 
Did you mean: 

how to create a help file for a VI

I want to create a help file describing my VI. How do i do that by clicking a control. How do I store the help file.
0 Kudos
Message 1 of 7
(4,603 Views)
Hi Mudda;

Assuming you are using Windows, with LabVIEW, you can create the necessary files to create a help file, but you can't create the help file. In order to create your help file, you need a WinHelp compiler.


Also, what LabVIEW allows you to do is to create a file that correspond to the documentation of you VI, so you need to fully document you VIs first.


To document you VI, go to File -> VI Properties and select "Documentation" from the menu. You can access the VI Properties also by Right-clicking the VI icon in the top-right corner of the Window. To document the controls and indicators in your VI, Right-click the control or indicator and select "Description and Tip...".


To create the documentation files, go to File -> Print. At some point
, you will have the option to select a Destination. Select "RTF File" to generate the files a WinHelp compiler understand.


As you will see too, you can also create html files for your VIs. It can be a good alternative for WinHelp files.


There are some nice Help editors outhere. I use HelpScribble. You can see a very simple help file I created with HelpScribble in my small projects VI Background Check and VIs for DeployMaster.


Regards;
Enrique Vargas
www.visecurity.com
www.vartortech.com
0 Kudos
Message 2 of 7
(4,603 Views)
For some reason, the link to HelpScribble got corrupted. The webpage is: www.helpscribble.com
www.vartortech.com
0 Kudos
Message 3 of 7
(4,603 Views)

@Mudda wrote:
I want to create a help file describing my VI. How do i do that by clicking a control. How do I store the help file.


I used HelpSmith for my project (http://www.helpsmith.com/) it works pretty well for me. It creats a .chm files and you can call those .chm files from labview.Also check this thread, may be its a solution for your question.

 

Ankit

 

 

 

0 Kudos
Message 4 of 7
(4,074 Views)

Ankit, I think Igor is just doing some subtle advertising for vigods.com.  The original question is from 2004.  Also, the links all return a 404 Error.

LabVIEW Pro Dev & Measurement Studio Pro (VS Pro) 2019
0 Kudos
Message 5 of 7
(4,057 Views)

@NIquist wrote:

Ankit, I think Igor is just doing some subtle advertising for vigods.com.  The original question is from 2004.  Also, the links all return a 404 Error.


Here is the link again heplsmith

0 Kudos
Message 6 of 7
(4,025 Views)

@Igor_Titov wrote:

@AnkitG, helpsmith is not specifically for LabVIEW, it can't connect "Detailed Help" windows with links, and it's not free. Whereas HELPer can do all this and it's free.


Ohk ...good to know...!!! thanks...!!!

0 Kudos
Message 7 of 7
(4,005 Views)