X-Git-Url: https://melusine.eu.org/syracuse/G/git/?a=blobdiff_plain;f=doc%2Fluamesh-doc.tex;h=e59f7fc0889ea5a6618ae2beca1ffeb5807b5881;hb=5921eb363f3873328cc96cb4321b2f6387b8f3f5;hp=d68baa3098734ce414bae1cdb9fc42dbe4fe5cc7;hpb=02c985137bc9977698c0fff1a6d5b747d69192b0;p=delaunay.git

diff --git a/doc/luamesh-doc.tex b/doc/luamesh-doc.tex
index d68baa3..e59f7fc 100644
--- a/doc/luamesh-doc.tex
+++ b/doc/luamesh-doc.tex
@@ -9,6 +9,10 @@
 
 \documentclass{lltxdoc}
 \usepackage{tcolorbox}
+\usepackage{xargs}
+\usepackage{enumitem}
+
+
 \title{\Verb+luamesh+: compute and draw meshes with \lualatex}
 \author{Maxime Chupin \email{mc@melusine.eu.org}}
 \date{\today}
@@ -19,8 +23,7 @@
   }%
   ]{Vitem}}
 
-\usepackage{xargs}
-\newcommand*\textme[1]{\color{black}{\rmfamily\textit{#1}}}
+\newcommand*\textme[1]{\textcolor{black}{\rmfamily\textit{#1}}}
 \newcommand*\meta[1]{% % meta
   \textme{\ensuremath{\langle}#1\ensuremath{\rangle}}}
 \newcommand*\optstar{% % optional star
@@ -96,6 +99,10 @@
 
 \newcommand\luamesh{\Verb+luamesh+\xspace}
 
+\newenvironment{optionsenum}[1][]
+  {\begin{description}[font=\color{red}\ttfamily]}
+    {\end{description}}
+
 \begin{document}
 
 \maketitle
@@ -187,8 +194,8 @@ points must be given in the following way :
 \subsubsection{The Options}
 
 There are several options to customize the drawing.
-\begin{description}
-\item[\color{red}\texttt{mode = int (default) or ext}:] the mode option allow to
+\begin{optionsenum}
+\item[mode = int (default) or ext:] this option allows to
   use either the previously described set of point in the argument, or
   a file, containing, line by line (2 columns), the points. Such a
   file looks like :
@@ -199,7 +206,57 @@ x3  y3
 ...
 xn yn
 \end{verbatim}
-\end{description}
+\item[bbox = none (default) or show:] this option allows to draw the
+  added points to form a \emph{bounding box}\footnote{The bounding
+    box is defined by four points place at 15\% around the box
+    defined by $(x_{\min},y_{\min})$, $(x_{\min},y_{\max})$,
+    $(x_{\max},y_{\max})$, and $(x_{\min},y_{\max})$.} and the corresponding
+  triangulation. By default, these triangles are removed at the end of
+  the algorithm.
+\item[color = \meta{value} (default: black):] The color of the
+  drawing.
+\item[colorBbox = \meta{value} (default: black):] The color of the
+  drawing for the elements (points and triangles) belonging to the
+  bounding box.
+\item[print = none (default) or points:] To label the vertices of the
+  triangulations with an adding dot.
+\item[meshpoint = \meta{value} (default: P):] The letter(s) used to
+  label the vertices of the triangulation. It is include in the math
+  mode delimiters \Verb+$...$+. The bounding box points are labeled
+  with a star exponent, and numbered from 1 to 4.
+\item[tikz (boolean, default:false):] By default, this boolean is set
+  to \Verb+false+, and MetaPost (with \Verb+luamplib+) is used to draw
+  the picture. With this option, it is \Verb+tikz+ the \textit{drawing
+    engine}.
+\item[scale = \meta{value} (default: 1cm):] The scale option defines
+  the scale at which the picture is draw (the same for the two
+  axis). It must contain the unit of length (cm,
+  pt, etc.).
+\end{optionsenum}
+
+To illustrate the options, let us show you an example. We consider a
+file \Verb+mesh.txt+:
+\begin{verbatim}
+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
+\end{verbatim}
+\begin{Exemple}
+  \buildMeshBW[%
+  tikz,
+  mode = ext,
+  bbox = show,
+  color = red,
+  colorBbox = blue!30,
+  print = points,
+  meshpoint = x,
+  scale = 1.3cm,
+  ]{mesh.txt}
+\end{Exemple}
 
 \subsection{Draw the Set of Points}