doc

[bbtk.git] / kernel / doc / bbtkPackageDevelopersGuide / bbtkPackageDevelopersGuide.tex

diff --git a/kernel/doc/bbtkPackageDevelopersGuide/bbtkPackageDevelopersGuide.tex b/kernel/doc/bbtkPackageDevelopersGuide/bbtkPackageDevelopersGuide.tex
index 640bc4115b455bbf404dc7ce2c5deba36fd25d91..2a9e0724e4dbbd090ace1270c5f716e32f852150 100644 (file)
--- a/kernel/doc/bbtkPackageDevelopersGuide/bbtkPackageDevelopersGuide.tex
+++ b/kernel/doc/bbtkPackageDevelopersGuide/bbtkPackageDevelopersGuide.tex
@@ -1,6 +1,66 @@
 % ==========================================
 \documentclass[11pt,final,a4paper]{article}
 \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}
@@ -30,8 +90,9 @@
 % ==========================================
 Any black box must be included in a \bbtk package, 
 that is in a particular shared library which can be loaded 
-dynamically by \bbtk (hence applications which use \bbtk, 
-such as the interpreter \bbi). 
+dynamically by \bbtk (hence applications which use \bbtkns, 
+such as the interpreter \bbi, launched by the development environment
+\bbStudions). 
 
 \begin{enumerate}
 \item \textbf{Create a new package. }
@@ -75,7 +136,7 @@ the utility \bbfy will then generate the corresponding \CPP code.
 
 Run \texttt{bbStudio}.
 
-You''l get something like in fig. \ref{bb-Studio}
+You'll get something like in fig. \ref{bb-Studio}
 
 \begin{figure}[!ht]
 \caption{\label{bb-Studio} bbStudio}