genToolboxHelp

Generate a Matlab help for a custom toolbox based on HTML
87 descargas
Actualizado 9 sep 2015

Ver licencia

This script generates a Matlab F1 help for a custom toolbox. It will run through all subfolders of the selected ToolBoxPath directory and create a Contents.m file in each subfolder containing .m files. It will then publish all .m files to .html files and place them in a hierarchical folder structure in a 'ToolBoxPath\Help\ToolBoxName' folder. If the respective .m file has already been published and was not changed since then, the html file will not be updated. The programm will proceed and create a hierarchical 'ToolBoxPath\Help\helptoc.xml' file listing the new help structure as well as 'ToolBoxPath\info.xml' file required by the Matlab help (see also http://de.mathworks.com/help/matlab/matlab_prog/display-custom-documentation.html). The help files can be accessed through Matlabs internal help via F1 - Supplementary Software - ToolBoxName. A GettingStarted.m file is created in the 'ToolBoxPath' folder which can be filled with nicely formatted content according to http://de.mathworks.com/help/matlab/matlab_prog/marking-up-matlab-comments-for-publishing.html that serves as a homepage for the F1 help.

Citar como

Johannes Milvich (2024). genToolboxHelp (https://www.mathworks.com/matlabcentral/fileexchange/52932-gentoolboxhelp), MATLAB Central File Exchange. Recuperado .

Compatibilidad con la versión de MATLAB
Se creó con R2014b
Compatible con cualquier versión
Compatibilidad con las plataformas
Windows macOS Linux
Categorías
Más información sobre Adding custom doc en Help Center y MATLAB Answers.
Agradecimientos

Inspirado por: rdir.m

Community Treasure Hunt

Find the treasures in MATLAB Central and discover how the community can help you!

Start Hunting!
Versión Publicado Notas de la versión
1.0.0.0

Removed input arguments from title