Doc: fin + références

[delaunay.git] / doc / luamesh-doc.tex

diff --git a/doc/luamesh-doc.tex b/doc/luamesh-doc.tex
index 9330b5e..80469eb 100644 (file)
--- a/doc/luamesh-doc.tex
+++ b/doc/luamesh-doc.tex
@@ -9,10 +9,11 @@
 
 \documentclass{lltxdoc}
 \usepackage{tcolorbox}
-\usepackage{xargs}
 \usepackage{enumitem}
 \usepackage[tikz]{bclogo}
 \usepackage{wrapfig}
+
+
 \title{\Verb+luamesh+: compute and draw meshes with \lualatex}
 \author{Maxime Chupin \email{mc@melusine.eu.org}}
 \date{\today}
@@ -135,7 +136,7 @@
 
 \lstset{moredelim=*[s][\color{red}\rmfamily\itshape]{<}{>}}
 \lstset{moredelim=*[s][\color{blue}\rmfamily\itshape]{<<}{>>}}
-
+\usepackage[colorlinks=true]{hyperref}
 \begin{document}
 %% === Page de garde ===================================================
 \thispagestyle{empty}
@@ -192,6 +193,8 @@ with a git project on the \Verb+melusine+ machine:
 I would also like to thank the first user, an intensive
 \emph{test} user, and a very kind English corrector: Nicole Spillane.
 
+\tableofcontents
+
 \section{Installation}
 
 
@@ -560,7 +563,8 @@ macros, with the suffix \Verb+inc+ that allow the user to add code
 (MetaPost or \Verb+tikz+, depending of the drawing engine) before and
 after the code generated by \luamesh.
 
-The three macros are:
+The three macros are:\medskip
+
 
 \commande|\buildMeshBWinc[«options»]{«list of points» or «file name»}{«code before»}{«code after»}|\medskip
 
@@ -618,7 +622,7 @@ colors : \Verb+\luameshmpcolorBack+, \Verb+\luameshmpcolorNew+, and
 colors as well. Finally, the \Verb+luamplib+ mechanism of
 \Verb+\mpcolor+ is also available.
 
-\subsubsection{The Mesh Points with MetaPost}
+\subsubsection{The Mesh Points}
 
 At the beginning of the automatically generated code, a list of
 MetaPost \Verb+pair+s are defined corresponding to all the vertices of
@@ -693,9 +697,67 @@ step=badtriangles]
 
 \subsection{With TikZ}
 
+If we have chosen \Verb+tikz+ as the engine drawing, the added code
+will be written in \Verb+tikz+. In that case, the two arguments
+\meta{code before} and \meta{code after} will be inserted as follows:
+\begin{latexcode}
+\noindent
+\begin{tikzpicture}[x=<scale>,y=<scale>]
+  <<code before>>
+  <generated code>
+  <<code after>>
+\end{tikzpicture}
+\end{latexcode}
+
+Because the engine is \Verb+tikz+ their is no issue with colors, the
+\LaTeX{} colors (e.g.: \Verb+xcolor+) can be directly used.
+
+\subsubsection{The Mesh Points}
+
+The points of the mesh are defined here as \Verb+tikz+
+\Verb+\coordinate+ named as follows
+\begin{latexcode}
+\coordinate (MeshPoints1) at (...,...);
+\coordinate (MeshPoints2) at (...,...);
+\coordinate (MeshPoints3) at (...,...);
+%etc.
+\end{latexcode}
+
+Once again these coordinates are not yet defined for the \meta{code
+  before} argument.
+
+\subsubsection{Examples}
 
+\begin{Exemple}
+  \drawPointsMeshinc[
+  tikz,
+  color = blue!50,
+  print = points,
+  meshpoint = x,
+  scale=0.8cm,
+  ]{(0.3,0.3);(1.5,1);(4,0);(4.5,2.5);(1.81,2.14);(2.5,0.5);(2.8,1.5)}%
+  {% code before
+  }%
+  {% code after
+    \node[color = blue!50]  at (0,2) {Mesh $\mathbb{T}$} ;
+  }
+  \buildMeshBWinc[%
+  tikz,
+  bbox = show,
+  color = red,
+  colorBbox = blue!30,
+  print = points,
+  meshpoint = x,
+  scale=0.8cm
+  ]{(0.3,0.3);(1.5,1);(4,0);(4.5,2.5);(1.81,2.14);(2.5,0.5);(2.8,1.5)}%
+  {% code before
+  }
+  {% code after
+    \draw[<->,thick, color=green] (MeshPoints3) -- (MeshPoints9);
+  }
+\end{Exemple}
 
-\section{Gallery of Examples}
+\input{dum.bbl}
 
 \end{document}