Page 3 - Important Information; Warranty; WARNING REGARDING USE OF NATIONAL INSTRUMENTS PRODUCTS
Important Information Warranty The media on which you receive National Instruments software are warranted not to fail to execute programming instructions, due to defects in materials and workmanship, for a period of 90 days from date of shipment, as evidenced by receipts or other documentation. Nati...
Page 4 - Conventions; File»Page Setup»Options
Conventions The following conventions are used in this manual: » The » symbol leads you through nested menu items and dialog box options to a final action. The sequence File»Page Setup»Options directs you to pull down the File menu, select the Page Setup item, and select Options from the last dialog...
Page 5 - Contents
© National Instruments Corporation v DocumentIt User Guide Contents Chapter 1Introduction Manual Organization ..................................................................................................... 1-1DocumentIt and the Rapid Prototyping Concept ...........................................
Page 6 - Index
Contents DocumentIt User Guide vi ni.com Appendix EGenerating Documents Using Microsoft Word Appendix FGenerating ASCII Documents Appendix GTechnical Support and Professional Services Index
Page 7 - Introduction; Manual Organization
© National Instruments Corporation 1-1 DocumentIt User Guide 1 Introduction With SystemBuild and DocumentIt menu options, you can generate high-quality design documentation automatically from SystemBuild block diagrams. This guide provides the information you need to start using DocumentIt, as well ...
Page 8 - DocumentIt and the Rapid Prototyping Concept
Chapter 1 Introduction DocumentIt User Guide 1-2 ni.com • Appendix B, Generating Documents Using FrameMaker , provides a description of how to generate a sample design document using DocumentIt and FrameMaker templates. • Appendix C, Generating 2167A Documents Using FrameMaker , provides a descripti...
Page 10 - Automatic Document Generation Process
Chapter 1 Introduction DocumentIt User Guide 1-4 ni.com Automatic Document Generation Process As an integral part of MATRIXx Rapid Prototyping concept, DocumentIt lets you generate design documentation from a SystemBuild block diagram model quickly, automatically, and without programming skills. Doc...
Page 12 - Cruise Control Example
Chapter 1 Introduction DocumentIt User Guide 1-6 ni.com for a specialized purpose. DocumentIt output in this case is an ASCII text file, which you can use with almost any text editor. You can edit the file or print it as a simple unformatted ASCII file. Typically, the template file contains Document...
Page 13 - Help
Chapter 1 Introduction © National Instruments Corporation 1-7 DocumentIt User Guide Figure 1-3. Cruise Control SystemBuild Diagram The cruise control model consists of the highest-level SuperBlock, two embedded SuperBlocks, and associated units. Figure 1-4 shows the associated SuperBlock Properties ...
Page 16 - How to Access National Instruments-Supplied Files; Variable
Chapter 1 Introduction DocumentIt User Guide 1-10 ni.com System States and Models: This model is enabled and disabled externally. Num Ext. In = 3Num Ext. Out = 1Num SuperBlocks = 3Attribute = DiscreteFrequency = 50.0000 Has Input Data = 1 Similarly, information from all SuperBlock/block dialogs and ...
Page 17 - Related Publications
Chapter 1 Introduction © National Instruments Corporation 1-11 DocumentIt User Guide Related Publications National Instruments provides a complete library of publications to support its products. In addition to this guide, publications (from NI and other sources) that you may find particularly usefu...
Page 18 - Invoking DocumentIt; How to Generate Design Documentation; SystemBuild; Operating system prompt; Generating Documentation From Within SystemBuild; Tools»DocumentIt
© National Instruments Corporation 2-1 DocumentIt User Guide 2 Invoking DocumentIt This chapter tells how to generate documents from SystemBuild, Xmath, and from the operating system prompt. How to Generate Design Documentation Using DocumentIt, you can generate design documentation from: • SystemBu...
Page 20 - Platform Specific Differences; File name
Chapter 2 Invoking DocumentIt © National Instruments Corporation 2-3 DocumentIt User Guide Platform Specific Differences The DocumentIt Generate Documentation dialog has some platform-specific features. Windows SystemBuild uses the standard Windows selection dialog to display an output file name in ...
Page 21 - UNIX; Filter; Directories; Files
Chapter 2 Invoking DocumentIt DocumentIt User Guide 2-4 ni.com UNIX The Generate Documentation dialog uses a standard Motif File Selection dialog to specify the name of the output documentation file in the Selection field. Filter Displays the file selection directory path. Uses standard shell wildca...
Page 22 - Selection; Template Information; Generating Documentation from Xmath
Chapter 2 Invoking DocumentIt © National Instruments Corporation 2-5 DocumentIt User Guide Selection Displays the complete path to the file selected in the Files listing. Because this name is used for both the RTF file and the documentation file, any extensions will be stripped before creating the ....
Page 24 - Generate a Textual Version of a Model
Chapter 2 Invoking DocumentIt © National Instruments Corporation 2-7 DocumentIt User Guide Generating Documentation from the OS If a model file already exists, it is also possible to execute DocumentIt from the operating system prompt. The input file for processing must be a real-time file ( .rtf )....
Page 28 - Options When Invoking DocumentIt; Xmath Option
© National Instruments Corporation A-1 DocumentIt User Guide A DocumentIt Options This appendix provides additional information about invoking DocumentIt. Use this appendix together with Chapter 2, Invoking DocumentIt . Options When Invoking DocumentIt As described in Chapter 2, Invoking DocumentIt ...
Page 30 - Using the autostar.opt File
Appendix A DocumentIt Options © National Instruments Corporation A-3 DocumentIt User Guide Using the autostar.opt File If you invoke DocumentIt with the same options consistently, you can put these options into an options file, eliminating error-prone, repetitive typing each time you invoke Document...
Page 33 - Using Your Own Templates
© National Instruments Corporation B-1 DocumentIt User Guide B Generating Documents Using FrameMaker This appendix provides instructions for using the FrameMaker documentation example. This includes describing how to: • Generate documents and encapsulated PostScript files • Import encapsulated PostS...
Page 34 - Filename; Command
Appendix B Generating Documents Using FrameMaker DocumentIt User Guide B-2 ni.com Table B-1. FrameMaker Example Files Filename Description fmgp.tpl This template file determines what information will be extracted from the model to create an ASCII output file. Additionally, fmgp.tpl embeds FrameMaker...
Page 36 - Generating a Sample Document; Load
Appendix B Generating Documents Using FrameMaker DocumentIt User Guide B-4 ni.com Generating a Sample Document To generate a sample document using DocumentIt and FrameMaker, complete the following steps: Note If you want to generate a document from your own model, follow the same steps given in this...
Page 37 - Typecheck; Changing the Generic Title Page
Appendix B Generating Documents Using FrameMaker © National Instruments Corporation B-5 DocumentIt User Guide 8. With the Block Parameters combo box, select %Vars from Xmath . 9. In the Template File field, specify fmgp.tpl as the template file. 10. Select the Typecheck checkbox. 11. To generate the...
Page 39 - Generating an .eps file from SystemBuild
Appendix B Generating Documents Using FrameMaker © National Instruments Corporation B-7 DocumentIt User Guide Figure B-2. Title Page Data in fmgp.tpl and controller_logic_gen.mml Generating an .eps file from SystemBuild 1. To place an illustration in your FrameMaker document, you must insert an anch...
Page 41 - Putting Information in Table Format
Appendix B Generating Documents Using FrameMaker © National Instruments Corporation B-9 DocumentIt User Guide Putting Information in Table Format 1. Page through the document to ensure it meets your needs. If you have information that you want in table format, complete the following steps, beginning...
Page 43 - File; Original File Name
Appendix B Generating Documents Using FrameMaker © National Instruments Corporation B-11 DocumentIt User Guide 8. Select the fmgpTOC.doc frame. From the File pull-down menu, select Save As . You must specify the identical path and file name as you did in the previous step for your new document file,...
Page 47 - Generating the 2167A Document
Appendix C Generating 2167A Documents Using FrameMaker DocumentIt User Guide C-4 ni.com Generating the 2167A Document To generate the sample 2167A document using DocumentIt and FrameMaker, complete the following steps: Note If you want to generate a document from your own model, follow the same step...
Page 61 - National Instruments Corporation
Appendix D Generating 2167A Documents Using Interleaf © National Instruments Corporation D-7 DocumentIt User Guide Figure D-2. Title Page Data in ilmil.tpl and controller_logic_mil.doc <“Rev”> Revision X.X: November 26, 1999 <“DocTitle”> Software Design Document <“TitlePar1”> For T...
Page 62 - Adding a Plot or SystemBuild Diagram to an Interleaf Document; Custom»Misc»psfilt; psfilt
Appendix D Generating 2167A Documents Using Interleaf DocumentIt User Guide D-8 ni.com Adding a Plot or SystemBuild Diagram to an Interleaf Document 1. To place a plot or SystemBuild diagram in your Interleaf document, complete the following steps: a. Use the hardcopy command to create a PostScript ...
Page 65 - File»Load
Appendix E Generating Documents Using Microsoft Word DocumentIt User Guide E-2 ni.com Generating a Sample Document To generate a sample document using DocumentIt and Microsoft Word, complete the following steps: Note If you want to generate a document from your own model, follow the same steps given...
Page 66 - Generating an .emf file from SystemBuild
Appendix E Generating Documents Using Microsoft Word © National Instruments Corporation E-3 DocumentIt User Guide 7. In the File Name field, enter Controller_Logic.doc . This output file is created in your working directory unless you specify another path. 8. With the Block Parameters combo box, sel...
Page 70 - Insert; Creating Tables
Appendix E Generating Documents Using Microsoft Word © National Instruments Corporation E-7 DocumentIt User Guide Importing Graphics 1. To place an illustration in your document manually, you must insert an anchored frame in the page where you want the figure to appear. You can insert an anchored fr...
Page 71 - Creating a Table of Contents
Appendix E Generating Documents Using Microsoft Word DocumentIt User Guide E-8 ni.com Figure E-2. Marking Data for Table Formatting 1. From the pull-down menu, select Table»Convert Text to Table . When the Convert Text to Table dialog appears, select AutoFormat and select Grid 5 under that. Then lea...
Page 72 - OK
Appendix E Generating Documents Using Microsoft Word © National Instruments Corporation E-9 DocumentIt User Guide 3. Leave all the current settings in the Set Up Table of Contents dialog intact and click OK . Microsoft Word fills up the page with the Table of Contents. As Word lists all items in the...
Page 73 - Generating ASCII Documents
© National Instruments Corporation F-1 DocumentIt User Guide F Generating ASCII Documents This appendix describes how to use the ASCII document example. All ASCII document example files are located in: (UNIX) $CASE/DIT/templates/ascii/general (Windows) %CASE%\DIT\templates\ascii\general The files in...
Page 76 - Symbols
© National Instruments Corporation I-1 DocumentIt User Guide Index Symbols .dac file, 2-2 .emf file, E-1, E-3 .rtf file, 2-1 .tpl file, 2-2 @sb_mangled_name_s@ token, E-5 A As, A-1ASCII document example, F-1documentit, tpl function, F-1 autostar command, options, 2-1, 2-7, A-1autostar.opt, A-3 C cod...
