Doc: Correction anglais, mis à jour index.md
authorMaxime Chupin (Ceremade) <chupin@ceremade.dauphine.fr>
Tue, 6 Dec 2016 10:03:24 +0000 (11:03 +0100)
committerMaxime Chupin (Ceremade) <chupin@ceremade.dauphine.fr>
Tue, 6 Dec 2016 10:03:24 +0000 (11:03 +0100)
doc/luamesh-doc.out
doc/luamesh-doc.pdf
doc/luamesh-doc.tex
doc/luamesh-doc.toc
index.md

index 7407af4..f66e8b4 100644 (file)
 \BOOKMARK [2][-]{subsection.3.2}{With TikZ}{section.3}% 18
 \BOOKMARK [3][-]{subsubsection.3.2.1}{The Mesh Points}{subsection.3.2}% 19
 \BOOKMARK [3][-]{subsubsection.3.2.2}{Examples}{subsection.3.2}% 20
 \BOOKMARK [2][-]{subsection.3.2}{With TikZ}{section.3}% 18
 \BOOKMARK [3][-]{subsubsection.3.2.1}{The Mesh Points}{subsection.3.2}% 19
 \BOOKMARK [3][-]{subsubsection.3.2.2}{Examples}{subsection.3.2}% 20
-\BOOKMARK [1][-]{section.4}{Voronio Diagrams}{}% 21
+\BOOKMARK [1][-]{section.4}{Voron Diagrams}{}% 21
 \BOOKMARK [2][-]{subsection.4.1}{The Options}{section.4}% 22
 \BOOKMARK [2][-]{subsection.4.2}{The inc variant}{section.4}% 23
 \BOOKMARK [1][-]{section.5}{With Gmsh}{}% 24
 \BOOKMARK [2][-]{subsection.4.1}{The Options}{section.4}% 22
 \BOOKMARK [2][-]{subsection.4.2}{The inc variant}{section.4}% 23
 \BOOKMARK [1][-]{section.5}{With Gmsh}{}% 24
-\BOOKMARK [2][-]{subsection.5.1}{Gmsh and Voronoi Diagrams}{section.5}% 25
+\BOOKMARK [2][-]{subsection.5.1}{Gmsh and Voronoï Diagrams}{section.5}% 25
 \BOOKMARK [2][-]{subsection.5.2}{The Options}{section.5}% 26
 \BOOKMARK [2][-]{subsection.5.3}{The inc variants}{section.5}% 27
 \BOOKMARK [1][-]{section.6}{Gallery}{}% 28
 \BOOKMARK [2][-]{subsection.5.2}{The Options}{section.5}% 26
 \BOOKMARK [2][-]{subsection.5.3}{The inc variants}{section.5}% 27
 \BOOKMARK [1][-]{section.6}{Gallery}{}% 28
index 2060b52..f0cb2d5 100644 (file)
Binary files a/doc/luamesh-doc.pdf and b/doc/luamesh-doc.pdf differ
index e3408cc..d2cbafd 100644 (file)
@@ -34,7 +34,7 @@
 \newcommand*\optstar{% % optional star
   \meta{\ensuremath{*}}\xspace}
 \DefineShortVerb{\|}
 \newcommand*\optstar{% % optional star
   \meta{\ensuremath{*}}\xspace}
 \DefineShortVerb{\|}
