LabVIEW Embedded Development Module Target Distribution Guide Manual

LabVIEW Embedded Development Module Target Distribution Guide Manual
Pages 35
Views 310
Downloads : 3 times
PDF Size : 290.7 KiB

Summary of Contents

LabVIEW Embedded Development Module Target Distribution Guide Manual

  • Chapter 5Adding Target-Specific Documentation© National Instruments Corporation5-3 1,Target Distribution 1, Guide•Do not use obscure filenames. Remember that end users can access the PDF files through Start»All Programs»National Instruments»LabVIEW»LabVIEW Manuals, which opens a File Explorer window. Descriptive filenames help end users find the manual they are looking for more easily. Readme Filenaming TipsUse the following guidelines when creating readme files for your target:•Use a naming convention similar to the one that LabVIEW products use. LabVIEW products use readme_PRODUCT.html where PRODUCT is a short name identifying the product. For example, the readme filename for the Embedded Development Module is readme_EMB.html.•Do not use readme.html as the filename. This filename is the LabVIEW development system readme file.Reference and Non-Reference HelpHelp can consist of reference and non-reference documentation. Reference documentation, which also is called functional documentation, provides descriptive information about objects you add to LabVIEW, such as VI reference and dialog box reference topics. Non-reference documentation, which also is called conceptual or task-based documentation depending on the content, provides information about your target and how to use it in LabVIEW. Creating VI ReferenceYou can use LabVIEW to document the target-specific VIs you add to LabVIEW. Create descriptions for VIs to describe the purpose of the VI and to provide instructions for using the VI. The VI description appears in the Context Help window when you move the cursor over the VI icon in the palette or on the block diagram. Complete the following steps to create and edit the description of a VI as well as the VI controls and indicators.1.Select File»VI Properties to display the VI Properties dialog box.2.Select Documentation from the Category pull-down menu.