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