Publish markup vs. Contents.m - Custom help generation
조회 수: 2 (최근 30일)
이전 댓글 표시
Hi there,
I use to markup my functions in a way that the Contents.m file of a folder and the quickhelp show the correct 'brief explanation' only:
function out = testFun(in)
%%TESTFUN Brief explanation
% Long explanation
end


However, I also want to publish the function to a nicely looking HTML file using the build-in publish() command of Matlab.
publish(testFun.m,dir,'evalCode','false')
With the markup chosen above, the HTML file has no proper heading but instead starts with the Contents tab listing all sections (%% SECTIONS).

That itself might not hurt so much, but if I create a searchable database using the info.xml/helptoc.xml plus the published HTML files of the functions Custom documentation via
builddocsearchdb(dir)
searching for functions is a mess because the results always give out the heading - being 'Contents' for all published files since there is no leading heading in the way I marked up the functions (remember: That markup is required to get the correct Contents.m/Quickhelp description).
My question is if there is a proper markup that gives both:
- A correct brief function description and Contents.m entry
- A heading in the published HTML file with the name of the function only
Best, Johannes
댓글 수: 0
채택된 답변
James Wiken
2015년 8월 20일
Hi, I work for MathWorks. It looks like the feature you are asking about does not currently exist. I have forwarded this idea to our developers. They will take it under consideration for future versions of MATLAB.
추가 답변 (0개)
참고 항목
카테고리
Help Center 및 File Exchange에서 MATLAB Report Generator에 대해 자세히 알아보기
Community Treasure Hunt
Find the treasures in MATLAB Central and discover how the community can help you!
Start Hunting!