Commit 209ff38b authored by mbe's avatar mbe

bugfixes in generate documentation

also added logo to tutorial scripts for nice HTML files of the tutorials
parent 174b2bc8
...@@ -29,8 +29,19 @@ ita_generate_helpOverview(sArgs.rootpath); ...@@ -29,8 +29,19 @@ ita_generate_helpOverview(sArgs.rootpath);
cd(sArgs.rootpath) cd(sArgs.rootpath)
%% Get folders for m2html %% Get folders for m2html
ignoreList = {'.svn','.git','private','tmp','prop-base','props','text-base','template','doc','GuiCallbacks'}; ignoreList = {'.svn', ...
pathStr = genpath(sArgs.rootpath); %generates folderlist with ';' to seperate folders '.git', ...
'private', ...
'tmp', ...
'prop-base', ...
'props', ...
'text-base', ...
'template', ...
'doc', ...
'GuiCallbacks', ...
'external_packages', ...
'ExternalPackages'};
pathStr = genpath(sArgs.rootpath);
prefixToolbox = fliplr(strtok(fliplr(sArgs.rootpath),filesep)); %get Toolbox folder name prefixToolbox = fliplr(strtok(fliplr(sArgs.rootpath),filesep)); %get Toolbox folder name
outpathStr = []; outpathStr = [];
...@@ -47,7 +58,7 @@ for idx=1:(length(tokenIdx)-1) ...@@ -47,7 +58,7 @@ for idx=1:(length(tokenIdx)-1)
if ~isIgnore %add string token if ~isIgnore %add string token
outpathStr = [outpathStr,pathsep,tokenCell{idx}]; %#ok<*AGROW> outpathStr = [outpathStr,pathsep,tokenCell{idx}]; %#ok<*AGROW>
idxITA = strfind(tokenCell{idx},prefixToolbox); %pdi idxITA = strfind(tokenCell{idx},prefixToolbox); %pdi
outpathList = [outpathList; {tokenCell{idx}(idxITA:end)}]; %throw away 'C:\...' until ITA-TB path outpathList = [outpathList; {tokenCell{idx}(idxITA:end)}]; % make path relative
end end
end end
......
...@@ -270,8 +270,6 @@ classesHTML=[classesHTML, '<br>', sprintf('\n'), classesHTML_end]; ...@@ -270,8 +270,6 @@ classesHTML=[classesHTML, '<br>', sprintf('\n'), classesHTML_end];
%write edited file %write edited file
ita_writeHTML(fullfile(htmlFolder, 'classes.html'), classesHTML); ita_writeHTML(fullfile(htmlFolder, 'classes.html'), classesHTML);
%write edited file
ita_writeHTML(fullfile(htmlFolder, 'apps.html'), appsHTML);
%% Generate Kernel Documentation %% Generate Kernel Documentation
[kernelHTML_begin, kernelHTML_end] = ita_openHTML(fullfile(templateFolder, 'template_kernel.html')); [kernelHTML_begin, kernelHTML_end] = ita_openHTML(fullfile(templateFolder, 'template_kernel.html'));
......
...@@ -14,10 +14,10 @@ ...@@ -14,10 +14,10 @@
</tocitem> </tocitem>
<tocitem target="index_guide.html" image="HelpIcon.USER_GUIDE">User's Guide <tocitem target="index_guide.html" image="HelpIcon.USER_GUIDE">User's Guide
<tocitem target="classes.html">Classes</tocitem> <tocitem target="classes.html">Classes</tocitem>
<tocitem target="apps.html">Applications</tocitem> <!-- <tocitem target="apps.html">Applications</tocitem> -->
<tocitem target="kernel.html">Kernel</tocitem> <tocitem target="kernel.html">Kernel</tocitem>
<tocitem target="../ITA_Toolbox_Getting_Started.pdf" image="$toolbox/matlab/icons/pdficon.gif">Getting Started with the ITA Toolbox (PDF)</tocitem> <!-- <tocitem target="../ITA_Toolbox_Getting_Started.pdf" image="$toolbox/matlab/icons/pdficon.gif">Getting Started with the ITA Toolbox (PDF)</tocitem> -->
<tocitem target="../ITA_Toolbox_Measurement_Tutorial.pdf" image="$toolbox/matlab/icons/pdficon.gif">Get to know how to measure with the ITA Toolbox (PDF)</tocitem> <!-- <tocitem target="../ITA_Toolbox_Measurement_Tutorial.pdf" image="$toolbox/matlab/icons/pdficon.gif">Get to know how to measure with the ITA Toolbox (PDF)</tocitem> -->
<tocitem target="doc/index.html" image="HelpIcon.RELEASE_NOTES">Function Help</tocitem> <tocitem target="doc/index.html" image="HelpIcon.RELEASE_NOTES">Function Help</tocitem>
</tocitem> </tocitem>
<tocitem target="index_demos.html" image="HelpIcon.EXAMPLES">Product Demos <tocitem target="index_demos.html" image="HelpIcon.EXAMPLES">Product Demos
...@@ -28,4 +28,4 @@ ...@@ -28,4 +28,4 @@
<tocitem target="http://www.ita-toolbox.org" image="$toolbox/matlab/icons/webicon.gif">ITA Toolbox Web Site</tocitem> <tocitem target="http://www.ita-toolbox.org" image="$toolbox/matlab/icons/webicon.gif">ITA Toolbox Web Site</tocitem>
<tocitem target="http://www.akustik.rwth-aachen.de" image="$toolbox/matlab/icons/webicon.gif">RWTH Aachen - ITA Web Site</tocitem> <tocitem target="http://www.akustik.rwth-aachen.de" image="$toolbox/matlab/icons/webicon.gif">RWTH Aachen - ITA Web Site</tocitem>
</tocitem> </tocitem>
</toc> </toc>
\ No newline at end of file
...@@ -24,11 +24,11 @@ ...@@ -24,11 +24,11 @@
<icon>$toolbox/matlab/icons/book_mat.gif</icon> <icon>$toolbox/matlab/icons/book_mat.gif</icon>
</listitem> </listitem>
<listitem> <!-- <listitem> -->
<label>Getting Started (PDF)</label> <!-- <label>Getting Started (PDF)</label> -->
<callback>open('ITA_Toolbox_Getting_Started.pdf');</callback> <!-- <callback>open('ITA_Toolbox_Getting_Started.pdf');</callback> -->
<icon>$toolbox/matlab/icons/pdficon.gif</icon> <!-- <icon>$toolbox/matlab/icons/pdficon.gif</icon> -->
</listitem> <!-- </listitem> -->
<listitem> <listitem>
<label>Web Site (ITA - RWTH Aachen)</label> <label>Web Site (ITA - RWTH Aachen)</label>
......
%% Tutorial to create image sources model %% Tutorial to create image sources model
% <<../../pics/ita_toolbox_logo_wbg.png>>
%
% author: rbo 12-2014 % author: rbo 12-2014
%% Init %% Init
file = [ita_toolbox_path '\applications\ImageSources\box.dae']; file = fullfile(ita_toolbox_path, 'applications', 'ImageSources', 'box.dae');
receiverPos = [1 1 1.5]; receiverPos = [1 1 1.5];
sourcePos = [2 2 2]; sourcePos = [2 2 2];
order = 2; order = 2;
......
%% Recording with the ITA Toolbox %% Recording with the ITA Toolbox
% %
% <<../../pics/ita_toolbox_logo_wbg.png>>
%
% In this tutorial you will learn how to set-up a simple the ITA Toolbox % In this tutorial you will learn how to set-up a simple the ITA Toolbox
% for a simple recording task. The first step is to create an instance % for a simple recording task. The first step is to create an instance
% of the itaMSRecord class, the basic recording class of the ITA % of the itaMSRecord class, the basic recording class of the ITA
......
%% Nonlinearities in room acoustics %% Nonlinearities in room acoustics
% %
% <<../../pics/ita_toolbox_logo_wbg.png>>
%
% Exp. Sweep measurements are simulated using an emulation of the % Exp. Sweep measurements are simulated using an emulation of the
% measurement chain with nonlinerities. % measurement chain with nonlinerities.
% %
...@@ -18,14 +20,14 @@ ...@@ -18,14 +20,14 @@
% Please see the References for Details and plots: % Please see the References for Details and plots:
% %
% @INPROCEEDINGS{pdiNonlinearitiesDAGA2013, % @INPROCEEDINGS{pdiNonlinearitiesDAGA2013,
% author = {Pascal Dietrich and Martin Guski and Michael Vorlnder}, % author = {Pascal Dietrich and Martin Guski and Michael Vorl�nder},
% title = {Influence of Loudspeaker Distortion on Room Acoustic Parameters}, % title = {Influence of Loudspeaker Distortion on Room Acoustic Parameters},
% booktitle = DAGA2013, % booktitle = DAGA2013,
% year = {2013}} % year = {2013}}
% %
% @INPROCEEDINGS{pdiToolboxDAGA2013, % @INPROCEEDINGS{pdiToolboxDAGA2013,
% author = {Pascal Dietrich and Martin Guski and Johannes Klein and Markus Mller-Trapet % author = {Pascal Dietrich and Martin Guski and Johannes Klein and Markus M�ller-Trapet
% and Martin Pollow and Roman Scharrer and Michael Vorlnder}, % and Martin Pollow and Roman Scharrer and Michael Vorl�nder},
% title = {Measurements and Room Acoustic Analysis with the ITA-Toolbox for % title = {Measurements and Room Acoustic Analysis with the ITA-Toolbox for
% MATLAB}, % MATLAB},
% booktitle = DAGA2013, % booktitle = DAGA2013,
......
%% Measuring a transfer function with the ITA Toolbox %% Measuring a transfer function with the ITA Toolbox
% %
% <<../../pics/ita_toolbox_logo_wbg.png>>
%
% In this tutorial you will learn how to measure a transfer function % In this tutorial you will learn how to measure a transfer function
% with the ITA Toolbox. The tutorial builds on the 'ita_tutorial_record' % with the ITA Toolbox. The tutorial builds on the 'ita_tutorial_record'
% tutorial and will only explicitly explain new settings. % tutorial and will only explicitly explain new settings.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment