Autodoc: Difference between revisions

From NewEagleWiki
Jump to navigation Jump to search
(Created page with '=New Eagle Autodoc= ==Overview== Autodoc creates formatted documentation directly in the Simulink model. Autodoc also provides displays units, help text and mototune group of c…')
 
 
(28 intermediate revisions by 4 users not shown)
Line 1: Line 1:
=New Eagle Autodoc=


==Overview==
The AutoDoc library is a very useful tool to document a model. It can be used to capture screenshots of each page of the model. It will also notate all calibration and probe data to both the bottom of the page the blocks are on and to a summary generated in an excel file, which also includes all faults. To use AutoDoc, place the AutoDoc library in the path of your model. Then place the AutoDoc block in each page of the model that you wish to have documented.


==Overview==
[[image:autodocblock.png]]
Autodoc creates formatted documentation directly in the Simulink model. Autodoc also provides displays units, help text and mototune group of calibrations and probes for a given model path page. Autodoc interfaces with Microsoft Word and Excel to capture screen shots, organize a table of contents and creates a calibration probe summary.
 
Double click on the block to bring up a header and borders that denote the page size for the screenshot. AutoDoc also gives the user a couple of options to document the model. AutoDoc can automatically number and order each page of the model or you can do it yourself. You can also modify the title block to include extra information about the model. If there are a lot of calibration and probe blocks on a page, to the point that there is no room for that page and the information, you can have the probe and calibration data printed on a separate page. Once you have everything set up the way you want, just use defined MATLAB commands to generate the output, which includes the screenshots, table of contents, and the calibration, probe, and fault summary excel page.
 
[[image:autodoc1.png]]


== Purchase ==
== Purchase ==
To purchase, please visit our '''[http://store.neweagle.net/]'''
The previous versions of Autodoc only work on Matlab 2010B and older. To download the previous version of Autodoc, follow this link: [http://www.neweagle.net/support/wiki/files/AutoDocTool_111004.zip MotoHawk AutoDoc].


==Support==
==Support==


===Quick Start===
'''Quick Start
See this '''[http://www.neweagle.net/support/wiki/files/Autodoc_writeup_2011.pdf]''' for installation and a quick start user guide.
:'''[http://www.neweagle.net/support/wiki/images/9/98/Autodoc_UserGuide.pdf User Guide]'''
 
<!-- Removed 3-14-23
===Licensing===
'''Licensing
*'''Question''': I upgraded my version of Matlab and Autodoc is not compatible with it **
Q: I upgraded my version of MATLAB, and Autodoc is not compatible with it.
**'''Answer''': Autodoc has been updated with additonal features and is available at the new eagle store.
    A: Autodoc has been updated with additional features and is available at the New Eagle Store.
-->

Latest revision as of 15:38, 14 March 2023

Overview

The AutoDoc library is a very useful tool to document a model. It can be used to capture screenshots of each page of the model. It will also notate all calibration and probe data to both the bottom of the page the blocks are on and to a summary generated in an excel file, which also includes all faults. To use AutoDoc, place the AutoDoc library in the path of your model. Then place the AutoDoc block in each page of the model that you wish to have documented.

Double click on the block to bring up a header and borders that denote the page size for the screenshot. AutoDoc also gives the user a couple of options to document the model. AutoDoc can automatically number and order each page of the model or you can do it yourself. You can also modify the title block to include extra information about the model. If there are a lot of calibration and probe blocks on a page, to the point that there is no room for that page and the information, you can have the probe and calibration data printed on a separate page. Once you have everything set up the way you want, just use defined MATLAB commands to generate the output, which includes the screenshots, table of contents, and the calibration, probe, and fault summary excel page.

Purchase

The previous versions of Autodoc only work on Matlab 2010B and older. To download the previous version of Autodoc, follow this link: MotoHawk AutoDoc.

Support

Quick Start

User Guide