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