From: jean-pierre roux <jean-pierre.roux@creatis.insa-lyon.fr>
Date: Thu, 26 Jun 2008 18:18:48 +0000 (+0000)
Subject: cosmetics
X-Git-Tag: r0.6.1~7
X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=commitdiff_plain;h=ba57c2cbe04a3df288f7ee89ccfbdfb026997d70;p=bbtk.git

cosmetics
---

diff --git a/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex b/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex
index 4d86c3f..0ed6a91 100644
--- a/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex
+++ b/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex
@@ -67,7 +67,7 @@ I let you think about this\dots)
 
 Of course, symbolic data attached to box can be 
 {\bf queried}: what are the inputs/outputs of the box ? 
-what are their type ? description ? etc.
+what are their type ? their description ? etc.
 This allows {\bf automatic documentation} of boxes. 
 
 The abstract definition of black boxes is the most basic 
@@ -236,7 +236,7 @@ one multiple line zone in which \bbi prints out the result of your commands.
 
 
 Try typing in the input zone (in this manual, 
-the commands entered by the user will be preceded by a prompt '>') :
+the commands entered by the user will be preceded by a prompt '(>)') :
 \begin{verbatim}
 > help 
 \end{verbatim}
@@ -248,6 +248,7 @@ Available commands:
  category
  config
  connect
+ debug
  define
  delete
  description
@@ -259,16 +260,18 @@ Available commands:
  include
  index
  input
+ kind
  load
  message
  new
+ newgui
  output
  package
  print
  quit
  reset
  set
- unload
+ unload 
 \end{verbatim}
 
 To get help on a particular command type \texttt{help <command-name>},
@@ -371,14 +374,19 @@ you get something like:
 \begin{verbatim}
 std
   Add 
-  ... 
+  ConcatStrings          
+  Configuration          
+  Div   
+  ...
+  StringRelay            
+  StringSelect    
 user
   workspace
 > 
 \end{verbatim}
 
 Now \bbi knows the package \texttt{std} and the black boxes it provides,
-such as the \texttt{'Add'} box. Remark that the 
+such as the \texttt{'Add'} box, the  \texttt{'ConcatStrings'}. Remark that the 
 content of \texttt{std} may vary from one version to another 
 as new black boxes might be added to it. 
 If you type:  
@@ -389,17 +397,17 @@ If you type:
 You get:
 \begin{verbatim}
 Black Box <std::Add>
- Adds its inputs
- By: laurent.guigues at creatis.insa-lyon.fr
- Categories : atomic box;math;
- * Inputs: 
-    'BoxExecute'     <bbtk::Void> : Any signal received by this input executes the box
-    'BoxProcessMode' <String>     : Sets the processing mode of the box (Pipeline | Always | Reactive)
-    'In1'            <Double>     : First number to add
-    'In2'            <Double>     : Second number to add
+  Adds its inputs
+  By : laurent.guigues@creatis.insa-lyon.fr
+  Categories : atomic box;math;
+  * Inputs : 
+     'BoxExecute'     <bbtk::Void> [signal] : Any signal received by this input executes the box
+     'BoxProcessMode' <String>     []       : Sets the processing mode of the box (Pipeline | Always | Reactive)
+     'In1'            <Double>     []       : First number to add
+     'In2'            <Double>     []       : Second number to add
   * Outputs : 
-    'BoxChange'      <bbtk::Void> : Signal modifications of the box
-    'Out'            <Double>     : Result'In1'         <double>: First number to add
+     'BoxChange'      <bbtk::Void> [signal] : Signals modifications of the box
+     'Out'            <Double>     []       : Result
 \end{verbatim}
 
 Like previously, 
@@ -427,10 +435,10 @@ the command \texttt{new}:
 
 The \texttt{'a'} at the end is the \emph{name} of the instance, 
 which will be used to reference it later. 
-It is important to make the difference between box \emph{types} 
-and \emph{instances} of box types. 
-The \texttt{Add} box of the package \texttt{std} is in fact 
-a \emph{type} of box, like \texttt{int} is a type of data 
+It is important to distinguish a box \emph{types} 
+and an \emph{instance} of a box type. 
+The \texttt{Add} box of the package \texttt{std} is actually 
+a \emph{box type} , like \texttt{int} is a data type 
 in \texttt{C} langage. The \texttt{new} command allows to create 
 an instance of a box type, exactly like \texttt{int i;} in 
 a \texttt{C} code declares a variable of type \texttt{int} whose 
@@ -455,8 +463,8 @@ Complex Black Box <user::workspace>
     'a' <std::Add>
 \end{verbatim}
 
-which means that \bbi's workspace now contains a black box 
-of type \texttt{std::Add} and name \texttt{a}.
+which means that \bbi workspace now contains a black box named \texttt{a},
+of type \texttt{std::Add}.
 
 Now look back at the help on \texttt{Add} boxes: 
 you can see that this type of box has two inputs, 
@@ -491,6 +499,7 @@ To process this special substrings, \bbi does:
 \item Converts the output of the box to a string if possible 
 (see below)
 \item Substitutes the result in the string to print
+\item postpone an implicit 'new line' character to the string
 \end{enumerate}
 
 Box processing is needed if:
@@ -540,7 +549,8 @@ Good bye !
 \item In all \bbi, to reference the input called \texttt{i} 
 of a black box called \texttt{b} you must type \texttt{'b.i'}. 
 The same syntax holds for outputs.
-\item \texttt{print} prints a string, substituting each substring of the form \$b.o\$ by the value of the output \texttt{o} of the black box \texttt{b}. 
+\item \texttt{print} prints a string, substituting each substring of the form \$b.o\$ by the value of the output \texttt{o} of the black box \texttt{b}. Note that an
+implicit trailing 'new line character' is added at the final string.
 \item \texttt{exec} runs the process of a box if needed. 
 \item \texttt{quit} quits \bbi.
 \end{itemize}