LabVIEW Embedded Development Module Target Distribution Guide Manual

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

Summary of Contents

LabVIEW Embedded Development Module Target Distribution Guide Manual

  • Chapter 5Adding Target-Specific Documentation 1,Target Distribution 1,Guide5-2ni.comDocumentation Directory StructureLabVIEW documentation uses the following directory structure:•labview\help contains the help files (.chm) for the LabVIEW products you have installed.•labview\manuals contains PDF documents for LabVIEW products you have installed. Some of the PDF documents also are available in print, and some are available in PDF only.•labview\readme contains the readme files for LabVIEW products you have installed. Readme files usually contain known issues and important last-minute and additional documentation.Documentation Naming ConventionsYour documentation filenames (help, PDFs, and readme files) must have unique filenames. You cannot use the same filename as a standard LabVIEW, LabVIEW module, or LabVIEW toolkit document.Help Filenaming TipsUse the following guidelines when creating help for your target:•Try to make HTML filenames, including the .html extension, 30 characters or less.•Use underscores instead of spaces in HTML filenames and the CHM filename.•Use an identifier to ensure you are not creating HTML filenames that are the same as LabVIEW. For example, HTML filenames in the Embedded Development Module help start with emb_.PDF Filenaming TipsUse the following guidelines when creating PDFs for your target:•Use a naming convention similar to the one that LabVIEW products use. LabVIEW products use PRODUCT_Manual_Title.pdf where PRODUCT is a short name identifying your product. For example, the LabVIEW Embedded Development Module Porting Guide filename is EMB_Porting_Guide.pdf.•Capitalize the first letter of each word in the manual title.•Use underscores for spaces.•Ignore prepositions and conjunctions in the manual title.