-
+\newcommand\R{\mathbf{R}}
 \setlength{\fboxsep}{2pt}
 \fvset{%
   codes={\catcode`\«\active \catcode`\×\active },
 \setlength{\fboxsep}{2pt}
 \fvset{%
   codes={\catcode`\«\active \catcode`\×\active },
@@ -200,7 +200,7 @@ I would also like to thank the first user, an intensive
 
 
 Of course, you can just put the two files \Verb+luamesh.lua+ and
 
 
 Of course, you can just put the two files \Verb+luamesh.lua+ and
-\Verb+luamesh.sty+ in the working directory, but this is not
+\Verb+luamesh.sty+ in the working directory but this is not
 recommended.
 
 
 recommended.
 
 
@@ -213,12 +213,12 @@ To install \luamesh with \TeX live, you have to create the local
 mkdir ~/texmf
 \end{commandshell}
 
 mkdir ~/texmf
 \end{commandshell}
 
-Then place the files in the correct directories. First, the
-\Verb+luamesh.sty+ file must be in the directory:
+Then place the files in the correct directories. The
+\Verb+luamesh.sty+ file must be in directory:
 \begin{center}
   \Verb+~/texmf/tex/latex/luamesh/+
 \end{center}
 \begin{center}
   \Verb+~/texmf/tex/latex/luamesh/+
 \end{center}
-and secondly, the \Verb+luamesh.lua+ must be in the directory:
+and the \Verb+luamesh.lua+ file must be in directory:
 \begin{center}
   \Verb+~/texmf/scripts/luamesh/+
 \end{center}
 \begin{center}
   \Verb+~/texmf/scripts/luamesh/+
 \end{center}
@@ -231,7 +231,7 @@ with
 
 \subsection{With Mik\TeX{} and Windows}
 
 
 \subsection{With Mik\TeX{} and Windows}
 
-We do not know these two systems, so we refer to the
+As these two systems are unknown to the contributor, we refer to the
 documentation for integrating local additions to Mik\TeX:
 \begin{center}
   \url{http://docs.miktex.org/manual/localadditions.html}
 documentation for integrating local additions to Mik\TeX:
 \begin{center}
   \url{http://docs.miktex.org/manual/localadditions.html}
@@ -250,26 +250,26 @@ If you want to use this package, you must compile your document with
 
 \subsection{Dependencies}
 
 
 \subsection{Dependencies}
 
-This package is built upon two main existing packages to draw the
+This package is built upon two main existing packages that one used to
+draw the
 triangulations :
 \begin{enumerate}
 \item \Verb+luamplib+ to use MetaPost via the \luatex library
   \Verb+mplib+;
 triangulations :
 \begin{enumerate}
 \item \Verb+luamplib+ to use MetaPost via the \luatex library
   \Verb+mplib+;
-\item and \Verb+tikz+.
+\item \Verb+tikz+.
 \end{enumerate}
 We will see how to choose between these two \emph{drawing engines}.
 \end{enumerate}
 We will see how to choose between these two \emph{drawing engines}.
-
 Moreover, the following packages are necessary:
 \begin{enumerate}
 \item \Verb+xkeyval+ to manage the optional arguments;
 Moreover, the following packages are necessary:
 \begin{enumerate}
 \item \Verb+xkeyval+ to manage the optional arguments;
-\item \Verb+xcolor+ to use colors (needed by \Verb+luamplib+);
-\item \Verb+ifthen+ to help the programming with \TeX.
+\item \Verb+xcolor+ to use colors (required by \Verb+luamplib+);
+\item \Verb+ifthen+ to help programming with \TeX.
 \end{enumerate}
 
 
 \section{The Basic Macros}
 
 \end{enumerate}
 
 
 \section{The Basic Macros}
 
-Let us recall that this package provides macros to draw two
+This package provides macros to draw two
 dimensional triangulations (or meshes).
 
 \subsection{Draw a Complete Mesh}\label{sec:buildMesh}
 dimensional triangulations (or meshes).
 
 \subsection{Draw a Complete Mesh}\label{sec:buildMesh}
@@ -293,7 +293,7 @@ There are several options to customize the drawing.
 \begin{optionsenum}
 \item[mode = int (default) \textme{or} ext:] this option allows to
   use either the previously described set of points in the argument, or
 \begin{optionsenum}
 \item[mode = int (default) \textme{or} ext:] this option allows to
   use either the previously described set of points in the argument, or
-  a file, containing, line by line (2 columns), the points. Such a
+  a file containing the points line by line (in 2 columns). Such a
   file looks like :
 \begin{verbatim}
 x1  y1
   file looks like :
 \begin{verbatim}
 x1  y1
@@ -303,12 +303,12 @@ x3  y3
 xn yn
 \end{verbatim}
 \item[bbox = none (default) \textme{or} show:] this option allows to draw the
 xn yn
 \end{verbatim}
 \item[bbox = none (default) \textme{or} show:] this option allows to draw the
-  added points to form a \emph{bounding box}\footnote{The bounding
+  points  added to form the \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})$. It is used by
     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})$. It is used by
-    the algorithm and will be computed in any case.} and the corresponding
-  triangulation. By default, these triangles are removed at the end of
+    the algorithm and will be computed in any case.} and the
+  triangles attached. By default, these triangles are removed at the end of
   the algorithm.
 \item[color = \meta{value} (default: black):] The color of the
   drawing.
   the algorithm.
 \item[color = \meta{value} (default: black):] The color of the
   drawing.
@@ -356,10 +356,10 @@ file \Verb+mesh.txt+:
 \end{Exemple}
 
 \begin{warning}
 \end{Exemple}
 
 \begin{warning}
-The drawing engine is not very relevant here, but it is useful to
-understand how the drawing is made. However, the engine will be
+The drawing engine is not very relevant here, although it is useful to
+understand how the drawing is produced. However, the engine will be
 relevant to
 relevant to
-the so called \emph{inc} macros (section~\ref{sec:inc}), for adding
+the so called \emph{inc} macros (section~\ref{sec:inc}) for adding
 code before and after the one generated by
 \luamesh.
 \end{warning}
 code before and after the one generated by
 \luamesh.
 \end{warning}
@@ -385,7 +385,7 @@ There are several options (exactly the same as for the
 \begin{optionsenum}
 \item[mode = int (default) \textme{or} ext:] this option allows to
   use either the previously described set of points as the argument, or
 \begin{optionsenum}
 \item[mode = int (default) \textme{or} ext:] this option allows to
   use either the previously described set of points as the argument, or
-  a file, containing, line by line (2 columns), the points. Such a
+  a file containing the points line by line (in 2 columns). Such a
   file looks like :
 \begin{verbatim}
 x1  y1
   file looks like :
 \begin{verbatim}
 x1  y1
@@ -395,8 +395,12 @@ x3  y3
 xn yn
 \end{verbatim}
 \item[bbox = none (default) \textme{or} show:] this option allows to draw the
 xn yn
 \end{verbatim}
 \item[bbox = none (default) \textme{or} show:] this option allows to draw the
-  added points to form a \emph{bounding box} and the corresponding
-  triangulation. By default, these triangles are removed at the end of
+  points  added to form the \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})$. It is used by
+    the algorithm and will be computed in any case.} and the
+  triangles attached. By default, these triangles are removed at the end of
   the algorithm. \emph{Here, because we plot only the vertices of the
     mesh, there are no triangles, only dots.}
 \item[color = \meta{value} (default: black):] The color of the
   the algorithm. \emph{Here, because we plot only the vertices of the
     mesh, there are no triangles, only dots.}
 \item[color = \meta{value} (default: black):] The color of the
