doc

diff --git a/kernel/doc/bbtkPackageDevelopersGuide/bbStudio.png b/kernel/doc/bbtkPackageDevelopersGuide/bbStudio.png
index cf193916da82c3b44886370b5af978e927142d61..a8a7b464c39ae4dd6e16bacd7fcdbcaf3f1f8dbf 100644 (file)
Binary files a/kernel/doc/bbtkPackageDevelopersGuide/bbStudio.png and b/kernel/doc/bbtkPackageDevelopersGuide/bbStudio.png differ

diff --git a/kernel/doc/bbtkPackageDevelopersGuide/bbtkPackageDevelopersGuide.tex b/kernel/doc/bbtkPackageDevelopersGuide/bbtkPackageDevelopersGuide.tex
index 209d5fcabcef0dc9c11fbc5b361dbcde52d31458..2a9e0724e4dbbd090ace1270c5f716e32f852150 100644 (file)
--- a/kernel/doc/bbtkPackageDevelopersGuide/bbtkPackageDevelopersGuide.tex
+++ b/kernel/doc/bbtkPackageDevelopersGuide/bbtkPackageDevelopersGuide.tex
@@ -90,8 +90,9 @@
 % ==========================================
 Any black box must be included in a \bbtk package, 
 that is in a particular shared library which can be loaded 
 % ==========================================
 Any black box must be included in a \bbtk package, 
 that is in a particular shared library which can be loaded 

-dynamically by \bbtk (hence applications which use \bbtk, 
-such as the interpreter \bbi). 
+dynamically by \bbtk (hence applications which use \bbtkns, 
+such as the interpreter \bbi, launched by the development environment
+\bbStudions). 

 
 \begin{enumerate}
 \item \textbf{Create a new package. }
 
 \begin{enumerate}
 \item \textbf{Create a new package. }


@@ -135,7 +136,7 @@ the utility \bbfy will then generate the corresponding \CPP code.
 
 Run \texttt{bbStudio}.
 
 
 Run \texttt{bbStudio}.
 

-You''l get something like in fig. \ref{bb-Studio}
+You'll get something like in fig. \ref{bb-Studio}

 
 \begin{figure}[!ht]
 \caption{\label{bb-Studio} bbStudio}
 
 \begin{figure}[!ht]
 \caption{\label{bb-Studio} bbStudio}

diff --git a/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex b/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex
index 06e156ebfb51a7349bdd1a607e280552a3db6599..9ca82e5cff2e4cb6e766b26a263af20f604db3a6 100644 (file)
--- a/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex
+++ b/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex
@@ -321,7 +321,8 @@ Let's have a look at the resized window :
 \end{center}
 \end{figure}
 
 \end{center}
 \end{figure}
 

-You can see four parts : \texttt{Files}, \texttt{Messages}, \texttt{Command}, \texttt{Help}.\\
+You can see four parts : \texttt{Files}, \texttt{Messages},
+ \texttt{Command}, \texttt{Help}.\\

 
 The stuff is written using the Advanced User Interface library of wxWidgets,
 whose 'docking manager' allows windows and toolbars to be floated/docked 
 
 The stuff is written using the Advanced User Interface library of wxWidgets,
 whose 'docking manager' allows windows and toolbars to be floated/docked 


@@ -361,7 +362,8 @@ lower toolbar (see figure : \ref{lowertoolbar})
 
 Two kinds of messages will be output here:\\
 System messages : produced by the kernel, in case of a user mistyping, or an execution error\\
 
 Two kinds of messages will be output here:\\
 System messages : produced by the kernel, in case of a user mistyping, or an execution error\\

-Script messages : produced by the \bbtk equivalent of \texttt{printf} or \texttt{std::cout} in user programs
+Script messages : produced by the \bbtk equivalent of \texttt{printf} 
+or \texttt{std::cout} in user programs

 
 \subsubsection{'Command' part}
 \label{bbi-CommandPart}
 
 \subsubsection{'Command' part}
 \label{bbi-CommandPart}


@@ -395,10 +397,12 @@ All the entries of the starting page are self-explanatory :
    \end{itemize}
         
    \item {\bf\emph{Boxes}} : Box retrieving on various criterions :
    \end{itemize}
         
    \item {\bf\emph{Boxes}} : Box retrieving on various criterions :

