SET(USE_TTH ON CACHE BOOL "" FORCE)
# Construct absolute build path
SET(BUILD_PATH ${BBTK_DOC_BUILD_PATH}/${OUTPUT_REL_PATH})
+MESSAGE(STATUS "DOC_BUILD_PATH=${BUILD_PATH}")
#-------------------------------------------------------------------------
## MESSAGE(STATUS ${LATEX_tth_CONVERTER})
${BUILD_PATH}/config.tex
COPYONLY
)
+ CONFIGURE_FILE(
+ ${CMAKE_CURRENT_SOURCE_DIR}/../config.tex
+ ${CMAKE_CURRENT_BINARY_DIR}/config.tex
+ COPYONLY
+ )
#---------------------------------------------------------------------------
FILE(TO_NATIVE_PATH ${BUILD_PATH} THE_BUILD_PATH)
\input{config.tex}
-\def\todo{\scriptsize\fbox{\bf TODO !!}\normalsize}
-\def\x{\bm{x}}
-\def\BBTK{{\xspace}The {\bf Black Box Toolkit} }
-\def\bbtk{{\xspace}$\texttt{bbtk}$ }
-\def\bbi{{\xspace}$\texttt{bbi}$ }
-\def\bbStudio{{\xspace}$\texttt{bbStudio}$ }
-\def\bbfy{{\xspace}$\texttt{bbfy}$ }
-\def\bbdoc{{\xspace}$\texttt{bbdoc}$ }
-\def\bbCreatePackage{{\xspace}$\texttt{bbCreatePackage}$ }
-
-\def\bb{{\xspace}$\texttt{bb}$ }
-%\def\bbp{{\xspace}$\texttt{bbp}$\xspace}
-
-\def\cmake{{\xspace}$\texttt{cmake}$ }
-
-\def\C{{\xspace}$\texttt{C}$ }
-\def\CPP{{\xspace}$\texttt{C++}$ }
-
-\def\xml{{\xspace}$\texttt{xml}$ }
-
-\def\itk{{\xspace}$\texttt{itk}$ }
-\def\vtk{{\xspace}$\texttt{vtk}$ }
-\def\gdcm{{\xspace}$\texttt{gdcm}$ }
-\def\gsmis{{\xspace}$\texttt{gsmis}$ }
-\def\wx{{\xspace}$\texttt{wxWidgets}$ }
-
-\def\lin{{\xspace}\textit{Linux} }
-\def\win{{\xspace}\textit{Windows} }
-
-% the same macros with no space at the end
-
-\def\BBTKns{{\xspace}The {\bf Black Box Toolkit}}
-\def\bbtkns{{\xspace}$\texttt{bbtk}$}
-\def\bbins{{\xspace}$\texttt{bbi}$}
-\def\bbfyns{{\xspace}$\texttt{bbfy}$}
-\def\bbdocns{{\xspace}$\texttt{bbdoc}$}
-\def\bbCreatePackagens{{\xspace}$\texttt{bbCreatePackage}$}
-
-\def\bbns{{\xspace}$\texttt{bb}$}
-%\def\bbp{{\xspace}$\texttt{bbp}$\xspace}
-
-\def\cmakens{{\xspace}$\texttt{cmake}$}
-
-\def\Cns{{\xspace}$\texttt{C}$}
-\def\CPPns{{\xspace}$\texttt{C++}$}
-
-\def\xmlns{{\xspace}$\texttt{xml}$}
-
-\def\itkns{{\xspace}$\texttt{itk}$}
-\def\vtkns{{\xspace}$\texttt{vtk}$}
-\def\gdcmns{{\xspace}$\texttt{gdcm}$}
-\def\gsmisns{{\xspace}$\texttt{gsmis}$}
-\def\wxns{{\xspace}$\texttt{wxWidgets}$}
-
-\def\linns{{\xspace}\textit{Linux}}
-\def\winns{{\xspace}\textit{Windows}}
-
\author{L. Guigues}
\title{The Black Box Tool Kit\\Developers' Guide}
\input{config.tex}
-\def\todo{\scriptsize\fbox{\bf TODO !!}\normalsize}
-\def\x{\bm{x}}
-\def\BBTK{{\xspace}The {\bf Black Box Toolkit} }
-\def\bbtk{{\xspace}$\texttt{bbtk}$ }
-\def\bbi{{\xspace}$\texttt{bbi}$ }
-\def\bbStudio{{\xspace}$\texttt{bbStudio}$ }
-\def\bbfy{{\xspace}$\texttt{bbfy}$ }
-\def\bbdoc{{\xspace}$\texttt{bbdoc}$ }
-\def\bbCreatePackage{{\xspace}$\texttt{bbCreatePackage}$ }
-
-\def\bb{{\xspace}$\texttt{bb}$ }
-%\def\bbp{{\xspace}$\texttt{bbp}$\xspace}
-
-\def\cmake{{\xspace}$\texttt{cmake}$ }
-
-\def\C{{\xspace}$\texttt{C}$ }
-\def\CPP{{\xspace}$\texttt{C++}$ }
-
-\def\xml{{\xspace}$\texttt{xml}$ }
-
-\def\itk{{\xspace}$\texttt{itk}$ }
-\def\vtk{{\xspace}$\texttt{vtk}$ }
-\def\gdcm{{\xspace}$\texttt{gdcm}$ }
-\def\gsmis{{\xspace}$\texttt{gsmis}$ }
-\def\wx{{\xspace}$\texttt{wxWidgets}$ }
-
-\def\lin{{\xspace}\textit{Linux} }
-\def\win{{\xspace}\textit{Windows} }
-
-% the same macros with no space at the end
-
-\def\BBTKns{{\xspace}The {\bf Black Box Toolkit}}
-\def\bbtkns{{\xspace}$\texttt{bbtk}$}
-\def\bbins{{\xspace}$\texttt{bbi}$}
-\def\bbfyns{{\xspace}$\texttt{bbfy}$}
-\def\bbdocns{{\xspace}$\texttt{bbdoc}$}
-\def\bbCreatePackagens{{\xspace}$\texttt{bbCreatePackage}$}
-
-\def\bbns{{\xspace}$\texttt{bb}$}
-%\def\bbp{{\xspace}$\texttt{bbp}$\xspace}
-
-\def\cmakens{{\xspace}$\texttt{cmake}$}
-
-\def\Cns{{\xspace}$\texttt{C}$}
-\def\CPPns{{\xspace}$\texttt{C++}$}
-
-\def\xmlns{{\xspace}$\texttt{xml}$}
-
-\def\itkns{{\xspace}$\texttt{itk}$}
-\def\vtkns{{\xspace}$\texttt{vtk}$}
-\def\gdcmns{{\xspace}$\texttt{gdcm}$}
-\def\gsmisns{{\xspace}$\texttt{gsmis}$}
-\def\wxns{{\xspace}$\texttt{wxWidgets}$}
-
-\def\linns{{\xspace}\textit{Linux}}
-\def\winns{{\xspace}\textit{Windows}}
-
-
\begin{document}
\title{The Black Box Toolkit\\Package Developers' Guide}
\date{\today}
\input{config.tex}
-\def\todo{\scriptsize\fbox{\bf TODO !!}\normalsize}
-\def\x{\bm{x}}
-\def\BBTK{{\xspace}The {\bf Reference Manual} }
-\def\bbtk{{\xspace}$\texttt{bbtk}$ }
-\def\bbi{{\xspace}$\texttt{bbi}$ }
-\def\bbStudio{{\xspace}$\texttt{bbStudio}$ }
-\def\bbfy{{\xspace}$\texttt{bbfy}$ }
-\def\bbdoc{{\xspace}$\texttt{bbdoc}$ }
-\def\bbCreatePackage{{\xspace}$\texttt{bbCreatePackage}$ }
-
-\def\bb{{\xspace}$\texttt{bb}$ }
-%\def\bbp{{\xspace}$\texttt{bbp}$\xspace}
-
-\def\cmake{{\xspace}$\texttt{cmake}$ }
-
-\def\C{{\xspace}$\texttt{C}$ }
-\def\CPP{{\xspace}$\texttt{C++}$ }
-
-\def\xml{{\xspace}$\texttt{xml}$ }
-
-\def\itk{{\xspace}$\texttt{itk}$ }
-\def\vtk{{\xspace}$\texttt{vtk}$ }
-\def\gdcm{{\xspace}$\texttt{gdcm}$ }
-\def\gsmis{{\xspace}$\texttt{gsmis}$ }
-\def\wx{{\xspace}$\texttt{wxWidgets}$ }
-
-\def\lin{{\xspace}\textit{Linux} }
-\def\win{{\xspace}\textit{Windows} }
-
-% the same macros with no space at the end
-
-\def\BBTKns{{\xspace}The {\bf Black Box Toolkit}}
-\def\bbtkns{{\xspace}$\texttt{bbtk}$}
-\def\bbins{{\xspace}$\texttt{bbi}$}
-\def\bbfyns{{\xspace}$\texttt{bbfy}$}
-\def\bbdocns{{\xspace}$\texttt{bbdoc}$}
-\def\bbCreatePackagens{{\xspace}$\texttt{bbCreatePackage}$}
-
-\def\bbns{{\xspace}$\texttt{bb}$}
-%\def\bbp{{\xspace}$\texttt{bbp}$\xspace}
-
-\def\cmakens{{\xspace}$\texttt{cmake}$}
-
-\def\Cns{{\xspace}$\texttt{C}$}
-\def\CPPns{{\xspace}$\texttt{C++}$}
-
-\def\xmlns{{\xspace}$\texttt{xml}$}
-
-\def\itkns{{\xspace}$\texttt{itk}$}
-\def\vtkns{{\xspace}$\texttt{vtk}$}
-\def\gdcmns{{\xspace}$\texttt{gdcm}$}
-\def\gsmisns{{\xspace}$\texttt{gsmis}$}
-\def\wxns{{\xspace}$\texttt{wxWidgets}$}
-
-\def\linns{{\xspace}\textit{Linux}}
-\def\winns{{\xspace}\textit{Windows}}
-
-
\begin{document}
\input{config.tex}
-\def\todo{\scriptsize\fbox{\bf TODO !!}\normalsize}
-\def\x{\bm{x}}
-\def\BBTK{{\xspace}The {\bf Black Box Toolkit} }
-\def\bbtk{{\xspace}$\texttt{bbtk}$ }
-\def\bbi{{\xspace}$\texttt{bbi}$ }
-\def\bbStudio{{\xspace}$\texttt{bbStudio}$ }
-\def\bbfy{{\xspace}$\texttt{bbfy}$ }
-\def\bbdoc{{\xspace}$\texttt{bbdoc}$ }
-\def\bbCreatePackage{{\xspace}$\texttt{bbCreatePackage}$ }
-
-\def\bb{{\xspace}$\texttt{bb}$ }
-%\def\bbp{{\xspace}$\texttt{bbp}$\xspace}
-
-\def\cmake{{\xspace}$\texttt{cmake}$ }
-
-\def\C{{\xspace}$\texttt{C}$ }
-\def\CPP{{\xspace}$\texttt{C++}$ }
-
-\def\xml{{\xspace}$\texttt{xml}$ }
-
-\def\itk{{\xspace}$\texttt{itk}$ }
-\def\vtk{{\xspace}$\texttt{vtk}$ }
-\def\gdcm{{\xspace}$\texttt{gdcm}$ }
-\def\gsmis{{\xspace}$\texttt{gsmis}$ }
-\def\wx{{\xspace}$\texttt{wxWidgets}$ }
-
-\def\lin{{\xspace}\textit{Linux} }
-\def\win{{\xspace}\textit{Windows} }
-
-% the same macros with no space at the end
-
-\def\BBTKns{{\xspace}The {\bf Black Box Toolkit}}
-\def\bbtkns{{\xspace}$\texttt{bbtk}$}
-\def\bbins{{\xspace}$\texttt{bbi}$}
-\def\bbfyns{{\xspace}$\texttt{bbfy}$}
-\def\bbdocns{{\xspace}$\texttt{bbdoc}$}
-\def\bbCreatePackagens{{\xspace}$\texttt{bbCreatePackage}$}
-
-\def\bbns{{\xspace}$\texttt{bb}$}
-%\def\bbp{{\xspace}$\texttt{bbp}$\xspace}
-
-\def\cmakens{{\xspace}$\texttt{cmake}$}
-
-\def\Cns{{\xspace}$\texttt{C}$}
-\def\CPPns{{\xspace}$\texttt{C++}$}
-
-\def\xmlns{{\xspace}$\texttt{xml}$}
-
-\def\itkns{{\xspace}$\texttt{itk}$}
-\def\vtkns{{\xspace}$\texttt{vtk}$}
-\def\gdcmns{{\xspace}$\texttt{gdcm}$}
-\def\gsmisns{{\xspace}$\texttt{gsmis}$}
-\def\wxns{{\xspace}$\texttt{wxWidgets}$}
-
-\def\linns{{\xspace}\textit{Linux}}
-\def\winns{{\xspace}\textit{Windows}}
-
-
-
\begin{document}
\begin{center}
\end{itemize}
\item A full {\bf\emph{documentation}} printable (pdf), browsable (html), queryable thru keywords.
\end{itemize}
+
The general architecture of \BBTK
is shown in figure \ref{bb-architecture}.
\item {\bf\emph{Boxes}} : Box retrieving on various criterions :
\begin{itemize}
- \item {\bf\emph{ \texttt{By name}}} (Alphabetical list),
- \item {\bf\emph{ \texttt{{By package}}},
- \item {\bf\emph{ \texttt{{By category}}}.
+ \item {\bf\emph{ \texttt{By name}}} (Alphabetical list),
+ \item {\bf\emph{ \texttt{By package}}},
+ \item {\bf\emph{ \texttt{By category}}}.
\end{itemize}
A special hidden Box category, called \texttt{{Adaptors}} exists. \\
connect slider.Out text.In
\end{verbatim}
We tell \emph{slider} to inform \emph{text} every time it's modified.\\
-We tell \emph{slider} to pass its output value (\texttt{Out} to \emph{text} input value (\testtt{In})
+We tell \emph{slider} to pass its output value (\texttt{Out} to \emph{text} input value (\texttt{In})
\begin{verbatim}
exec layout
\end{verbatim}
\end{itemize}
- \end{itemize}
% ==========================================
\subsubsection{Boxes Help}
% ==========================================
- Box retrieving on various criterions :
+ Box retrieving on various criteria :
\begin{itemize}
\item {\bf\emph{Alphabetical list}} \\ This is the 'zero-level' of retrieving.
\item {\bf\emph{List by package}} \\ Several packages are supplied with bbtk :
\item{misc}
\end {itemize}
\end {itemize}
+
% ==============================================
\subsection{The Menu}
% ==============================================
\texttt{'Always'}, which forces box reprocessing.
\end{itemize}
-Note that all boxes have an input named \texttt{'BoxProcessMode'}.\\
+Note that all boxes have an input named \texttt{'BoxProcessMode'}.
Another way to process the box \texttt{a} is to issue the command :
\begin{verbatim}
It just processes the box if needed.
This command is used to execute boxes that do not have any output,
such as boxes that write something to a file or, display a
-graphical interface, and so on. \\
+graphical interface, and so on.
%To exit \bbi, type :
%\begin{verbatim}
ccmake ../bbtk
\end{verbatim}
-Don't forget to switch ON the flag \textttBBTK\_COMPILE\_DEBUG\_MESSAGE \\
+Don't forget to switch ON the flag \texttt{BBTK\_COMPILE\_DEBUG\_MESSAGE} \\
(see figure : \ref{bb-ccmake})
\begin{figure}[!ht]
-\caption{\label{bb-ccmake}\Running ccmake}
+\caption{\label{bb-ccmake}Running ccmake}
\begin{center}
\includegraphics[width=0.6\textwidth]{ccmake.png}
\end{center}
For some strange reasons (?!?), you may be warned that an error occured while documentation generation.\\
Take it easy, \texttt{make} again!\\
-The dynamic libraries (\texttt{.dll} or \texttt{.so} and the executable programs will be created in the \testtt{bin}
+The dynamic libraries (\texttt{.dll} or \texttt{.so} and the executable programs will be created in the \texttt{bin}
directory of the built tree.
\item choose to install or not your own version.
\newpage
% ==========================================
-\vspace{0.5cm}\hrule \\
+%\vspace{0.5cm}\hrule \\
+
+
\section{The Package Browser}
\label{Package_Browser}
% ==========================================
% ==========================================
-\vspace{0.5cm}\hrule \\
+%\vspace{0.5cm}\hrule \\
+
\section{Using third party Package}
\label{Third_Party_Package}
% ==========================================
If you want (and sure you will) to be able to use the Help tools as well on the features provided by this package, you must use the
option \texttt{Generate index} in the menu \texttt{Tools} of the \texttt{Files} part toolbar.
% ==========================================
-\vspace{0.5cm}\hrule \\
+%\vspace{0.5cm}\hrule \\
\section{Using black boxes in \CPP programs}
\label{cpp}
% ==========================================
\usepackage{color}
\usepackage[english]{babel}
%\usepackage{picins}
-\usepackage{fancyhdr}
+%\usepackage{fancyhdr}
%\usepackage{picins}
\usepackage{xspace}
% ==========================================
% ==========================================
+\def\todo{\scriptsize\fbox{\bf TODO !!}\normalsize}
+\def\x{\bm{x}}
+\def\BBTK{{\xspace}The {\bf Black Box Toolkit} }
+\def\bbtk{{\xspace}$\texttt{bbtk}$ }
+\def\bbi{{\xspace}$\texttt{bbi}$ }
+\def\bbStudio{{\xspace}$\texttt{bbStudio}$ }
+\def\bbfy{{\xspace}$\texttt{bbfy}$ }
+\def\bbdoc{{\xspace}$\texttt{bbdoc}$ }
+\def\bbCreatePackage{{\xspace}$\texttt{bbCreatePackage}$ }
+
+\def\bb{{\xspace}$\texttt{bb}$ }
+%\def\bbp{{\xspace}$\texttt{bbp}$\xspace}
+
+\def\cmake{{\xspace}$\texttt{cmake}$ }
+
+\def\C{{\xspace}$\texttt{C}$ }
+\def\CPP{{\xspace}$\texttt{C++}$ }
+
+\def\xml{{\xspace}$\texttt{xml}$ }
+
+\def\itk{{\xspace}$\texttt{itk}$ }
+\def\vtk{{\xspace}$\texttt{vtk}$ }
+\def\gdcm{{\xspace}$\texttt{gdcm}$ }
+\def\gsmis{{\xspace}$\texttt{gsmis}$ }
+\def\wx{{\xspace}$\texttt{wxWidgets}$ }
+
+\def\lin{{\xspace}\textit{Linux} }
+\def\win{{\xspace}\textit{Windows} }
+
+% the same macros with no space at the end
+
+\def\BBTKns{{\xspace}The {\bf Black Box Toolkit}}
+\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\bbCreatePackagens{{\xspace}$\texttt{bbCreatePackage}$}
+
+\def\bbns{{\xspace}$\texttt{bb}$}
+%\def\bbp{{\xspace}$\texttt{bbp}$\xspace}
+
+\def\cmakens{{\xspace}$\texttt{cmake}$}
+
+\def\Cns{{\xspace}$\texttt{C}$}
+\def\CPPns{{\xspace}$\texttt{C++}$}
+
+\def\xmlns{{\xspace}$\texttt{xml}$}
+
+\def\itkns{{\xspace}$\texttt{itk}$}
+\def\vtkns{{\xspace}$\texttt{vtk}$}
+\def\gdcmns{{\xspace}$\texttt{gdcm}$}
+\def\gsmisns{{\xspace}$\texttt{gsmis}$}
+\def\wxns{{\xspace}$\texttt{wxWidgets}$}
+
+\def\linns{{\xspace}\textit{Linux}}
+\def\winns{{\xspace}\textit{Windows}}
+
+
% ==========================================
%%% mode: latex
projects / bbtk.git / commitdiff