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