@@ -405,10 +409,10 @@ xn yn
   drawing for the elements (points and triangles) belonging to the
   bounding box.
 \item[print = none (default) \textme{or} points:] To label the vertices of the
   drawing for the elements (points and triangles) belonging to the
   bounding box.
 \item[print = none (default) \textme{or} points:] To label the vertices of the
-  triangulation. This also adds a \emph{dot} at each vertex. Without
-  label, there is still the dot.
+  triangulation. This also adds a \emph{dot} at each vertex. With no
+  label, the dot remains.
 \item[meshpoint = \meta{value} (default: P):] The letter(s) used to
 \item[meshpoint = \meta{value} (default: P):] The letter(s) used to
-  label the vertices of the triangulation. It is included in the math
+  label the vertices of the triangulation. This is included in the math
   mode delimiters \Verb+$...$+. The bounding box points are labeled
   with numbers 1 to 4 and with a star exponent.
 \item[tikz (boolean, default:false):] By default, this boolean is set
   mode delimiters \Verb+$...$+. The bounding box points are labeled
   with numbers 1 to 4 and with a star exponent.
 \item[tikz (boolean, default:false):] By default, this boolean is set
@@ -442,7 +446,7 @@ section~\ref{sec:buildMesh}, we illustrate the different options.
 \commande|\meshAddPointBW[«options»]{«list of points» or «file name»}{«point» or «number of line»}|\medskip
 
 This command allows to plot the steps within the addition of a
 \commande|\meshAddPointBW[«options»]{«list of points» or «file name»}{«point» or «number of line»}|\medskip
 
 This command allows to plot the steps within the addition of a
-point in a Delaunay triangulation, by the Bowyer and Watson
+point in a Delaunay triangulation by the Bowyer and Watson
 algorithm.
 
 This macro produces the Delaunay triangulation (using the Bowyer and
 algorithm.
 
 This macro produces the Delaunay triangulation (using the Bowyer and
@@ -456,7 +460,7 @@ and the point is of the form \verb+(x,y)+. The \meta{file name}
 and \meta{number of line}  will be explained in the option
 description.
 
 and \meta{number of line}  will be explained in the option
 description.
 
-One can use the macro as fallows:
+One can use the macro as follows:
 \begin{Exemple}
   \meshAddPointBW[step=badtriangles]{(1.5,1);(4,0);(4.5,2.5);(1.81,2.14);(2.5,0.5);(2.8,1.5)}{(2.2,1.8)}
   \meshAddPointBW[step=cavity]{(1.5,1);(4,0);(4.5,2.5);(1.81,2.14);(2.5,0.5);(2.8,1.5)}{(2.2,1.8)}
 \begin{Exemple}
   \meshAddPointBW[step=badtriangles]{(1.5,1);(4,0);(4.5,2.5);(1.81,2.14);(2.5,0.5);(2.8,1.5)}{(2.2,1.8)}
   \meshAddPointBW[step=cavity]{(1.5,1);(4,0);(4.5,2.5);(1.81,2.14);(2.5,0.5);(2.8,1.5)}{(2.2,1.8)}
@@ -475,9 +479,8 @@ There are several options (some of them are the same as for
 \Verb+\buildMeshBW+) to customize the drawing.
 \begin{optionsenum}
 \item[mode = int (default) \textme{or} ext:] this option allows to
 \Verb+\buildMeshBW+) to customize the drawing.
 \begin{optionsenum}
 \item[mode = int (default) \textme{or} ext:] this option allows to
-  use either the previously described set of point in the first
-  argument, or
-  a file containing, line by line (2 columns), the points. Such a
+  use either the previously described set of points as the argument, or
+  a file containing the points line by line (in 2 columns). Such a
   file looks like :
 \begin{verbatim}
 x1  y1
   file looks like :
 \begin{verbatim}
 x1  y1
@@ -486,15 +489,17 @@ x3  y3
 ...
 xn yn
 \end{verbatim}
 ...
 xn yn
 \end{verbatim}
-For the second argument of the macro, if we are in the
+For the second argument of the macro, if we are in
 \Verb+mode = ext+, the argument must be the \emph{line number} of the file
 \Verb+mode = ext+, the argument must be the \emph{line number} of the file
-corresponding to the point we want to add. The algorithm will stop the
-line before to build the initial triangulation for which it will add
-the point corresponding to the line. The subsequent lines in the file are
+corresponding to the point we want to add. The algorithm will stop at the
+previous line to build the initial triangulation and proceed to add
+the point corresponding to the line requested. The subsequent lines in
+the file are
 ignored.
 \item[bbox = none (default) \textme{or} show:] this option allows to draw the
 ignored.
 \item[bbox = none (default) \textme{or} show:] this option allows to draw the
-  added points to form a \emph{bounding box} and the corresponding
-  triangulation. By default, these triangles are removed at the end of
+  added points that form the \emph{bounding box} and the triangles
+  attached. Although they are always computed, by default, these
+  triangles are removed at the end of
   the algorithm.
 \item[color = \meta{value} (default: black):] The color of the
   drawing.
   the algorithm.
 \item[color = \meta{value} (default: black):] The color of the
   drawing.
@@ -503,7 +508,7 @@ ignored.
   bounding box.
 \item[colorNew = \meta{value} (default: red):] The color of the
   drawing of the ``new'' elements which are the point to add, the
   bounding box.
 \item[colorNew = \meta{value} (default: red):] The color of the
   drawing of the ``new'' elements which are the point to add, the
-  polygon of the cavity, and the new triangles.
+  polygon delimiting the cavity, and the new triangles.
 \item[colorBack = \meta{value} (default: black!20):] The color for the
   filling of the region concerned by the addition of the new point.
 \item[colorCircle = \meta{value} (default: green):] The color for
 \item[colorBack = \meta{value} (default: black!20):] The color for the
   filling of the region concerned by the addition of the new point.
 \item[colorCircle = \meta{value} (default: green):] The color for
@@ -523,7 +528,7 @@ ignored.
   the picture. With this option, \Verb+tikz+  is the \textit{drawing
     engine}.
 \item[scale = \meta{value} (default: 1cm):] The scale option defines
   the picture. With this option, \Verb+tikz+  is 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
+  the scale at which the picture is drawn (the same for both
   axis). It must contain the unit of length (cm,
   pt, etc.).
 \end{optionsenum}
   axis). It must contain the unit of length (cm,
   pt, etc.).
 \end{optionsenum}
