correction erreurs description/author et commentaires longs

diff --git a/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex b/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex
index 57f41a17ae2d12882afb7e6973baa9588c7cbd97..9e0bfff9897aa294ed5b43c09f7519a1c9daa099 100644 (file)
--- a/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex
+++ b/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex
@@ -859,7 +859,7 @@ If you type \texttt{'help workspace'}, you get:
 \end{verbatim}
 
 In the text displayed, 
-the \texttt{user::} prepended to the name \texttt{workspace} 
+the \texttt{user::} prefixed to the name \texttt{workspace} 
 means that the box \texttt{workspace} 
 belongs to the \texttt{user} package. 
 Then comes a description and three lines which 
@@ -1082,7 +1082,7 @@ To process these special substrings, the interpreter:
 \item Converts the output of the box to a string if possible 
 (see below)
 \item Substitutes the result in the string to print
-\item Postpones an implicit 'new line' character to the string
+\item Places an implicit 'new line' character after the string
 \end{enumerate}
 
 %\paragraph
@@ -1441,7 +1441,7 @@ Actually, since the file has the \texttt{bbs} extension, you can omit it and jus
 \begin{itemize}
 \item The \texttt{include} command tells the interpreter to include a script file.
 \item Lines starting with \texttt{\#} or \texttt{\//\//} are considered as comments by the interpreter.
-\item A longer comment can be written between a line marked \texttt{\//*} and a line marked \texttt{*\//}.
+\item A longer comment can be written between two empty lines only containing \texttt{\//*} and \texttt{*\//} respectively.
 \end{itemize}
 
 \hrule
@@ -1471,17 +1471,16 @@ The \bbs script file defining this complex black box will be as follows:
 
 \begin{verbatim}
 # bbAdd3.bbs: defines the Add3 black box which adds 3 doubles 
-load std
 
+author "myself"
+description "adds 3 doubles"
+
+load std
 define Add3
-  author "myself"
-  description "adds 3 doubles"
-  
   # Pipeline creation
   new Add a
   new Add b
   connect a.Out b.In1
-  
   # Inputs definition
   input x a.In1 "first double to add
   input y a.In2 "second double to add
@@ -1502,7 +1501,7 @@ exactly in the same way as outside of a complex box definition.
 and \texttt{output} are specific to complex boxes definition:
        \begin{itemize}
                \item \texttt{author} and \texttt{description} are used for the documentation 
-of the new box. You can provide multiple \texttt{author} or 
+of the new box. They have to be placed at the very beginning of the script file. You can provide multiple \texttt{author} or 
 \texttt{description} commands, the arguments of the commands will 
 be concatenated to produce the final author and description strings.
                \item \texttt{input} and \texttt{output} are used to define the inputs and outputs 
@@ -1576,13 +1575,13 @@ by convention all the 'natural entries' of a box are named \texttt{In}, or \text
 \paragraph{Summary}
 %\hrule
 \begin{itemize}
-\item The \texttt{define/endefine} commands allow to define complex black box types, i.e. types of black boxes made up of other black boxes. 
+       \item The \texttt{author} and \texttt{description} commands, placed at the very beginning of a script file, allow to document the new type of box.
+       \item The \texttt{define/endefine} commands allow to define complex black box types, i.e. types of black boxes made up of other black boxes. 
 Inside a \texttt{define/endefine} block :
-\begin{itemize}
-\item The \texttt{author} and \texttt{description} commands allow to document the new type of box
-\item The \texttt{input} and \texttt{output} commands allow to define the inputs and outputs of the new type of box, that is to which inputs and outputs 
+       \begin{itemize}
+               \item the \texttt{input} and \texttt{output} commands allow to define the inputs and outputs of the new type of box, that is to which inputs and outputs 
 of internal boxes they correspond.  
-\end{itemize}
+       \end{itemize}
 \end{itemize}
 \hrule
 % ==========================================
@@ -1598,11 +1597,11 @@ like in the following example:
 \begin{file}{bbAdd4.bbs}
 \begin{verbatim}
 # Defines the Add4 black box which adds 4 doubles 
-include Add3
+author "myself"
+description "adds 4 doubles"
 
+include bbAdd3
 define Add4
-  author "myself"
-  description "adds 4 doubles"
   new Add3 a
   new Add b
   connect a.result b.In1
@@ -1633,7 +1632,7 @@ The author of the complex box has the ability to give these inputs meaningful na
 \begin{itemize}
 \item
 File names : 
-For consistency reasons, you are requested to prepend \texttt{bb}, and postpone an extention \texttt{.bbs},
+For consistency reasons, you are requested to prefix \texttt{bb} and place an extension \texttt{.bbs},
 to the names of the files that hold a \texttt{complex black box} definition.
 
 For example, the \texttt{Add3} complex box we previously worked on 
@@ -1646,19 +1645,6 @@ For instance, the package \texttt{wx} will be in the library \texttt{bbwx.dll} (
 
 
 \end{itemize}
-% ==========================================
-\hrule
-
-\paragraph{Summary}
-%\hrule
-\begin{itemize}
-\item The \texttt{include} command tells the interpreter to include a script file.
-\item Lines starting with a \texttt{\#} or with a \texttt{\//\//} are considered as comments by the interpreter.
-\item Lines between a line starting with a \texttt{\//*} an a line ending with a \texttt{*\//} are considered as comments by the interpreter.
-\end{itemize}
-
-\hrule
-% ==========================================
 
 % ==========================================
 \subsubsection{Creating and using command-line applications}