\subsection{Content of this guide}
% ==========================================
-
+Read this \texttt{Users' Guide} if you want to learn how to use
+\bbtk development environnement (\bbStudions) and how to write black box scripts.\\
+If you aim is to write your own Packages and Black Boxes, you have to read the
+\texttt{Package Developper's Guide}.
% ==========================================
\newpage
\end{center}
\end{figure}
-Feel free to move the slider, to check it actually works...
+Feel free to move the slider, to check whether it actually works...
%\newpage
\subsection{Online Help}
% ==============================================
-Various levels or help are suplied by \bbStudions.
+Various levels or help are supplied by \bbStudions.
% ==========================================
\subsubsection{Command line help}
\item {\bf\emph{List by package}} Boxes indexed by package
\item {\bf\emph{List by category}} :
Each box is indexed by a list of keywords, called 'categories', such as '\texttt{read/write}',
- '\texttt{filter}' '\texttt{viewer}', ...
+ '\texttt{filter}', '\texttt{viewer}', ...
A given box may belong to more than one \texttt{category}, however some categories are mutually exclusive.
Standard categories are :
\begin {itemize}
\item\texttt{atomic box}/\texttt{complex box}\\
- Whether it's a 'atomic' unit written is C++ and available in binary form in a package or it's an assembly of several black boxes (atomic or complex) which is described in \bbs script language.\\
+ Whether it's an 'atomic' unit written is C++ and available in binary form in a package or it's an assembly of several black boxes (atomic or complex) which is described in \bbs script language.\\
Any box is either atomic ou complex.\\
Any pipeline described in a \bbs script is itself viewed as a complex black box hence is tagged as belonging to this category.
\item\texttt{example} / \texttt{demo} / \texttt{application}\\
- These ones are scripts which produce a result when executed (i.e. they execute a pipeline like \texttt{exampleSlider} above), contrarily to the scripts which only define complex boxes but do not instanciate and execute boxes.
+ These ones are scripts which produce a result when executed (i.e. they
+ execute a pipeline like \texttt{exampleSlider} above), as oposite to the scripts which only define complex boxes but do not instanciate and execute boxes.
\begin {itemize}
\item\texttt{example} : It's just a (simple) example, for programmers, on how to use a given feature. The \texttt{Examples} link on the starting page links to the list of the boxes of this category.
\item\texttt{demo} : It can be a 'good looking' (a.k.a 'sexy') example on some sophisticated work, done only by using \texttt{bbtk}. The \texttt{Demos} link on the starting page links to the list of the boxes of this category.
- \item\texttt{application} : It's a final application, end user intended (e.g. Subscale a huge volume witout loading it in memory, Crop a DICOM image, etc.)
+ \item\texttt{application} : It's a final application, end user intended (e.g. Subscale a huge volume without loading it in memory, Crop a DICOM image, etc.)
\end {itemize}
\item\texttt{widget} : A piece of graphical interface (based on \texttt{wxWidgets})
\item\texttt{dicom} : Dicom medical image-related box.