Page MenuHomec4science
Files F114367446

ft_documentationreference.m
No OneTemporary
Actions

File Metadata

Created
Sun, May 25, 11:02

ft_documentationreference.m
View Options

function ft_documentationreference(outdir)
% FT_DOCUMENTATIONREFERENCE is a function to maintain the online documentation.
%
% Normal users will not be calling this function, but will rather look at
% http://www.fieldtriptoolbox.org/reference where the output of this function can
% be found.
%
% See also FT_DOCUMENTATIONINDEX
% Copyright (C) 2008-2014, Robert Oostenveld
%
% This file is part of FieldTrip, see http://www.fieldtriptoolbox.org
% for the documentation and details.
%
% FieldTrip 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 3 of the License, or
% (at your option) any later version.
%
% FieldTrip 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 FieldTrip. If not, see <http://www.gnu.org/licenses/>.
%
% $Id$
ft_defaults
[ftver, ftpath] = ft_version;
f1 = dir(fullfile(ftpath, '*.m'));
f1 = {f1.name}';
f2 = dir(fullfile(ftpath, 'utilities', '*.m'));
f2 = {f2.name}';
f3 = dir(fullfile(ftpath, 'preproc', '*.m'));
f3 = {f3.name}';
f4 = dir(fullfile(ftpath, 'fileio', '*.m'));
f4 = {f4.name}';
f5 = dir(fullfile(ftpath, 'forward', '*.m'));
f5 = {f5.name}';
f6 = dir(fullfile(ftpath, 'inverse', '*.m'));
f6 = {f6.name}';
f7 = dir(fullfile(ftpath, 'realtime', '*.m'));
f7 = {f7.name}';
f8 = dir(fullfile(ftpath, 'realtime', 'example', '*.m'));
f8 = {f8.name}';
f9 = dir(fullfile(ftpath, 'peer', '*.m'));
f9 = {f9.name}';
f10 = dir(fullfile(ftpath, 'plotting', '*.m'));
f10 = {f10.name}';
f11 = dir(fullfile(ftpath, 'statfun', '*.m'));
f11 = {f11.name}';
f12 = dir(fullfile(ftpath, 'specest', '*.m'));
f12 = {f12.name}';
f13 = dir(fullfile(ftpath, 'connectivity', '*.m'));
f13 = {f13.name}';
f14 = dir(fullfile(ftpath, 'contrib', '*.m'));
f14 = {f14.name}';
f15 = dir(fullfile(ftpath, 'qsub', '*.m'));
f15 = {f15.name}';
f16 = dir(fullfile(ftpath, 'contrib', 'spike', '*.m'));
f16 = {f16.name}';
f17 = dir(fullfile(ftpath, 'contrib', 'trentool', '*.m'));
f17 = {f17.name}';
f18 = dir(fullfile(ftpath, 'utility', '*.m'));
f18 = {f18.name}';
f19 = dir(fullfile(ftpath, 'engine', '*.m'));
f19 = {f19.name}';
f20 = dir(fullfile(ftpath, 'realtime', 'online_eeg', '*.m'));
f20 = {f20.name}';
f21 = dir(fullfile(ftpath, 'realtime', 'online_meg', '*.m'));
f21 = {f21.name}';
f22 = dir(fullfile(ftpath, 'realtime', 'online_mri', '*.m'));
f22 = {f22.name}';
funname = cat(1, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10, f11, f12, f13, f14, f15, f16, f17, f18, f19, f20, f21, f22);
for i=1:length(funname)
[p, funname{i}, x] = fileparts(funname{i});
end
% create the desired output directory
if ~isdir(outdir)
mkdir(outdir);
end
funname = flipdim(funname,1); % to avoid problems with overlapping function names
for i=1:length(funname)
filename = fullfile(outdir, [funname{i} '.txt']);
str = help(funname{i});
% make text html-compatible
str = strrep(str, '<', '&lt;');
str = strrep(str, '>', '&gt;');
% add crossrefs
for f=1:length(funname)
str = strrep(str, [' ', upper(funname{f})], [' <a href=/reference/', funname{f}, '><font color=green>', upper(funname{f}),'</font></a>']);
end
fid = fopen(filename, 'wt');
fprintf(fid, '===== %s =====\n\n', upper(funname{i}));
fprintf(fid, 'Note that this reference documentation is identical to the help that is displayed in MATLAB when you type "help %s".\n\n', funname{i});
fprintf(fid, '<html><pre>\n'); % required for docuwiki > use html preformatted style
fprintf(fid, '%s', str);
fprintf(fid, '</pre></html>\n'); % required for docuwiki
fclose(fid);
end

Event Timeline

c4science · Help