Auto-Documentation of MotoHawk Modules: Difference between revisions
(Created page with ' The AutoDoc library is a very useful tool to document a model. It can be used to capture screen shots of each page of the model. It will also notate all calibration and probe da…') |
No edit summary |
||
| Line 1: | Line 1: | ||
The AutoDoc library is a very useful tool to document a model. It can be used to capture screen shots 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 in a summary generated in 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 screen shot. AutoDoc also gives the user a couple of options to document the model. First is 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. Then 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 screen shots, table of contents, and the calibration, probe, and fault summary excel page. | The AutoDoc library is a very useful tool to document a model. It can be used to capture screen shots 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 in a summary generated in 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 screen shot. AutoDoc also gives the user a couple of options to document the model. First is 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. Then 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 screen shots, table of contents, and the calibration, probe, and fault summary excel page. | ||
The present versions of Autodoc only work on Matlab 2010B and older, they are not yet compatible with Matlab 2011A and newer. | The present versions of Autodoc only work on Matlab 2010B and older, they are not yet compatible with Matlab 2011A and newer.Information on the updated version of Autodoc is at [[Autodoc Update]]. | ||
To download the original version of Autodoc, follow this link [http://www.neweagle.net/support/wiki/files/AutoDocTool_111004.zip MotoHawk AutoDoc]. | To download the original version of Autodoc, follow this link [http://www.neweagle.net/support/wiki/files/AutoDocTool_111004.zip MotoHawk AutoDoc]. | ||
Read this document to learn exactly how to use it: [http://www.neweagle.net/support/wiki/files/Autodoc_writeup_2011.pdf MotoHawk AutoDoc User Manual] | Read this document to learn exactly how to use it: [http://www.neweagle.net/support/wiki/files/Autodoc_writeup_2011.pdf MotoHawk AutoDoc User Manual] | ||
Revision as of 14:42, 11 February 2013
The AutoDoc library is a very useful tool to document a model. It can be used to capture screen shots 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 in a summary generated in 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 screen shot. AutoDoc also gives the user a couple of options to document the model. First is 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. Then 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 screen shots, table of contents, and the calibration, probe, and fault summary excel page.
The present versions of Autodoc only work on Matlab 2010B and older, they are not yet compatible with Matlab 2011A and newer.Information on the updated version of Autodoc is at Autodoc Update.
To download the original version of Autodoc, follow this link MotoHawk AutoDoc.
Read this document to learn exactly how to use it: MotoHawk AutoDoc User Manual