📄 help2html.m
字号:
% help2html() - Convert a 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 (e.g., % back button). {default: none}. % 'refcall' - syntax to call references. {default: '%s.html'} For% javascript function uses 'javascript:funcname(''%s.js'')'% 'font' - font name% 'background' - background tag (i.e. '<body BACKGROUND="img.jpg">'). % {default: none}.% 'outputlink' - html command text to link to the generated .html page. % Must contain two '%s' symbols to the function title % and to the function link.% Ex: ... href="%s.html" ... {default: standard .html href}. % 'outputtext' - Text used in the outputlink. {default: the function% name}% 'outputonly' - ['on'|'off'] Only generate the linktext {default: 'off'}%% Output:% fileout - .html file written to disk% 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% explicitly by the function for parsing.% %% function_name() - description line 1 %% description line 2 %% etc. %% %% Title1: %% descriptor1 - text line 1 %% text line 2 %% descriptor2 - [type] text line 1 %% "descriptor 3" - text line 1 (see notes) %% etc. %% %% Title2: %% text line 1 [...](see notes) %% text line 2 %% %% See also: %% function1(), function2() % % Author: Arnaud Delorme, Salk Institute 2001%% Notes: 1) The text lines below Title2 are considered as is (i.e.,% preserving Matlab carriage returns) unless there is a % Matlab continuation cue ('...'). In this case, lines are % contcatenated. As below 'Title1', all text lines following% each descriptor (i.e., single_word followed by '-' or '='% or multiple quoted words followed by a '-' or '=') % are concatenated. % 2) The pattern 'function()' is detected and is printed in bold % if it is the first function descriptor. Otherwise,% it is used as a web link to the .html function file % 'function.html' if this exists.% 3) If a 'function.jpg' image file (with same 'function' name) exists, % the image is inserted into the function .html file following % the function description. If the .jpg file is absent, the function% checks for the presence of a .gif file.% 4) Lines beginning by '%%' are not interpreted and will be printed as is.% 5) if [type] is present in a "descriptor2 - [type] text line 1"% type is bolded.%123456789012345678901234567890123456789012345678901234567890123456789012% Copyright (C) 2001 Arnaud Delorme, Salk Institute, arno@salk.edu%% This program is free software; you can redistribute it and/or modify% it under the terms of the GNU General Public License as published by% the Free Software Foundation; either version 2 of the License, or% (at your option) any later version.%% This program is distributed in the hope that it will be useful,% but WITHOUT ANY WARRANTY; without even the implied warranty of% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the% GNU General Public License for more details.%% You should have received a copy of the GNU General Public License% along with this program; if not, write to the Free Software% Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA% $Log: help2html.m,v $% Revision 1.21 2003/03/06 01:32:51 arno% header typo%% Revision 1.20 2003/02/17 02:51:36 arno% max image size set to 600 instead of 400%% Revision 1.19 2003/02/17 02:39:57 arno% debug feature and document%% Revision 1.18 2003/02/17 02:36:15 arno% do not force image size to 400 if less than 400%% Revision 1.17 2003/02/17 02:25:10 arno% documenting new features%% Revision 1.16 2003/02/17 02:19:14 arno% including gif images now. Also new format%% Revision 1.15 2002/09/07 23:08:28 scott% help msg -sm & ad%% Revision 1.14 2002/09/07 22:14:54 scott% help msg -scott%% Revision 1.13 2002/08/17 00:52:45 arno% [Adebug%% Revision 1.12 2002/08/17 00:35:56 arno% debugging%% Revision 1.11 2002/08/16 16:53:14 arno% debug%% Revision 1.10 2002/08/16 16:43:58 arno% debug componly%% Revision 1.9 2002/08/16 15:09:33 arno% programming output only%% Revision 1.8 2002/08/15 22:23:25 arno% add outputonly param%% Revision 1.7 2002/08/15 21:42:23 arno% add default for outputtext%% Revision 1.6 2002/08/15 21:16:07 arno% debug%% Revision 1.5 2002/08/15 18:23:17 arno% implementing outputtext%% Revision 1.4 2002/08/12 17:14:33 arno% debug%% Revision 1.3 2002/07/29 00:51:20 arno% adding ref search for variable names%% Revision 1.2 2002/04/22 22:58:30 arno% adding extra output parameters%% Revision 1.1 2002/04/05 17:39:45 jorn% Initial revision%function [linktext,allvars,alltext] = help2html( filename, htmlfile, varargin)if nargin < 1 help help2html; return;end;if nargin <3 g = [];else g = struct( varargin{:});;end; try, g.font; catch, g.font = 'Helvetica'; end;g.functionname = [ '<FONT FACE="' g.font '"><FONT SIZE =+2><B>%s</B></FONT></FONT>' ];g.description = [ '<FONT FACE="' g.font '">%s</FONT>' ];g.title = [ '<FONT FACE="' g.font '"><FONT SIZE =+1><B>%s</B></FONT></FONT>' ];g.var = [ '<DIV ALIGN=RIGHT><FONT FACE="' g.font '"><I>%s </I></FONT></DIV>' ];g.vartext = [ '<FONT FACE="' g.font '">%s</FONT>' ];g.text = [ '<FONT FACE="' g.font '">%s</FONT>' ];g.normrow = '<tr VALIGN=TOP NOSAVE>';g.normcol1 = '<td VALIGN=TOP NOSAVE>';g.normcol2 = '<td VALIGN=BOTTOM NOSAVE>';g.doublecol = '<td ALIGN=CENTER COLSPAN="2" NOSAVE>';g.seefile = [ '<FONT FACE="' g.font '">See the matlab file <A HREF="%s" target="_blank">%s</A> (may require other functions)</FONT><BR><BR>' ]; try, g.outputonly; catch, g.outputonly = 'off'; end;try, g.background; catch, g.background = ''; end;try, g.header; catch, g.header = ''; end; try, g.footer; catch, g.footer = ''; end; try, g.refcall; catch, g.refcall = '%s.html'; end; try, g.outputlink; catch, g.outputlink = [ g.normrow g.normcol1 '<FONT FACE="' g.font '"><A HREF="%s.html">%s.html</A></td>' g.normcol2 '%s</FONT></td></tr>' ]; end; g.footer = [ '<FONT FACE="' g.font '">' g.footer '</FONT>' ];if nargin < 1 help help2html; return;end; % output file% -----------if nargin < 2 | isempty(htmlfile); indexdot = findstr( filename, '.'); if isempty(indexdot), indexdot = length(filename)+1; end; htmlfile = [ filename(1:indexdot(end)-1) '.html' ];else indexdot = findstr( filename, '.');end;% open files% ---------- fid = fopen( filename, 'r');if fid == -1 error('Input file not found');end;if ~strcmp(g.outputonly, 'on') fo = fopen(htmlfile, 'w'); if fo == -1 error('Cannot open output file'); end; % write header % ------------ fprintf(fo, '<HTML><HEAD>%s</HEAD><BODY>\n%s\n<table WIDTH="100%%" NOSAVE>\n', g.header, g.background);end; cont = 1;% scan file% -----------str = fgets( fid );% if first line is the name of the function, reloadif str(1) ~= '%', str = fgets( fid ); end; % state variables% -----------maindescription = 1;varname = [];oldvarname = [];vartext = []; newvar = 0;allvars = {};alltext = {};indexout = 1;while (str(1) == '%') str = deblank(str(2:end-1)); % --- DECODING INPUT newvar = 0; str = deblank2(str); if ~isempty(str) % find a title % ------------ i2d = findstr(str, ':');⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -