Generating Text Documentation for VIs, Templates, and Objects

LabVIEW 2018 Help


Edition Date: March 2018
Part Number: 371361R-01
View Product Info

DOWNLOAD (Windows Only)


LabVIEW 2016 Help
LabVIEW 2017 Help
LabVIEW 2018 Help
LabVIEW 2019 Help
LabVIEW 2020 Help

Complete the following steps to generate text documentation for a VI, template, or object.

Note  This method produces only the text sections of documentation, such as the description and revision history of a VI. It does not include graphics.
  1. Open any VI, control, global variable, or template file and select File»Print to display the Print dialog box.
  2. In the Select VI(s) page of the Print dialog box, select whether you want to generate text documentation for the current VI or for multiple VIs. If you selected Multiple VIs, click the Next button to display the Select VIs page and select the files for which you want to generate text documentation.
  3. Click the Next button to display the Print Contents page.
  4. Select the components you want to include in the documentation. If you select VI documentation, click the Next button to display the VI Documentation page and select the components you want to include in the documentation.
  5. Click the Next button to display the Destination page.
  6. Select Plain text file and click the Next button to display the Plain Text page.
  7. Place a checkmark in the Limit text per line to checkbox to specify the number of characters that appear on each line of text.
  8. Click the Save button to display a file dialog box. The dialog box prompts you to name the text file and select the directory where you want to save the file. The default name of any text documentation is the name of the VI with a .txt extension.

You also can use the Print:VI To Text method to generate VI documentation in text format programmatically.

WAS THIS ARTICLE HELPFUL?

Not Helpful