-
-        \texttt{By name}} (Alphabetical list), 
-        \texttt{{By package}}, 
-        \texttt{{By category}}.\\ 
+   \begin{itemize} 
+    \item {\bf\emph{    \texttt{By name}}} (Alphabetical list), 
+    \item {\bf\emph{    \texttt{{By package}}}, 
+     \item {\bf\emph{   \texttt{{By category}}}.
+   \end{itemize} 
+   

         A special hidden Box category, called \texttt{{Adaptors}} exists. \\ 
        They are used internaly to perform type conversions. Thought there are not end user intended, an aware user may query them.     
 
         A special hidden Box category, called \texttt{{Adaptors}} exists. \\ 
        They are used internaly to perform type conversions. Thought there are not end user intended, an aware user may query them.     
 


@@ -570,24 +574,12 @@ Both graphical pipe line (\emph{slider} and \emph{text} are embedded into \emph{
 \subsection{Online Help}
 % ==============================================
 
 \subsection{Online Help}
 % ==============================================
 

-TODO
+Various levels or help are supllid by \bbStudions.

 
 % ==========================================
 
 % ==========================================

-\subsubsection{Guides}
-% ==========================================
-TODO
-% ==========================================
-\subsubsection{Boxes Help}
-% ==========================================
-TODO : indexation, categories, etc
-% ==========================================
-\subsection{Creating and executing black boxes}
+\subsubsection{Command line help}

 % ==========================================
 % ==========================================

-TODO
-% ==============================================
-\subsection{The Menu}
-% ==============================================
-TODO
+

 
 The 'working' area (the left one, as opposed to the 'help' area, on the right side) is composed of : 
 one single line zone (Command), at the bottom in which you can enter your commands and 
 
 The 'working' area (the left one, as opposed to the 'help' area, on the right side) is composed of : 
 one single line zone (Command), at the bottom in which you can enter your commands and 


@@ -731,30 +723,6 @@ Then if you type :
 
 you get something like :
 
 
 you get something like :
 

-% std
-%   ASCII                  
-%   Add                    
-%   ConcatStrings          
-%   Configuration          
-%   Div                    
-%   ExecBbiCommand         
-%   ExecSystemCommand      
-%   GetVectorCharElement   
-%      ... 
-%   GetVectorUShortElement 
-%   MagicBox               
-%   MakeFileName           
-%   Mul                    
-%   MultipleInputs         
-%   PrependDataPath        
-%   PrependPackageDataPath 
-%   StringRelay            
-%   StringSelect           
-% user
-% 
-%   workspace
-
-

 \begin{verbatim}
 
  std
 \begin{verbatim}
 
  std


@@ -804,6 +772,63 @@ Black Box <std::Add>
      'Out'            <Double>     []       : Result
 \end{verbatim}
 
      'Out'            <Double>     []       : Result
 \end{verbatim}
 

+More information about what is a 'box' will be given in the 'Scriptting' part of this manual.
+
+% ==========================================
+\subsubsection{Guides}
+% ==========================================
+
+An html version of all the guides is browsable in the \texttt{Help} part of \bbStudions.
+ \begin{itemize}      
+     \item {\bf\emph{User's Guide}} : Step to step How-to for user who wants to create his own
+     application, just using already existing boxes.
+     \item {\bf\emph{Package Developper's Guide}} : Step to step How-to for programmer who wants to create his own
+     black boxes/packages.
+     \item {\bf\emph{Developper's Guide}} : For bbtk kernel developpers only. (This one is probabely not very much
+     up-to-date, since we spend more time in developping than writing documentation that's not of user concern).
+     \item {\bf\emph{Reference Manual}} : Contains a exaustive description of all the features for all the commands.
+     \item {\bf\emph{Booklet}} : Vade mecum.     
+     \item {\bf\emph{Doxygen Documentation}} : Doxygen source browser.\\ Automatically generated from source file
+     headers. Should concern only the kernel developpers (i.e. : us).
+   \end{itemize}
+        
+
+   \end{itemize} 
+   
+% ==========================================
+\subsubsection{Boxes Help}
+% ==========================================
+ Box retrieving on various criterions :
+   \begin{itemize} 
+    \item {\bf\emph{Alphabetical list}} \\ This is the 'zero-level' of retrieving.
+    \item {\bf\emph{List by package}} \\ Several packages are supplied with bbtk :
+    \begin{itemize}
+      \item {\bf\emph{std}} : the 'standard' package including basic useful boxes.
+      \item {\bf\emph{wx}} : basic graphical interface elements (widgets : sliders, buttons, etc. based on the \texttt{wxWidgets} library).  
+      \item {\bf\emph{itk}} : the basic image processing package, based on the \itk library.
+      \item {\bf\emph{vtk}} : the basic images and surfaces processing and vizualization package, based on the \vtk library.
+      \item {\bf\emph{wxvtk}} : widget boxes based on the \vtk library (2D and 3D vizualization and
+      interaction).
+      \item {\bf\emph{itkvtk}} : special boxes (adaptors) to convert \itk structures into \vtk structures and conversally.
+      %\item {\bf\emph{creaImageIO}} : Provides hight level widgets to read images, including DICOM.
+      \item {\bf\emph{toolsbbtk}} : Tools for bbtk administration and package development, such as :
+         \begin{itemize}
+        \item{GUICreateBlackBox} For creating the XML or C++ code for a new black box 
+        \item{GUICreatePackage} For creating a new bbtk package file structure on disk (Graphical user interface for the shell script bbCreatePackage)
+        \item{MakePackageDoc} For creating the html documentation of a package. The doc is generated at the 'canonical' location. Works both for a build tree or an installed toolkit.  
+         \end{itemize}              
+    \end{itemize}
+    \item {\bf\emph{{List by category}}.
+% ==========================================
+\subsection{Creating and executing black boxes}
+% ==========================================
+TODO
+% ==============================================
+\subsection{The Menu}
+% ==============================================
+TODO
+
+

 You'll get as well the same information in the 'Help' Part, in html format (see figure : \ref{HelpAdd}) :
 
 \begin{figure}[!ht]
 You'll get as well the same information in the 'Help' Part, in html format (see figure : \ref{HelpAdd}) :
 
 \begin{figure}[!ht]