doc/config.tex

   1 % ---------------------------------------------------------------------
   2 %
   3 % Copyright (c) CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image
   4 %                        pour la Santé)
   5 % Authors : Eduardo Davila, Frederic Cervenansky, Claire Mouton
   6 % Previous Authors : Laurent Guigues, Jean-Pierre Roux
   7 % CreaTools website : www.creatis.insa-lyon.fr/site/fr/creatools_accueil
   8 %
   9 %  This software is governed by the CeCILL-B license under French law and
  10 %  abiding by the rules of distribution of free software. You can  use,
  11 %  modify and/ or redistribute the software under the terms of the CeCILL-B
  12 %  license as circulated by CEA, CNRS and INRIA at the following URL
  13 %  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  14 %  or in the file LICENSE.txt.
  15 %
  16 %  As a counterpart to the access to the source code and  rights to copy,
  17 %  modify and redistribute granted by the license, users are provided only
  18 %  with a limited warranty  and the software's author,  the holder of the
  19 %  economic rights,  and the successive licensors  have only  limited
  20 %  liability.
  21 %
  22 %  The fact that you are presently reading this means that you have had
  23 %  knowledge of the CeCILL-B license and that you accept its terms.
  24 % ------------------------------------------------------------------------
  25
  26 % ==========================================
  27 \newif\ifpdf
  28 \ifx\pdfoutput\undefined \pdffalse % we are not running PDFLaTeX
  29 \else
  30 \pdfoutput=1 \pdftrue % we are running PDFLaTeX
  31 \fi
  32 % ==========================================
  33 \usepackage[a4paper,textwidth=14cm]{geometry}
  34 \usepackage[latin1]{inputenc}
  35 \usepackage{varioref}
  36 \usepackage{url}
  37 \usepackage{multicol}
  38 \usepackage{colortbl}
  39 %\usepackage[active]{srcltx}
  40 \usepackage{color}
  41 \usepackage[english]{babel}
  42 %\usepackage{picins}
  43 %\usepackage{fancyhdr}
  44 %\usepackage{picins}
  45 \usepackage{xspace}
  46 % ==========================================
  47 %%% Math
  48 \usepackage{amsmath,amsfonts,amssymb}
  49 \usepackage{bm}
  50 \usepackage{theorem}
  51 \usepackage{stmaryrd}
  52
  53 % ==========================================
  54 %%% Graphics
  55 \usepackage{graphics}
  56 \ifpdf
  57 \usepackage[pdftex]{graphicx}
  58 \else
  59 \usepackage[ps2pdf]{graphicx}
  60 \fi
  61 \graphicspath{{figs/}}
  62
  63 % ==========================================
  64 % bib
  65 \usepackage{natbib}
  66 %\bibliographystyle{abbrvnat}
  67 \bibliographystyle{plainnat}
  68
  69 %\bibliographystyle{plain}
  70
  71 % http://merkel.zoneo.net/Latex/natbib.php?lang=fr
  72
  73 % ==========================================
  74 %% PDF configuration
  75 % http://www.p-joeckel.de/pdflatex/)
  76 % http://ringlord.com/publications/latex-pdf-howto/
  77
  78 %%%% Options of pdflatex
  79 \ifpdf
  80 \DeclareGraphicsExtensions{.pdf,.jpg,.mps,.png,.eps}
  81 \usepackage[pdftex,                %
  82     bookmarks         = true,%     % Signets
  83     bookmarksnumbered = true,%     % Signets numérotés
  84     pdfpagemode       = None,%     % Signets/vignettes fermé à l'ouverture
  85     pdfstartview      = FitH,%     % La page prend toute la largeur
  86     pdfpagelayout     = SinglePage,% Vue par page
  87     colorlinks        = true,%     % Liens en couleur
  88     urlcolor          = magenta,%  % Couleur des liens externes
  89     pdfborder         = {0 0 0}%   % Style de bordure : ici, pas de bordure
  90     ]{hyperref}%                   % Utilisation de HyperTeX
  91 %\usepackage[pdftex,bookmarks,pagebackref]{hyperref}
  92 \pdfadjustspacing=1
  93
  94 %%%% Options for latex + dvips -Ppdf + ps2pdf
  95 \else
  96 \DeclareGraphicsExtensions{.eps,.ps}
  97 \usepackage[ps2pdf,bookmarks,pagebackref]{hyperref}
  98 \fi
  99
 100 %%%% Commun options
 101 \hypersetup{
 102   linktocpage,%
 103   %%------------- Color Links ------------------------------
 104   colorlinks=true,%
 105   linkcolor=myred,%
 106   citecolor=mydarkblue,%
 107   urlcolor=myblue,%
 108   menucolor=red,%
 109   %%------------- Doc Info ---------------------------------
 110   pdftitle={The Black Box Toolkit},%
 111   pdfauthor={},%
 112   %%------------ Doc View ----------------------------------}
 113   pdfhighlight=/P,%
 114   bookmarksopen=false,%
 115   plainpages=false,
 116   pdfpagemode=None}
 117
 118 \hyperbaseurl{http://www.creatis.insa-lyon.fr/creatools/bbtk}
 119
 120 \definecolor{myblue}{rgb}{0,0,0.7}
 121 \definecolor{myred}{rgb}{0.7,0,0}
 122 \definecolor{mygreen}{rgb}{0,0.7,0}
 123 \definecolor{mydarkblue}{rgb}{0,0,0.5}
 124
 125 % ==========================================
 126 \def\bbtkVersion{@BBTK_VERSION@}
 127 \def\bbtkVersionDate{@BBTK_VERSION_DATE@}
 128 \def\todo{\scriptsize\fbox{\bf TODO !!}\normalsize}
 129 \def\x{\bm{x}}
 130 \def\BBTK{{\xspace}The {\bf Black Box Toolkit} }
 131 \def\bbtk{{\xspace}$\texttt{bbtk}$ }
 132 \def\bbi{{\xspace}$\texttt{bbi}$ }
 133 \def\bbStudio{{\xspace}$\texttt{bbStudio}$ }
 134 \def\bbfy{{\xspace}$\texttt{bbfy}$ }
 135 \def\bbdoc{{\xspace}$\texttt{bbdoc}$ }
 136 \def\bbCreatePackage{{\xspace}$\texttt{bbCreatePackage}$ }
 137 \def\bbPackageBrowser{{\xspace}$\texttt{bbPackageBrowser}$ }
 138 \def\bbCreateBlackBox{{\xspace}$\texttt{bbCreateBlackBox}$ }
 139 \def\bbs{{\xspace}$\texttt{bbs}$ }
 140 \def\bbc{{\xspace}$\texttt{bbc}$ }
 141 \def\bbRegeneratePackageDoc{{\xspace}$\texttt{bbRegeneratePackageDoc}$ }
 142 \def\bbRegenerateBoxesLists{{\xspace}$\texttt{bbRegenerateBoxesLists}$ }
 143 \def\bbPlugPackage{{\xspace}$\texttt{bbPlugPackage}$ }
 144
 145 \def\bb{{\xspace}$\texttt{bb}$ }
 146 %\def\bbp{{\xspace}$\texttt{bbp}$\xspace}
 147
 148 \def\cmake{{\xspace}$\texttt{cmake}$ }
 149
 150 \def\C{{\xspace}$\texttt{C}$ }
 151 \def\CPP{{\xspace}$\texttt{C++}$ }
 152
 153 \def\xml{{\xspace}$\texttt{xml}$ }
 154
 155 \def\itk{{\xspace}$\texttt{itk}$ }
 156 \def\vtk{{\xspace}$\texttt{vtk}$ }
 157 \def\gdcm{{\xspace}$\texttt{gdcm}$ }
 158 \def\gsmis{{\xspace}$\texttt{gsmis}$ }
 159 \def\wx{{\xspace}$\texttt{wxWidgets}$ }
 160
 161 \def\lin{{\xspace}\textit{Linux} }
 162 \def\win{{\xspace}\textit{Windows} }
 163
 164 % the same macros with no space at the end
 165
 166 \def\BBTKns{{\xspace}The {\bf Black Box Toolkit}}
 167 \def\bbtkns{{\xspace}$\texttt{bbtk}$}
 168 \def\bbins{{\xspace}$\texttt{bbi}$}
 169 \def\bbfyns{{\xspace}$\texttt{bbfy}$}
 170 \def\bbdocns{{\xspace}$\texttt{bbdoc}$}
 171 \def\bbStudions{{\xspace}$\texttt{bbStudio}$}
 172 \def\bbCreatePackagens{{\xspace}$\texttt{bbCreatePackage}$}
 173 \def\bbPackageBrowserns{{\xspace}$\texttt{bbPackageBrowser}$}
 174 \def\bbCreateBlackBoxns{{\xspace}$\texttt{bbCreateBlackBox}$}
 175 \def\bbsns{{\xspace}$\texttt{bbs}$}
 176 \def\bbns{{\xspace}$\texttt{bb}$}
 177 \def\bbcns{{\xspace}$\texttt{bbc}$}
 178 %\def\bbp{{\xspace}$\texttt{bbp}$\xspace}
 179 \def\bbRegeneratePackageDocns{{\xspace}$\texttt{bbRegeneratePackageDoc}$}
 180 \def\bbRegenerateBoxesListsns{{\xspace}$\texttt{bbRegenerateBoxesLists}$}
 181 \def\bbPlugPackagens{{\xspace}$\texttt{bbPlugPackage}$}
 182
 183
 184 \def\cmakens{{\xspace}$\texttt{cmake}$}
 185
 186 \def\Cns{{\xspace}$\texttt{C}$}
 187 \def\CPPns{{\xspace}$\texttt{C++}$}
 188
 189 \def\xmlns{{\xspace}$\texttt{xml}$}
 190
 191 \def\itkns{{\xspace}$\texttt{itk}$}
 192 \def\vtkns{{\xspace}$\texttt{vtk}$}
 193 \def\gdcmns{{\xspace}$\texttt{gdcm}$}
 194 \def\gsmisns{{\xspace}$\texttt{gsmis}$}
 195 \def\wxns{{\xspace}$\texttt{wxWidgets}$}
 196
 197 \def\linns{{\xspace}\textit{Linux}}
 198 \def\winns{{\xspace}\textit{Windows}}
 199
 200
 201 \def\bbtkGuide [#1]{
 202 \begin{center}
 203 {\Large \BBTK}
 204 \vspace{1cm}
 205
 206 {\Huge #1}
 207 \vspace{1cm}
 208
 209 \bbtk version \bbtkVersion \hspace{2mm}(\bbtkVersionDate)
 210 \vspace{0.5cm}
 211
 212 Generated on : \today
 213 \vspace{0.5cm}
 214
 215 Eduardo D\'avila, Laurent Guigues, Jean-Pierre Roux
 216 \vspace{0.3cm}
 217
 218 CREATIS (Centre de Recherche en Acquisition et Traitement de l'Image pour la Sant\'e) \\
 219 CNRS UMR 5220, INSERM U620, INSA Lyon, Universit\'e Claude-Bernard Lyon 1
 220
 221 http://www.creatis.insa-lyon.fr/creatools/bbtk
 222 \end{center}
 223 \tableofcontents
 224 \listoftables
 225 \listoffigures
 226 }
 227
 228 % ==========================================
 229 %%% mode: latex
 230 %%% TeX-master: "bbtkUsersGuide"
 231 %%% End:
 232
 233 \newcounter{Ctrfile}
 234 %% env
 235 \newenvironment{file}[1]
 236 {
 237 \bigskip\hrule\smallskip
 238 \stepcounter{Ctrfile}
 239 \textbf{File #1}
 240 %\hspace{0.2cm}\arabic{Ctrfile}\hfill \textbf{#1}
 241 \smallskip\hrule\medskip
 242 %\algocaption{#1}
 243 }
 244 {
 245 \hrule\smallskip
 246 \hfill\textbf{End of file}
 247 \smallskip\hrule
 248 \bigskip
 249 }