@@ -580,11 +585,11 @@ The three macros are:\medskip
 We consider the case where the drawing engine is MetaPost (through the
 \Verb+luamplib+ package).
 
 We consider the case where the drawing engine is MetaPost (through the
 \Verb+luamplib+ package).
 
-We describe the feature taking one macro in example but the mechanism
-and the possibilities are exactly the same for all the macros.
+The feature is described for the \Verb+\buildMeshBWinc+ but the mechanism
+and possibilities are exactly the same for all three macros.
 
 When we use the MetaPost drawing engine, the macros previously
 
 When we use the MetaPost drawing engine, the macros previously
-described produced a code of the form
+described produce a code of the form
 \begin{latexcode}
 \begin{luamplib}
   u:=<scale>;
 \begin{latexcode}
 \begin{luamplib}
   u:=<scale>;
@@ -614,22 +619,24 @@ to use the \Verb+\everymplib+ command from the \Verb+\luamplib+ package.
 
 The configurable colors
 of the \LaTeX{} macro are accessible inside the MetaPost code. For
 
 The configurable colors
 of the \LaTeX{} macro are accessible inside the MetaPost code. For
-\Verb+\buildMeshBWinc+ and \Verb+\drawPointsMeshinc+, we have
+\Verb+\buildMeshBWinc+ and \Verb+\drawPointsMeshinc+,
 \Verb+\luameshmpcolor+,
 \Verb+\luameshmpcolor+,
-and \Verb+\luameshmpcolorBbox+.
-For the macro \Verb+\meshAddPointBWinc+ we have three additional
-colors : \Verb+\luameshmpcolorBack+, \Verb+\luameshmpcolorNew+, and
-\Verb+\luameshmpcolorCircle+. Of course, we can define MetoPost
-colors as well. Finally, the \Verb+luamplib+ mechanism of
+and \Verb+\luameshmpcolorBbox+ have been defined.
+For the macro \Verb+\meshAddPointBWinc+ three additional
+colors are present: \Verb+\luameshmpcolorBack+,
+\Verb+\luameshmpcolorNew+, and
+\Verb+\luameshmpcolorCircle+. Of course, MetaPost
+colors can be defined as well. Finally, the \Verb+luamplib+ mechanism
 \Verb+\mpcolor+ is also available.
 
 \subsubsection{The Mesh Points}
 
 At the beginning of the automatically generated code, a list of
 \Verb+\mpcolor+ is also available.
 
 \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
+MetaPost \Verb+pair+s are defined corresponding to all the vertices in
 the mesh (when the option \Verb+bbox=show+, the last 4 points are the
 \emph{bounding box points}). The points are available with the
 the mesh (when the option \Verb+bbox=show+, the last 4 points are the
 \emph{bounding box points}). The points are available with the
-\Verb+MeshPoints[]+ table of variables. The \Verb+MeshPoints[i]+ are
+\Verb+MeshPoints[]+ table of variables. The \Verb+pair+s ($\R^{2}$ points)
+\Verb+MeshPoints[i]+ are
 defined using the unit length \Verb+u+.
 
 \subsubsection{Examples}
 defined using the unit length \Verb+u+.
 
 \subsubsection{Examples}
@@ -690,7 +697,7 @@ step=badtriangles]
 \end{Exemple}
 \begin{warning}
   The variables \Verb+MeshPoints[]+ are not defined for the argument
 \end{Exemple}
 \begin{warning}
   The variables \Verb+MeshPoints[]+ are not defined for the argument
