| MAKEHTML | Generate .html function-index page and function help pages composed automatically from formatted Matlab function help messages |
| Usage: | >> makehtml(list, outputdir); >> makehtml(list, outputdir, 'key1', val1, 'key2', val2, ...); |
| Input: | |
list |
(1) List (cell array) of filenames to convert. Ex: {'filename1' 'filename2' 'filename3'} By default, the filename extension .m is understood. (2) Cell array of filenames to convert and the text link on the summary page for them. {{'filename1' 'link1'} {'filename2' 'link2'}} ... Ex: 'link1' = 'Reject by kurtosis'. (3) Cell array of 2 or 3 cell array elements containing info to generate .html function-index and help pages. Ex: { {'directory1' 'heading1' 'dirindexfunc1'} ... {'directory2' 'heading2' 'dirindexfunc2'} } - 'directory': Function file directory name - 'heading': Index-file heading for the directory functions - 'dirindexfunc': A optional Matlab pop-up help function for referencing the directory functions {default: none} (4) To scan several directories under the same heading, use {{{'directory1' 'directory2'} 'heading1' 'dirindexfunc1' ... } |
outputdir |
Directory for output .html help files |
| Optional inputs: | |
'outputfile' |
Output file name. {default: 'index.html'} |
'header' |
Command to insert in the header of all .html files (e.g., javascript declaration or meta-tag). {default: javascript 'openhelp()' function. See help2htm() code for details.} |
'footer' |
Command to insert at the end of all .html files (e.g., back button. {default: reference back to the function-index file} |
'refcall' |
Syntax format to call references. {default is 'javascript:openhelp(''%s.js'')'} Use '%s.html' for an .html link. |
'font' |
Font name (default: 'Helvetica') |
'background' |
Background HTML body section. Include "<" and ">". |
'outputlink' |
Help page calling command for the function index page. {default is 'javascript:openhelp(''%s.js'')'. Use '%s.html' to use a standard .html page link instead.} |
'fontindex' |
Font for the .html index file (default: 'Helvetica') |
'backindex' |
Background tag for the index file (c.f. 'background') |
'mainheader' |
Text file to insert at the beggining of the index page. Default is none. |
'mainonly' |
['on'|'off'] 'on' -> Generate the index page only. {default: 'off' -> generate both the index and help pages} |
| Author: | Arnaud Delorme, CNL / Salk Institute, 2002 |
| Example: | Generate EEGLAB help menus at SCCN: makehtml({ { 'adminfunc' 'Admin functions' 'adminfunc/eeg_helpadmin.m' } { 'popfunc', 'Interactive pop_functions' 'adminfunc/eeg_helppop.m' } { { 'toolbox', 'toolbox2' } 'Signal processing functions' 'adminfunc/eeg_helpsigproc.m' }}, '/home/www/eeglab/allfunctions', 'mainheader', '/data/common/matlab/indexfunchdr.txt'); |
| See also: | help2html |