]> Creatis software - bbtk.git/commitdiff
minor fixes
authorjean-pierre roux <jean-pierre.roux@creatis.insa-lyon.fr>
Mon, 13 Oct 2008 10:23:27 +0000 (10:23 +0000)
committerjean-pierre roux <jean-pierre.roux@creatis.insa-lyon.fr>
Mon, 13 Oct 2008 10:23:27 +0000 (10:23 +0000)
kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex

index 47e068dae8c79985a0b0bd4457f01ba18c6fd150..9261bfa2d21ee37a1a8552612284a37e36f419f9 100644 (file)
@@ -185,7 +185,7 @@ have been written by different persons, using different libraries, etc.
                 %author, description, inputs, outputs, and so on).
             \item \bbCreatePackage allows to create the basic file architecture 
                to start the development of a new black box package.
-            \item \bbCreateBlackbox allows to create the basic file architecture 
+            \item \text{bbCreateBlackbox} allows to create the basic file architecture 
                to start the development of a new black box, that will be included in an already existing package.             
             \item \texttt{bbs2cpp} translates a \texttt{.bbs} script into a \CPP file.
             \item \texttt{bbc} that interprets (i.e. : executes) a \texttt{.bbs} script.                 
@@ -2391,10 +2391,17 @@ After the already existing tags \texttt{package\_path} (i.e. the lines begining
 %\end{itemize}
 % ==========================================
 \subsection{Updating the documentation}
-\label{The_configuration_file}
+\label{Updating_the_documentation}
 % ==========================================
-If you want (and sure you will) to be able to use the Help tools as well on the features provided by this package, you must use the
-option \texttt{Regenerate package doc}  in the menu \texttt{Tools} of \texttt{bbStudio}.
+If you want (and sure you will) to be able to use the Help tools as well as the features provided by this package,
+ you must use the
+option \texttt{Regenerate package doc}  in the menu \texttt{Tools} of \texttt{bbStudio}.\\
+You'll be prompted for the Package name. Avoid using the \texttt{-a} option (Regenerate all), since it's time consumming.
+
+If you want (and sure you will) to benefit the features of Box indexing
+ you must use the
+option \texttt{Regenerate Boxes Lists}  in the menu \texttt{Tools} of \texttt{bbStudio}.\\
+
 
 % ==========================================
 \subsection{Using the package}
@@ -2410,7 +2417,7 @@ The only thing you have to do is to \texttt{load} the package, within the script
 \label{cpp}
 % ==========================================
 
-A very usefull feature is that you may use any black box within a \CPP program witout worrying about wxWigets main window.\\
+A very usefull feature is that you may use any black box within a \CPP program witout worrying about \texttt{wxWigets} main window.\\
 
 Let's look a the following bbs script :
 
@@ -2436,10 +2443,11 @@ connect slider.Out       text.In
 exec layout
 \end{verbatim}
 
-User wants to create a slider and an output text, within a layoutline, and display the slider value in the output text.\\ 
+User wants to create a slider and an output text, within a LayoutLine, and display the slider value in the output text.\\ 
 Think about the (little!) nightmare to code the same, in 'raw C++', using wxWidgets.\\
 
-Using the standalone application \bbc you just 'convert' the script :
+Using the standalone application \text{bbc} you just 'convert' the script.
+
 \begin{verbatim}
 
 #include <bbwxSlider.h>