-  corresponding to the code to place before the code generated by
+  corresponding to the code placed \textbf{before} the code generated by
   \luamesh. Hence, to use such variables, we have to define a
   \Verb+picture+ as shown in the third example above.
 \end{warning}
   \luamesh. Hence, to use such variables, we have to define a
   \Verb+picture+ as shown in the third example above.
 \end{warning}
@@ -698,7 +705,7 @@ step=badtriangles]
 
 \subsection{With TikZ}
 
 
 \subsection{With TikZ}
 
-If we have chosen \Verb+tikz+ as the engine drawing, the added code
+If we have chosen \Verb+tikz+ as the drawing engine, 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}
 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}
@@ -711,12 +718,12 @@ will be written in \Verb+tikz+. In that case, the two arguments
 \end{latexcode}
 
 Because the engine is \Verb+tikz+ their is no issue with colors, the
 \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.
+\LaTeX{} colors (e.g.: \Verb+xcolor+) can be used directly.
 
 \subsubsection{The Mesh Points}
 
 
 \subsubsection{The Mesh Points}
 
-The points of the mesh are defined here as \Verb+tikz+
-\Verb+\coordinate+ named as follows
+The mesh points  are defined here as \Verb+tikz+
+\Verb+\coordinate+ and named as follows
 \begin{latexcode}
 \coordinate (MeshPoints1) at (...,...);
 \coordinate (MeshPoints2) at (...,...);
 \begin{latexcode}
 \coordinate (MeshPoints1) at (...,...);
 \coordinate (MeshPoints2) at (...,...);
@@ -724,7 +731,8 @@ The points of the mesh are defined here as \Verb+tikz+
 %etc.
 \end{latexcode}
 
 %etc.
 \end{latexcode}
 
-Once again these coordinates are not yet defined for the \meta{code
+Once again these coordinates are not yet defined to be used in the
+code given by \meta{code
   before} argument.
 
 \subsubsection{Examples}
   before} argument.
 
 \subsubsection{Examples}
@@ -758,22 +766,22 @@ Once again these coordinates are not yet defined for the \meta{code
   }
 \end{Exemple}
 
   }
 \end{Exemple}
 
