| HELP2HTML | Convert matlab m-file help message header into an html help file |
| Usage: | >> linktext = help2html( filein, fileout, 'key1', val1, 'key2', val2 ...); |
| Inputs: | |
filein |
input filename (with .m extension) |
fileout |
output filename (if empty, generated automatically) |
| Optional inputs: | |
'header' |
command to insert in the header (i.e. javascript declaration or meta-tags). Default none. |
'footer' |
command to insert at the end of the HTML file (i.e. back button. Default none. |
'refcall' |
syntax format to call references. Default '%s.html'. For javascript function uses 'javascript:funcname(''%s.js'')' |
'font' |
font name |
'background' |
baground tag (i.e. ''). Default none. |
'outputlink' |
command to call the generated HTML page. Default is standard HTML href. |
| Output: | |
linktext |
html text link to the output file |
| M-file format: | The following lines describe the header format of an m-file function to allow html help file generation. Characters '-' and ':' are used by the function for parsing. % function_name() - description line 1 % description line 2 % etc. % % Title1: % variable1 - text line 1 % text line 2 % variable2 - text line 1 % etc. % % Title2: % text line 1 [...](see notes) % text line 2 % % See also: % function1(), function2() |
| Notes: | 1) In Title2, the text lines are considered as is (e.g., preserving Matlab carriage returns) unless there is a matlab continuation cue ('...'). In this case, lines are contcatenated. For Title1 with variable's name, all text lines are concatenated by default. 2) The pattern 'function()[,]' is detected It is printed in bold if it's the function descriptor It is used as a web link to another function, but only if the html file 'function.html' exists. 3) If a '.jpg' file with the same name as the function exists, it is inserted into the HTLM file after the function description. 4) Lines beginning by '%%' are not interpreted |