Changeset 659 for library/doc

Show
Ignore:
Timestamp:
10/13/09 17:36:56 (15 years ago)
Author:
mido
Message:

synchronization of documentation pages names

Location:
library/doc/tutorial
Files:
8 modified

Legend:

Unmodified
Added
Removed

  • library/doc/tutorial/005userguide0.dox

    r657 r659  
    11/*! 
    2 \page user_guide0 BDM Use - Introduction 
     2\page userguide0 BDM Use - Introduction 
    33 
    44BDM is a library of basic components for Bayesian decision making, hence its direct use is not possible. In order to use BDM the components must be pulled together in order to achieve desired functionality. We expect two kinds of users: 
    … …  
    2424\section secnario Prepared Scenarios 
    2525 
    26 Since some tasks are repeatedly occuring in practical applications of decision making, these tasks has been identified and prepared as standalone applications (or mex files). These taska are implemented in separate toolbox - bdmtoolbox. Binary version of the toolbox is available see \ref instalation. 
     26Since some tasks are repeatedly occuring in practical applications of decision making, these tasks has been identified and prepared as standalone applications (or mex files). These taska are implemented in separate toolbox - bdmtoolbox. Binary version of the toolbox is available see \ref install. 
    2727 
    2828The predefined scenarios are: 
    … …  
    3535A tutorial how to run the scenarios are: 
    3636 
    37  - \ref user_guide 
    38  - \ref user_guide2 
     37 - \ref userguide 
     38 - \ref userguide2 
    3939 
    4040*/ 

  • library/doc/tutorial/01userguide.dox

    r652 r659  
    11/*! 
    2 \page user_guide BDM Use - System, Data, Simulation 
    3  
    4 This section serves as introdustion to the scenario of data simulation. Since it is the simpliest of all scenarios defined in \ref 005userguide0 it also serves as introduction to configuration of an experiment (see \ref ui_page) and basic decision making objects (bdm::RV and bdm::DS). 
     2\page userguide BDM Use - System, Data, Simulation 
     3 
     4This section serves as introdustion to the scenario of data simulation. Since it is the simpliest of all scenarios defined in \ref 005userguide0 it also serves as introduction to configuration of an experiment (see \ref ui) and basic decision making objects (bdm::RV and bdm::DS). 
    55 
    66All experiments are demonstarted on scenario simulator which can be either standalone application or mex file (simulator.mex**). 
    … …  
    1414 
    1515The configuration has two possible options: 
    16  - configuration file using syntax of libconfig (see \ref ui_page), 
     16 - configuration file using syntax of libconfig (see \ref ui), 
    1717 - matlab structure. 
    1818For the purpose of tutorial, we will use the matlab notation.  
    19 These two options can be mutually converted from one to another using prepared mex files: config2mxstruct.mex and mxstruct2config.mex. Naturally, these scripts require matlab to run. If it is not available, manual conversion is relatively trivial, the major difference is in using different types of brackets (\ref ui_page) 
     19These two options can be mutually converted from one to another using prepared mex files: config2mxstruct.mex and mxstruct2config.mex. Naturally, these scripts require matlab to run. If it is not available, manual conversion is relatively trivial, the major difference is in using different types of brackets (\ref ui) 
    2020 
    2121\subsection ug_first First experiment 

  • library/doc/tutorial/02userguide2.dox

    r651 r659  
    11/*! 
    2 \page user_guide2 BDM Use - Estimation and Bayes Rule 
     2\page userguide2 BDM Use - Estimation and Bayes Rule 
    33 
    44Baysian theory is predominantly used in system identification, or estimation problems.  
    … …  
    2121\li Result Logger is an object (class logger) dedicated to storing important data from the experiment. 
    2222 
    23 Since objects  datasource and the logger has already been introduced in section \ref user_guide, it remains to introduce  
     23Since objects  datasource and the logger has already been introduced in section \ref userguide, it remains to introduce  
    2424object \c Bayesian \c Model (bdm::BM). 
    2525 

  • library/doc/tutorial/03devguide.dox

    r632 r659  
    11/*! 
    2 \page dev_guide  BDM Use - in C++  
     2\page devguide  BDM Use - in C++  
    33 
    44\section Intro Logic of BDM 
    55- \subpage intro 
    6 - \subpage ui_page 
     6- \subpage ui 
    77- \subpage mexfiles 
    88 

  • library/doc/tutorial/04devguide2.dox

    r632 r659  
    11/*! 
    2 \page dev_guide2 BDM Development - Contribution guide 
     2\page devguide2 BDM Development - Contribution guide 
    33\addindex Howto Contribute to BDM - Advanced development 
    44 

  • library/doc/tutorial/arx_ui.dox

    r651 r659  
    66\section cmd Command Line 
    77 
    8 In order to use it for estimation of an ARX model, we can define the following \ref ui_page "user info" structure: 
     8In order to use it for estimation of an ARX model, we can define the following \ref ui "user info" structure: 
    99\include arx_test.cfg 
    1010 

  • library/doc/tutorial/mexfiles.dox

    r471 r659  
    55 
    66A range of mexfiles is predefined in directory \c library/mex. 
    7 Many of these mexfile process ui files (see \ref ui_page) examples of these files are in directory \c library/tutorial. 
     7Many of these mexfile process ui files (see \ref ui) examples of these files are in directory \c library/tutorial. 
    88Note that in order to run these files you need to let matlab know where to find them: 
    99\code 

  • library/doc/tutorial/ui.dox

    r600 r659  
    11/*! 
    2 \page ui_page User Infos and their use 
     2\page ui User Infos and their use 
    33  
    44\sa #bdm::UI