-\section{Voronio Diagrams}
+\section{Voron Diagrams}
 
 
-Another interesting concept of Delaunay triangulation is that it is
-\emph{dual} to it so-called Voronio diagram. For a finite set of
-points $\{p_{1},\ldots, p_{n}\}$ in the Euclidean plane, for all
-$p_{k}$, it corresponds a Voronoi cell $R_{k}$ consisting of
-every point in the Euclidean plane whose distance to $p_{k}$ is less
+Another interesting feature of b Delaunay triangulation is that its
+\emph{dual} is the so-called Voronoï diagram. More precisely, for a
+finite set of
+points $\{p_{1},\ldots, p_{n}\}$ in the Euclidean plane, the Voronoï
+cell $R_{k}$ corresponding to $p_{k}$ is the set of
+all points in the Euclidean plane $\R^{2}$ whose distance to $p_{k}$ is less
 than
 or equal to its distance to any other $p_{k'}$.\bigskip
 
 
 \commande|\buildVoronoiBW[«options»]{«list of points» or «file  name»}|\medskip
 
 than
 or equal to its distance to any other $p_{k'}$.\bigskip
 
 
 \commande|\buildVoronoiBW[«options»]{«list of points» or «file  name»}|\medskip
 
-This macro produce the Voronio diagram dual to the Delaunay
-triangulation (computed by the Bowyer and Watson
-algorithm) of the given \meta{list of points}. Once again, the
+This macro produce the Voronoï diagram  of the given \meta{list of
+  points}. Once again, the
 list of
 points must be given in the following way :
 \begin{center}
 list of
 points must be given in the following way :
 \begin{center}
@@ -791,7 +799,7 @@ There are several options to customize the drawing.
 \begin{optionsenum}
 \item[mode = int (default) \textme{or} ext:] this option allows to
   use either the previously described set of points in the argument, or
 \begin{optionsenum}
 \item[mode = int (default) \textme{or} ext:] this option allows to
   use either the previously described set of points in the argument, or
-  a file, containing, line by line (2 columns), the points. Such a
+  a file containing the points line by line (in 2 columns). Such a
   file looks like :
 \begin{verbatim}
 x1  y1
   file looks like :
 \begin{verbatim}
 x1  y1
@@ -815,18 +823,19 @@ xn yn
   bounding box.
 \item[colorVoronoi = \meta{value} (default: black):] The color of the
   drawing for the elements (points and polygons) belonging to the
   bounding box.
 \item[colorVoronoi = \meta{value} (default: black):] The color of the
   drawing for the elements (points and polygons) belonging to the
-  Voronoi diagram.
-\item[print = none (default) \textme{or} points:] To label the vertices of the
+  Voronoï diagram.
+\item[print = none (default) \textme{or} points:] To label the
+  vertices in the
   triangulation. Contrary to the previous macros, where
   triangulation. Contrary to the previous macros, where
-  \Verb+print=none+,  a \emph{dot} is produced at each vertex (of the
-  set of points and on the circumcircle center which are the nodes of
-  the Voronoi diagram).
+  \Verb+print=none+,  a \emph{dot} is produced at each vertex of the
+  set of points and at the circumcircle centers which are the nodes of
+  the Voronoï diagram.
 \item[meshpoint = \meta{value} (default: P):] The letter(s) used to
 \item[meshpoint = \meta{value} (default: P):] The letter(s) used to
-  label the vertices of the triangulation. It is included in the math
-  mode delimiters \Verb+$...$+. The bounding box points are labeled
+  label the vertices of the triangulation. This is included in the math
+  mode delimiters \Verb+$...$+. The bounding box points are labelled
   with numbers 1 to 4 and with a star exponent.
 \item[circumpoint = \meta{value} (default: P):] The letter(s) used to
   with numbers 1 to 4 and with a star exponent.
 \item[circumpoint = \meta{value} (default: P):] The letter(s) used to
-  label the vertices of the Voronoi diagram. It is included in the math
+  label the vertices of the Voronoï diagram. This is included in the math
   mode delimiters \Verb+$...$+.
 \item[tikz (boolean, default:false):] By default, this boolean is set
   to \Verb+false+, and MetaPost (with \Verb+luamplib+) is used to draw
   mode delimiters \Verb+$...$+.
 \item[tikz (boolean, default:false):] By default, this boolean is set
   to \Verb+false+, and MetaPost (with \Verb+luamplib+) is used to draw
@@ -836,12 +845,12 @@ xn yn
   the scale at which the picture is drawn (the same for both
   axes). It must contain the unit of length (cm,
   pt, etc.).
   the scale at which the picture is drawn (the same for both
   axes). It must contain the unit of length (cm,
   pt, etc.).
-\item[delaunay = none (default) \textme{or} show] This option
-  allows to draw the Delaunay triangulation under the Voronoi diagram.
-\item[styleDelaunay = none (default) \textme{or} dashed] This option
-  allows to draw dashed lines for the Delaunay triangulation.
-\item[styleVoronoi = none (default) \textme{or} dashed] This option
-  allows to draw dashed lines for the Voronoi edges.
+\item[delaunay = none (default) \textme{or} show:] This option
+  allows to draw the Delaunay triangulation under the Voronoï diagram.
+\item[styleDelaunay = none (default) \textme{or} dashed:] This option
+  allows to draw the Delaunay triangulation in dashed lines.
+\item[styleVoronoi = none (default) \textme{or} dashed:] This option
+  allows to draw the Voronoï edges in dashed lines.
 \end{optionsenum}
 
 \begin{Exemple}
 \end{optionsenum}
 
 \begin{Exemple}
@@ -853,12 +862,12 @@ xn yn
 
 Once again, a variant of the macros is available allowing the user to
 add code before and after the code produced by \luamesh. We refer to
 
 Once again, a variant of the macros is available allowing the user to
 add code before and after the code produced by \luamesh. We refer to
-the section~\ref{sec:inc} because it works the same way.
+section~\ref{sec:inc} because it works the same way.
 
 Let us note that:
 \begin{itemize}
 \item with MetaPost, the circumcenters are defined using
 
 Let us note that:
 \begin{itemize}
 \item with MetaPost, the circumcenters are defined using
-  \Verb+pair CircumPoints[];+, and so, are accessible.
+  \Verb+pair CircumPoints[];+ and so they are accessible.
 \item With \Verb+tikz+, there are new coordinates defined as follows
   \begin{latexcode}
     \coordinate (CircumPoints1) at (...,...);
 \item With \Verb+tikz+, there are new coordinates defined as follows
   \begin{latexcode}
     \coordinate (CircumPoints1) at (...,...);
@@ -868,21 +877,21 @@ Let us note that:
   \end{latexcode}
 \end{itemize}
 
   \end{latexcode}
 \end{itemize}
 
-Finally, when the MetaPost drawing engine is used, another color is
+Finally, when the MetaPost drawing engine is used another color is
 available (see~\ref{sec:mpcolor}): \Verb+\luameshmpcolorVoronoi+.
 
 
 \section{With Gmsh}
 
 available (see~\ref{sec:mpcolor}): \Verb+\luameshmpcolorVoronoi+.
 
 
 \section{With Gmsh}
 
-Gmsh is a open source efficient software that produces meshes. The
+Gmsh is an open source efficient software that produces meshes. The
 exporting format is the \emph{MSH ASCII file format} and can be easily
 read by a Lua program. \luamesh provides the user with dedicated
 macros to read and draw meshes coming from a Gmsh exportation.\bigskip
 
 \commande|\drawGmsh[«options»]{«file  name»}|\medskip
 
 exporting format is the \emph{MSH ASCII file format} and can be easily
 read by a Lua program. \luamesh provides the user with dedicated
 macros to read and draw meshes coming from a Gmsh exportation.\bigskip
 
 \commande|\drawGmsh[«options»]{«file  name»}|\medskip
 
-This macro draw the triangulation produced by Gmsh and exported in the
-\Verb+msh+ format. The argument is the name of the file to read
+This macro draws the triangulation produced by Gmsh and exported in the
+\Verb+msh+ format. The argument is the name of the file to be read
 (e.g.: \Verb+maillage.msh+).
 
 \begin{Exemple}
 (e.g.: \Verb+maillage.msh+).
 
 \begin{Exemple}
@@ -894,12 +903,12 @@ There are several options to customize the drawing.
 \item[color = \meta{value} (default: black):] The color of the
   drawing.
 \item[print = none (default) \textme{or} points:] To label the vertices of the
 \item[color = \meta{value} (default: black):] The color of the
   drawing.
 \item[print = none (default) \textme{or} points:] To label the vertices of the
-  triangulation. Contrary to the previous macros, where
-  \Verb+print=none+,  a \emph{dot} is produced at each vertex (of the
-  set of points and on the circumcircle center which are the nodes of
-  the Voronoi diagram).
+  triangulation. Contrary to some previous macros, when
+  \Verb+print=none+  a \emph{dot} is produced at each vertex of the
+  set of points and at the circumcircle centers (these are the nodes of
+  the Voronoï diagram).
 \item[meshpoint = \meta{value} (default: P):] The letter(s) used to
 \item[meshpoint = \meta{value} (default: P):] The letter(s) used to
-  label the vertices of the triangulation. It is included in the math
+  label the vertices of the triangulation. This is included in the math
   mode delimiters \Verb+$...$+. The bounding box points are labeled
   with numbers 1 to 4 and with a star exponent.
 \item[tikz (boolean, default:false):] By default, this boolean is set
   mode delimiters \Verb+$...$+. The bounding box points are labeled
   with numbers 1 to 4 and with a star exponent.
 \item[tikz (boolean, default:false):] By default, this boolean is set
@@ -916,10 +925,10 @@ Here is an example:
   \drawGmsh[scale=2cm,print=points, color=blue!30]{maillage.msh}
 \end{Exemple}
 
   \drawGmsh[scale=2cm,print=points, color=blue!30]{maillage.msh}
 \end{Exemple}
 
-\subsection{Gmsh and Voronoi Diagrams}
+\subsection{Gmsh and Voronoï Diagrams}
 
 
-Because Gmsh generates Delaunay triangulations, we can plot the
-Voronoi diagram associated. This is done by the following macro:\bigskip
+Because Gmsh generates Delaunay triangulations, we can plot the associated
+Voronoï diagram. This is done by the following macro:\bigskip
 
 \commande|\gmshVoronoi[«options»]{«file name»}|\medskip
 
 
 \commande|\gmshVoronoi[«options»]{«file name»}|\medskip
 
@@ -937,18 +946,18 @@ There are several options to customize the drawing.
   drawing.
 \item[colorVoronoi = \meta{value} (default: black):] The color of the
   drawing for the elements (points and polygons) belonging to the
   drawing.
 \item[colorVoronoi = \meta{value} (default: black):] The color of the
   drawing for the elements (points and polygons) belonging to the
-  Voronoi diagram.
+  Voronoï diagram.
 \item[print = none (default) \textme{or} points:] To label the vertices of the
 \item[print = none (default) \textme{or} points:] To label the vertices of the
-  triangulation. Contrary to the previous macros, where
-  \Verb+print=none+,  a \emph{dot} is produced at each vertex (of the
-  set of points and on the circumcircle center which are the nodes of
-  the Voronoi diagram).
+  triangulation. Contrary to some previous macros, when
+  \Verb+print=none+,  a \emph{dot} is produced at each vertex of the
+  set of points and at the circumcircle centers (these are the nodes of
+  the Voronoï diagram).
 \item[meshpoint = \meta{value} (default: P):] The letter(s) used to
   label the vertices of the triangulation. It is included in the math
   mode delimiters \Verb+$...$+. The bounding box points are labeled
   with numbers 1 to 4 and with a star exponent.
 \item[circumpoint = \meta{value} (default: P):] The letter(s) used to
 \item[meshpoint = \meta{value} (default: P):] The letter(s) used to
   label the vertices of the triangulation. It is included in the math
   mode delimiters \Verb+$...$+. The bounding box points are labeled
   with numbers 1 to 4 and with a star exponent.
 \item[circumpoint = \meta{value} (default: P):] The letter(s) used to
-  label the vertices of the Voronoi diagram. It is included in the math
+  label the vertices of the Voronoï diagram. This is included in the math
   mode delimiters \Verb+$...$+.
 \item[tikz (boolean, default:false):] By default, this boolean is set
   to \Verb+false+, and MetaPost (with \Verb+luamplib+) is used to draw
   mode delimiters \Verb+$...$+.
 \item[tikz (boolean, default:false):] By default, this boolean is set
   to \Verb+false+, and MetaPost (with \Verb+luamplib+) is used to draw
@@ -959,11 +968,12 @@ There are several options to customize the drawing.
   axes). It must contain the unit of length (cm,
   pt, etc.).
 \item[delaunay = none (default) \textme{or} show] This option
   axes). It must contain the unit of length (cm,
   pt, etc.).
 \item[delaunay = none (default) \textme{or} show] This option
