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);
cd(sArgs.rootpath)
%% Get folders for m2html
ignoreList = {'.svn','.git','private','tmp','prop-base','props','text-base','template','doc','GuiCallbacks'};
pathStr = genpath(sArgs.rootpath); %generates folderlist with ';' to seperate folders
ignoreList = {'.svn', ...
'.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
outpathStr = [];
......@@ -47,7 +58,7 @@ for idx=1:(length(tokenIdx)-1)
if ~isIgnore %add string token
outpathStr = [outpathStr,pathsep,tokenCell{idx}]; %#ok<*AGROW>
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
......
......@@ -270,8 +270,6 @@ classesHTML=[classesHTML, '<br>', sprintf('\n'), classesHTML_end];
%write edited file
ita_writeHTML(fullfile(htmlFolder, 'classes.html'), classesHTML);
%write edited file
ita_writeHTML(fullfile(htmlFolder, 'apps.html'), appsHTML);
%% Generate Kernel Documentation
[kernelHTML_begin, kernelHTML_end] = ita_openHTML(fullfile(templateFolder, 'template_kernel.html'));
......
......@@ -14,10 +14,10 @@
</tocitem>
<tocitem target="index_guide.html" image="HelpIcon.USER_GUIDE">User's Guide
<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="../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_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="doc/index.html" image="HelpIcon.RELEASE_NOTES">Function Help</tocitem>
</tocitem>
<tocitem target="index_demos.html" image="HelpIcon.EXAMPLES">Product Demos
......
......@@ -24,11 +24,11 @@
<icon>$toolbox/matlab/icons/book_mat.gif</icon>
</listitem>
<listitem>
<label>Getting Started (PDF)</label>
<callback>open('ITA_Toolbox_Getting_Started.pdf');</callback>
<icon>$toolbox/matlab/icons/pdficon.gif</icon>
</listitem>
<!-- <listitem> -->
<!-- <label>Getting Started (PDF)</label> -->
<!-- <callback>open('ITA_Toolbox_Getting_Started.pdf');</callback> -->
<!-- <icon>$toolbox/matlab/icons/pdficon.gif</icon> -->
<!-- </listitem> -->
<listitem>
<label>Web Site (ITA - RWTH Aachen)</label>
......
%% Tutorial to create image sources model
% <<../../pics/ita_toolbox_logo_wbg.png>>
%
% author: rbo 12-2014
%% Init
file = [ita_toolbox_path '\applications\ImageSources\box.dae'];
file = fullfile(ita_toolbox_path, 'applications', 'ImageSources', 'box.dae');
receiverPos = [1 1 1.5];
sourcePos = [2 2 2];
order = 2;
......
%% 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
% for a simple recording task. The first step is to create an instance
% of the itaMSRecord class, the basic recording class of the ITA
......
%% Nonlinearities in room acoustics
%
% <<../../pics/ita_toolbox_logo_wbg.png>>
%
% Exp. Sweep measurements are simulated using an emulation of the
% measurement chain with nonlinerities.
%
......@@ -18,14 +20,14 @@
% Please see the References for Details and plots:
%
% @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},
% booktitle = DAGA2013,
% year = {2013}}
%
% @INPROCEEDINGS{pdiToolboxDAGA2013,
% author = {Pascal Dietrich and Martin Guski and Johannes Klein and Markus Mller-Trapet
% and Martin Pollow and Roman Scharrer and Michael Vorlnder},
% author = {Pascal Dietrich and Martin Guski and Johannes Klein and Markus M�ller-Trapet
% and Martin Pollow and Roman Scharrer and Michael Vorl�nder},
% title = {Measurements and Room Acoustic Analysis with the ITA-Toolbox for
% MATLAB},
% booktitle = DAGA2013,
......
%% 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
% with the ITA Toolbox. The tutorial builds on the 'ita_tutorial_record'
% 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