Chapter 1. Model Documentation Test

Table of Contents

1.1. Test Signals
1.2. Processing
1.3. Output

DocAtSourceTest shows the principle features of the Doc@Source toolbox when used as a stand-alone product away from @Source, another product from Podium Technology.

Doc@Source provides a number of blocks:

  1. DocBlock: Contains formatted HTML text, when opened, a full functional HTML editor is opened, which is how this text was entered.  The editor offers:
    • Bulleted lists
    • Numbered lists
    • Bold, Italic, Underlined text
    • Font selection
    • Coloured text
    • Left, right and full justified paragraphs
      • Indenting
    • Tables
    • Tags for whether text is destined to be in-lined, a new node in the section numbered (1.2.3 xxx etc.), for the appendices or just technical documents.
  2. TitleBlock: Contains the core information that should be placed on the title page.
  3. Include Doc: Includes external documents into the generated document
  4. No Snapshots: Block to inhibit snapshots of certain systems from being taken.

Doc@Source provides several additional Report Generator components:

  1. System loop in the correct heirachy of the model.
  2. Insertion of formatted text into the report.
  3. Library Link filter - to prevent walking down unnecessary libraries.
  4. Ability to extract title, author etc from a block placed in the model.  This ensures that report templates do not have to change unnecessarily.
  5. Ability to link in the final appearance of HTML documents through the association of style sheets and the entry of information for headers and footers.
  6. Detailed snapshot.  Simulink system snapshots can be coarse compressed JPEG versions of the original system - essential if it is to fit onto a screen in a HTML document, but not good to print.  Therefore a block is offered that generates a PDF document of the systems so that the reader has the option of a non-compressed view of the system for printing or inspection.
  7. Inclusion of links to external documents.  Documents are copied to the report directory and a short description can be placed in the source document.
  8. Parent Link: Hyperlink/reference to the parent so that navigation up the model is possible as well as down the model.
  9. Reference date tags for highlighting the text (signals and parameters) that have changed since the last version/release of the model.

 

This document describes the process in detail

Link To Another Document

1.1. Test Signals

Parent: DocAtSourceTest

This sub-system shows the generation of the test signals.  The presence of a green documentation block can define a section node or just be some in-line text at what ever the section level the parent block is at.