-  allows to draw the Delaunay triangulation under the Voronoi diagram.
+  allows to draw the Delaunay triangulation overlapped with the
+  Voronoï diagram.
 \item[styleDelaunay = none (default) \textme{or} dashed] This option
 \item[styleDelaunay = none (default) \textme{or} dashed] This option
-  allows to draw dashed lines for the Delaunay triangulation.
+  allows to draw the Delaunay triangulation in dashed lines.
 \item[styleVoronoi = none (default) \textme{or} dashed] This option
 \item[styleVoronoi = none (default) \textme{or} dashed] This option
-  allows to draw dashed lines for the Voronoi edges.
+  allows to draw the Voronoï edges in dashed lines.
 \end{optionsenum}
 
 \begin{Exemple}
 \end{optionsenum}
 
 \begin{Exemple}
@@ -973,7 +983,7 @@ There are several options to customize the drawing.
 
 \subsection{The \emph{inc} variants}
 
 
 \subsection{The \emph{inc} variants}
 
-Once again, there exists \emph{inc} variant macros:\bigskip
+Once again, there exist \emph{inc} variant macros:\bigskip
 
 \commande|\drawGmshinc[«options»]{«file name»}{«code before»}{«code after»}|\medskip
 
 
 \commande|\drawGmshinc[«options»]{«file name»}{«code before»}{«code after»}|\medskip
 
