Chapter 1. Model Documentation Test
--svglink--sl-blk-4.00097656250000--svglinkend--
--svglink--sl-sys-5.00097656250000--svglinkend--
--svglink--sl-sys-6.00097656250000--svglinkend--
--svglink--sl-sys-7.00097656250000--svglinkend--
--svglink--sl-sys-14.00097656250000--svglinkend--
--svglink--sl-sys-37.00097656250000--svglinkend--
--svglink--sl-sys-38.00097656250000--svglinkend--
--svglink--sl-sig-68.00097656250000--svglinkend--
--svglink--sl-sig-69.00097656250000--svglinkend--
--svglink--sl-sig-63.00146484375000--svglinkend--
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:
- 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
- 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.
- TitleBlock: Contains the core information that should be placed on the title page.
- Include Doc: Includes external documents into the generated document
- No Snapshots: Block to inhibit snapshots of certain systems from being taken.
Doc@Source provides several additional Report Generator components:
- System loop in the correct heirachy of the model.
- Insertion of formatted text into the report.
- Library Link filter - to prevent walking down unnecessary libraries.
- Ability to extract title, author etc from a block placed in the model. This ensures that report templates do not have to change unnecessarily.
- 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.
- 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.
- Inclusion of links to external documents. Documents are copied to the report directory and a short description can be placed in the source document.
- Parent Link: Hyperlink/reference to the parent so that navigation up the model is possible as well as down the model.
- 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
--svglink--sl-blk-39.00097656250000--svglinkend--
--svglink--sl-sys-40.00097656250000--svglinkend--
--svglink--sl-blk-41.00097656250000--svglinkend--
--svglink--sl-blk-42.00097656250000--svglinkend--
--svglink--sl-blk-43.00097656250000--svglinkend--
--svglink--sl-sig-81.00097656250000--svglinkend--
--svglink--sl-sig-79.00097656250000--svglinkend--
--svglink--sl-sig-80.00097656250000--svglinkend--
--svglink--sl-sig-80.00097656250000--svglinkend--
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.