From: jean-pierre roux <jean-pierre.roux@creatis.insa-lyon.fr>
Date: Thu, 16 Oct 2008 08:23:49 +0000 (+0000)
Subject: New features (plug package)
X-Git-Tag: v0.8.0~10
X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=commitdiff_plain;h=fa700291ecf0b994f9ebf0993791048fc66b096d;p=bbtk.git

New features (plug package)
---

diff --git a/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex b/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex
index d5503f6..9679dd0 100644
--- a/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex
+++ b/kernel/doc/bbtkUsersGuide/bbtkUsersGuide.tex
@@ -18,12 +18,12 @@
 \vspace{0.5cm}
 
 
-Last modified on : October 12, 2008 \\
+Last modified on : October 16, 2008 \\
 Generated on : \today 
 \vspace{0.5cm}
 \end{center}
 \begin{center}
-Eduardo Davila, Laurent Guigues, Jean-Pierre Roux 
+Eduardo D\'avila, Laurent Guigues, Jean-Pierre Roux 
 \end{center}
 \begin{center}
 CREATIS-LRMN, Centre de Recherche en Imagerie Medicale \\ CNRS UMR 5220, INSERM U620\\
@@ -2064,9 +2064,34 @@ Linux users : Don't forget to \texttt{sudo} before.
 \section{Using third party Package}
 \label{Third_Party_Package}
 % ==========================================
+% ==========================================
+\subsection{Plugging in a Package}
+\label{Plugging_in_a_Package}
+% ==========================================
+
+\bbStudio makes it easy for you : in the menu \texttt{Tools} just click on the 
+option \texttt{Plug Package}. You will be asked to  to '\texttt{Select
+package directory}'. Browse untill you find the the install tree, or the the build tree,
+depending whether you installed the package or not.\\
+
+\bbStudio will update the Configuration file, generate the 'Package
+documentaion', and update the 'Box List'.\\
+You will be able to use the new package just as you did for any other \bbtk
+canonical Package.
+
+% ==========================================
+\subsection{Hard incorporating of a Package}
+\label{Hard_incorporating_of_a_Package}
+% ==========================================
+
+If the Package you want to use is supplied in a non standard way (e.g. : you
+where given one ore more dynamic libraries (\texttt{.dll} or \texttt{.so}), and
+one or more directories containing \bbtk scripts (\texttt{.bbs}), you will have
+to proceed to some (simple) manual operations.\\
+\texttt{Nota bene} : This way is hightly discouraged !
 
 % ==========================================
-\subsection{The configuration file}
+\subsubsection{More on the configuration file}
 \label{The_configuration_file}
 % ==========================================
 
@@ -2099,7 +2124,7 @@ You'll get something like :
 (depending on who you are, and whether \texttt{bbStudio} is installed or not.)\\
 
 Note the two main parts : \texttt{BBS Paths} and \texttt{PACKAGE Paths}
-\subsection{How bbStudio uses the Configuration file}
+\subsubsection{How bbStudio uses the Configuration file}
 \label{How_bbStudio_uses_the_Configuration_file}
 
 
@@ -2125,7 +2150,7 @@ a new one in the \texttt{.bbtk} directory.
 
 To use a third party Package, you will have to update it.\\
 
-\subsection{Modifying the Configuration file}
+\subsubsection{Modifying the Configuration file}
 \label{Modifying_the_Configuration_file}
 
 Just use the \texttt{Open bbtk Config file} option of the \texttt{Files} of the \bbStudio menu.
@@ -2147,7 +2172,7 @@ You will get something like :
 </config>
 \end{verbatim}
 
-To use a nex Package :
+To use a new Package :
 \begin{itemize}
 \item {}
 After the already existing \texttt{xml} tags 
@@ -2190,13 +2215,15 @@ you can add paths to :
 \subsection{Updating the documentation}
 \label{Updating_the_documentation}
 % ==========================================
-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 may add your own boxes (simple boxes, if you are aware enough in \CPP
+language), or complex boxes if you are aware enough in bbtk scripting).
+
+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
+To benefit the features of Box indexing you must use the
 option \texttt{Regenerate Boxes Lists}  in the menu \texttt{Tools} of \texttt{bbStudio}.\\
 
 
@@ -2213,9 +2240,12 @@ The only thing you have to do is to \texttt{load} the package, within the script
 \label{Packages_you_ll_want_to_use}
 % ==========================================
 \begin {itemize}
+\item{\texttt{creaLib}} \\
+a.k.a \texttt{crea}. It's a set of 'low level' utilities, needed by other
+packages (an, sure,  useful as well for people that doesn't use bbtkns.
 
 \item{\texttt{creaContours}} \\
-Provides sophisticated widgets for managing 3D R.O.I. (Regions od interest)
+Provides sophisticated widgets for managing 3D R.O.I. (Regions of interest)
 \item{\texttt{creaImageIO}} \\
 Allows browsing, selectionning, ordering directories containing images of almost any type
 (including DICOM)