Feature #1774

[bbtk.git] / kernel / doc / config.tex

diff --git a/kernel/doc/config.tex b/kernel/doc/config.tex
index 0bbc54c9afcaf62de94935e684a1ea561500fd3f..2e69bf5b7c54d834c6ddf7ccf1670fe54d73ada2 100644 (file)
--- a/kernel/doc/config.tex
+++ b/kernel/doc/config.tex
@@ -1,3 +1,30 @@
+% # ---------------------------------------------------------------------
+% #
+% # Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
+% #                        pour la SantÈ)
+% # Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
+% # Previous Authors : Laurent Guigues, Jean-Pierre Roux
+% # CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
+% #
+% #  This software is governed by the CeCILL-B license under French law and
+% #  abiding by the rules of distribution of free software. You can  use,
+% #  modify and/ or redistribute the software under the terms of the CeCILL-B
+% #  license as circulated by CEA, CNRS and INRIA at the following URL
+% #  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
+% #  or in the file LICENSE.txt.
+% #
+% #  As a counterpart to the access to the source code and  rights to copy,
+% #  modify and redistribute granted by the license, users are provided only
+% #  with a limited warranty  and the software's author,  the holder of the
+% #  economic rights,  and the successive licensors  have only  limited
+% #  liability.
+% #
+% #  The fact that you are presently reading this means that you have had
+% #  knowledge of the CeCILL-B license and that you accept its terms.
+% # ------------------------------------------------------------------------ */
+%
+
+\usepackage{ifpdf}
 % ==========================================
 \newif\ifpdf 
 \ifx\pdfoutput\undefined \pdffalse % we are not running PDFLaTeX 
@@ -82,15 +109,15 @@
   urlcolor=myblue,%
   menucolor=red,%
   %%------------- Doc Info --------------------------------- 
-  pdftitle={bbtk Users' Guide},%
-  pdfauthor={Laurent Guigues},%
+  pdftitle={The Black Box Toolkit},%
+  pdfauthor={},%
   %%------------ Doc View ----------------------------------}
   pdfhighlight=/P,%
   bookmarksopen=false,%
   plainpages=false,
   pdfpagemode=None}
 
-\hyperbaseurl{http://www.creatis.insa-lyon.fr/\string~guigues/}
+\hyperbaseurl{http://www.creatis.insa-lyon.fr/site/en/CreatoolsBBTK}
 
 \definecolor{myblue}{rgb}{0,0,0.7}
 \definecolor{myred}{rgb}{0.7,0,0}
@@ -99,7 +126,7 @@
 
 % ==========================================
 \def\bbtkVersion{@BBTK_VERSION@}
-
+\def\bbtkVersionDate{@BBTK_VERSION_DATE@}
 \def\todo{\scriptsize\fbox{\bf TODO !!}\normalsize}
 \def\x{\bm{x}}
 \def\BBTK{{\xspace}The {\bf Black Box Toolkit} }
@@ -109,7 +136,13 @@
 \def\bbfy{{\xspace}$\texttt{bbfy}$ }
 \def\bbdoc{{\xspace}$\texttt{bbdoc}$ }
 \def\bbCreatePackage{{\xspace}$\texttt{bbCreatePackage}$ }
+\def\bbPackageBrowser{{\xspace}$\texttt{bbPackageBrowser}$ }
 \def\bbCreateBlackBox{{\xspace}$\texttt{bbCreateBlackBox}$ }
+\def\bbs{{\xspace}$\texttt{bbs}$ }
+\def\bbc{{\xspace}$\texttt{bbc}$ }
+\def\bbRegeneratePackageDoc{{\xspace}$\texttt{bbRegeneratePackageDoc}$ }
+\def\bbRegenerateBoxesLists{{\xspace}$\texttt{bbRegenerateBoxesLists}$ }
+\def\bbPlugPackage{{\xspace}$\texttt{bbPlugPackage}$ }
 
 \def\bb{{\xspace}$\texttt{bb}$ }
 %\def\bbp{{\xspace}$\texttt{bbp}$\xspace}
@@ -136,13 +169,19 @@
 \def\bbtkns{{\xspace}$\texttt{bbtk}$}
 \def\bbins{{\xspace}$\texttt{bbi}$}
 \def\bbfyns{{\xspace}$\texttt{bbfy}$}
-\def\bbStudions{{\xspace}$\texttt{bbStudio}$}
 \def\bbdocns{{\xspace}$\texttt{bbdoc}$}
+\def\bbStudions{{\xspace}$\texttt{bbStudio}$}
 \def\bbCreatePackagens{{\xspace}$\texttt{bbCreatePackage}$}
+\def\bbPackageBrowserns{{\xspace}$\texttt{bbPackageBrowser}$}
 \def\bbCreateBlackBoxns{{\xspace}$\texttt{bbCreateBlackBox}$}
-
+\def\bbsns{{\xspace}$\texttt{bbs}$}
 \def\bbns{{\xspace}$\texttt{bb}$}
+\def\bbcns{{\xspace}$\texttt{bbc}$}
 %\def\bbp{{\xspace}$\texttt{bbp}$\xspace}
+\def\bbRegeneratePackageDocns{{\xspace}$\texttt{bbRegeneratePackageDoc}$}
+\def\bbRegenerateBoxesListsns{{\xspace}$\texttt{bbRegenerateBoxesLists}$}
+\def\bbPlugPackagens{{\xspace}$\texttt{bbPlugPackage}$}
+
 
 \def\cmakens{{\xspace}$\texttt{cmake}$}
 
@@ -161,6 +200,32 @@
 \def\winns{{\xspace}\textit{Windows}}
 
 
+\def\bbtkGuide [#1]{
+\begin{center}
+{\Large \BBTK}
+\vspace{1cm}
+
+{\Huge #1}
+\vspace{1cm}
+
+\bbtk version \bbtkVersion \hspace{2mm}(\bbtkVersionDate)
+\vspace{0.5cm}
+
+Generated on : \today 
+\vspace{0.5cm}
+
+Fr\'ed\'eric Cervenansky, Eduardo D\'avila, Laurent Guigues, Jean-Pierre Roux
+\vspace{0.3cm}
+
+CREATIS, Centre de Recherche en Imagerie M\'edicale \\ 
+CNRS UMR 5220, INSERM U1044, INSA Lyon, Universit\'e Claude-Bernard Lyon 1
+
+http://www.creatis.insa-lyon.fr/site/en/CreatoolsBBTK 
+\end{center}
+\tableofcontents
+\listoftables
+\listoffigures
+}
 
 % ==========================================
 %%% mode: latex