]> Creatis software - bbtk.git/blobdiff - kernel/doc/bbtkPackageDevelopersGuide/bbtkPackageDevelopersGuide.tex
Doc headers
[bbtk.git] / kernel / doc / bbtkPackageDevelopersGuide / bbtkPackageDevelopersGuide.tex
index 9a5ae50c720f18e910164614f1ccad7d63e3b02a..8046e8ff0d83eca6bd2452870b7177ca63275edc 100644 (file)
@@ -1,15 +1,18 @@
+
 % ==========================================
 \documentclass[11pt,final,a4paper]{article}
 \input{config.tex}
 
 
+
 \begin{document}
+
 \begin{center}
 
 {\Large \BBTK}
 \vspace{1cm}
 
-{\Huge Package Developers' Guide}
+{\Huge User's Guide}
 \vspace{1cm}
 
 \bbtk version \bbtkVersion
 Last modified on : October 12, 2008 \\
 Generated on : \today 
 \vspace{0.5cm}
-
-Laurent Guigues, Jean-Pierre Roux
 \end{center}
+\begin{center}
+Eduardo Davila, Laurent Guigues, Jean-Pierre Roux 
+\end{center}
+\begin{center}
+CREATIS-LRMN, Centre de Recherche en Imagerie Medicale \\ CNRS UMR 5220, INSERM U620\\
+INSA Lyon\\
+Universit\'e Claude-Bernard Lyon 1
+\end{center}
+
+
 
 % ==========================================
 \tableofcontents
@@ -89,7 +100,8 @@ the utility \bbfy will then generate the corresponding \CPP code.
 \end{itemize}
 
 
-You'll have to run the standalone application \bbCreateBlackbox allows to create the basic file architecture 
+
+You'll have to run the standalone application \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.
 
 \end{enumerate}
@@ -127,7 +139,7 @@ That will creates the directory structure and the \texttt{cmake}
 files necessary to build the project.
 
 You must then decide the name of your new package. 
-This name will be used to load the package in \texttt{bbi}.
+This name will be used to load the package by \texttt{bbStudio}.
 Fill up the form like in fig. \ref{bbFillUpPackageForm}.
 
 
@@ -801,8 +813,7 @@ a \texttt{wxWindow} and is be able to return a pointer to it.... \\ \hline
 
 % ==========================================
 \begin{table}[!ht]
-\caption{\label{categories}
-\bbfy \texttt{Black Box} categories}
+\caption{\label{categories} \texttt{bbfy} \texttt{Black Box} categories}
 \small
 \begin{tabular}{|ll|}
 \hline
@@ -933,7 +944,7 @@ For a quick start, the best you have to do is to run \texttt{bbStudio}, then in
     \item \texttt{BBTK\_NAME} : the name of your box 
     \item \texttt{BBTK\_AUTHOR} : author name (better you put e-mail adress)
     \item \texttt{BBTK\_DESCRIPTION} : brief description of what does the box
-    \item \texttt{BBTK\_CATEGORY} :box category  (see table \ref{categories})
+    \item \texttt{BBTK\_CATEGORY} : box category  (see table \ref{categories})
     \item \texttt{BBTK\_INPUT} for each one of the input parameters, you have to supply : 
        \begin{itemize}
          \item The current Blackbox name.