National Instruments 370769C-01 User Manuals

Table of Contents

• DocumentIt User Guide

  1
• Support

  2
  • Worldwide Technical Support and Product Information

    2
  • National Instruments Corporate Headquarters

    2
  • Worldwide Offices

    2
• Important Information

  3
  • Warranty

    3
  • Copyright

    3
  • Trademarks

    3
  • Patents

    3
  • WARNING REGARDING USE OF NATIONAL INSTRUMENTS PRODUCTS

    3
• Conventions

  4
• Contents

  5
• Chapter 1 Introduction

  7
  • Manual Organization

    7
  • DocumentIt and the Rapid Prototyping Concept

    8
    • Figure 1-1. DocumentIt in the MATRIXx Product Line

      9
  • Automatic Document Generation Process

    10
    • Figure 1-2. DocumentIt Automatic Documentation Generation Process

      11
  • Cruise Control Example

    12
    • Figure 1-3. Cruise Control SystemBuild Diagram

      13
    • Figure 1-4. SuperBlock Properties for Cruise Control Diagram

      14
  • How to Access National Instruments-Supplied Files

    16
  • Related Publications

    17
• Chapter 2 Invoking DocumentIt

  18
  • How to Generate Design Documentation

    18
    • Generating Documentation From Within SystemBuild

      18
      • Platform Specific Differences

        20
      • Template Information

        22
    • Generating Documentation from Xmath

      22
    • Generating Documentation from the OS

      24
    • Generate a Textual Version of a Model

      24
• Chapter 3 Customizing the Generated Documentation

  27
• Appendix A DocumentIt Options

  28
  • Table A-1. Command Options when Invoking DocumentIt

    28
• Appendix B Generating Documents Using FrameMaker

  33
  • Table B-1. FrameMaker Example Files

    34
  • Table B-2. FrameMaker MML Commands

    34
  • Figure B-1. Generic Title Page

    38
  • Figure B-2. Title Page Data in fmgp.tpl and controller_logic_gen.mml

    39
  • Figure B-3. Marking Data for Table Formatting

    41
• Appendix C Generating 2167A Documents Using FrameMaker

  44
  • Table C-1. FrameMaker 2167A Example Files

    45
  • Table C-2. FrameMaker 2167A MML Commands

    45
  • Figure C-1. Generic Title Page

    49
  • Figure C-2. Title Page Data in fmmil.tpl and controller_logic_mil.mm

    50
  • Figure C-3. Marking Data for Table Formatting

    52
• Appendix D Generating 2167A Documents Using Interleaf

  55
  • Table D-1. Interleaf 2167A Example Files

    56
  • Table D-2. Interleaf Markup Commands

    56
  • Figure D-1. Generic Title Page

    60
  • Figure D-2. Title Page Data in ilmil.tpl and controller_logic_mil.doc

    61
• Appendix E Generating Documents Using Microsoft Word

  64
  • Table E-1. Microsoft Word Documentation Example Files

    65
  • Figure E-1. Generic Title Page

    69
  • Figure E-2. Marking Data for Table Formatting

    71
• Appendix F Generating ASCII Documents

  73
• Appendix G Technical Support and Professional Services

  75
• Index

  76
  • Symbols

    76
  • A-D

    76
  • E-I

    77
  • K-U

    78
  • W

    79