@@ -984,7 +994,7 @@ We refer to the previous sections for explanations.
 \section{Gallery}
 \subsection{With Animate}
 
 \section{Gallery}
 \subsection{With Animate}
 
-If you use \emph{adobe acrobat reader}, you can easily produce an
+If you use \emph{Adobe Acrobat reader}, you can easily produce an
 animation of the Bowyer and Watson algorithm with the package
 \Verb+animate+.
 
 animation of the Bowyer and Watson algorithm with the package
 \Verb+animate+.
 
index bd488c1..13c01d6 100644 (file)
 \contentsline {subsubsection}{\numberline {3.1.3}Examples}{12}{subsubsection.3.1.3}
 \contentsline {subsection}{\numberline {3.2}With TikZ}{14}{subsection.3.2}
 \contentsline {subsubsection}{\numberline {3.2.1}The Mesh Points}{14}{subsubsection.3.2.1}
 \contentsline {subsubsection}{\numberline {3.1.3}Examples}{12}{subsubsection.3.1.3}
 \contentsline {subsection}{\numberline {3.2}With TikZ}{14}{subsection.3.2}
 \contentsline {subsubsection}{\numberline {3.2.1}The Mesh Points}{14}{subsubsection.3.2.1}
-\contentsline {subsubsection}{\numberline {3.2.2}Examples}{14}{subsubsection.3.2.2}
-\contentsline {section}{\numberline {4}Voronio Diagrams}{15}{section.4}
+\contentsline {subsubsection}{\numberline {3.2.2}Examples}{15}{subsubsection.3.2.2}
+\contentsline {section}{\numberline {4}Voron Diagrams}{15}{section.4}
 \contentsline {subsection}{\numberline {4.1}The Options}{16}{subsection.4.1}
 \contentsline {subsection}{\numberline {4.2}The \emph {inc} variant}{17}{subsection.4.2}
 \contentsline {subsection}{\numberline {4.1}The Options}{16}{subsection.4.1}
 \contentsline {subsection}{\numberline {4.2}The \emph {inc} variant}{17}{subsection.4.2}
-\contentsline {section}{\numberline {5}With Gmsh}{17}{section.5}
-\contentsline {subsection}{\numberline {5.1}Gmsh and Voronoi Diagrams}{19}{subsection.5.1}
-\contentsline {subsection}{\numberline {5.2}The Options}{19}{subsection.5.2}
-\contentsline {subsection}{\numberline {5.3}The \emph {inc} variants}{20}{subsection.5.3}
+\contentsline {section}{\numberline {5}With Gmsh}{18}{section.5}
+\contentsline {subsection}{\numberline {5.1}Gmsh and Voronoï Diagrams}{19}{subsection.5.1}
+\contentsline {subsection}{\numberline {5.2}The Options}{20}{subsection.5.2}
+\contentsline {subsection}{\numberline {5.3}The \emph {inc} variants}{21}{subsection.5.3}
 \contentsline {section}{\numberline {6}Gallery}{21}{section.6}
 \contentsline {subsection}{\numberline {6.1}With Animate}{21}{subsection.6.1}
 \contentsline {section}{\numberline {6}Gallery}{21}{section.6}
 \contentsline {subsection}{\numberline {6.1}With Animate}{21}{subsection.6.1}
index 62de640..841a57c 100644 (file)
--- a/index.md
+++ b/index.md
@@ -38,8 +38,7 @@ in the documentation.
 
 ## TODO list
 
 
 ## TODO list
 
-* Options to draw with dash either the delaunay or the voronio diagram
-  for voronio macros
+* Translation of the documentation in french.
 * Macro to generate a meshed rectangle.
 * Macro to generate a meshed circle.
 * Macro that, given a border defined by a set of points, adds points
 * Macro to generate a meshed rectangle.
 * Macro to generate a meshed circle.
 * Macro that, given a border defined by a set of points, adds points

Licence Creative Commons Les fichiers de Syracuse sont mis à disposition (sauf mention contraire) selon les termes de la
Licence Creative Commons Attribution - Pas d’Utilisation Commerciale - Partage dans les Mêmes Conditions 4.0 International.