doc/luamesh-doc.tex

   1 % luamesh: compute and draw meshes with lua, luamplib and tikz
   2 %
   3 % Originally written by Maxime Chupin <mc@melusine.eu.org>,
   4 % 2010.
   5 %
   6 % Distributed under the terms of the GNU free documentation licence:
   7 %   http://www.gnu.org/licenses/fdl.html
   8 % without any invariant section or cover text.
   9
  10 \documentclass{lltxdoc}
  11 \usepackage{tcolorbox}
  12 \title{\Verb+luamesh+: compute and draw meshes with \lualatex}
  13 \author{Maxime Chupin \email{mc@melusine.eu.org}}
  14 \date{\today}
  15
  16
  17
  18 \tcbuselibrary{listings,breakable}
  19
  20 \definecolor{vert}{rgb}{0.1,0.4,0.1}
  21 \definecolor{bleu}{rgb}{0.1,0.1,0.4}
  22 \lstset{
  23   numberstyle=\footnotesize\color{vert},
  24   keywordstyle=\ttfamily\bfseries\color{blue},
  25   basicstyle=\ttfamily\footnotesize,
  26   commentstyle=\itshape\color{vert},
  27   stringstyle=\ttfamily,
  28   showstringspaces=false,
  29   language=[LaTeX]TeX,
  30   breaklines=true,
  31   breakindent=30pt,
  32   defaultdialect=[LaTeX]TeX,
  33   % frame=tb
  34 }
  35
  36 \lstdefinelanguage{lua}
  37 {morekeywords={for,end,function,do,if,else,elseif,then,
  38     tex.print,tex.sprint,io.read,io.open,string.find,string.explode,require},
  39   morecomment=[l]{--},
  40   morecomment=[s]{--[[}{]]},
  41   morestring=[b]''
  42 }
  43
  44 \newtcblisting{Exemple}{%
  45   arc=0pt,outer arc=0pt,
  46   colback=red!2!white,
  47   colframe=red!75!black,
  48   breakable,
  49   boxsep=0pt,left=5pt,right=5pt,top=5pt,bottom=5pt, bottomtitle =
  50   3pt, toptitle=3pt,
  51   boxrule=0pt,bottomrule=0.5pt,toprule=0.5pt, toprule at break =
  52   0pt, bottomrule at break = 0pt,
  53   listing options={breaklines},
  54 }
  55
  56 \newtcblisting{commandshell}{colback=black,colupper=white,colframe=black,
  57   arc=0pt,
  58   listing only,boxsep=0pt,listing
  59   options={style=tcblatex,language=sh},
  60   every listing line={\textcolor{red}{\small\ttfamily\bfseries user \$> }}}
  61
  62 \newtcblisting{latexcode}{
  63   arc=0pt,
  64   listing only,boxsep=0pt,listing
  65   options={style=tcblatex}}
  66
  67
  68 \newcommand\luamesh{\Verb+luamesh+\xspace}
  69
  70 \begin{document}
  71
  72 \maketitle
  73
  74 \begin{abstract}
  75   The package \Verb|luamesh| allows to compute and draw triangulation
  76   of Delaunay. The algorithm is written with lua, and depending of the
  77   choice of the ``engine'', the draw is done by MetaPost (with
  78   \Verb|luamplib|) or by \Verb|tikz|.
  79
  80   The Delaunay triangulation algorithm is the Bowyer and Watson
  81   algorithm. Several macros are provided to draw the global mesh, the
  82   set of points, a particular step of the algorithm.
  83 \end{abstract}
  84
  85 \section{Installation}
  86
  87 \subsection{With Linux}
  88
  89 To install \luamesh with \TeX live, you have to create the local
  90 \Verb+texmf+ directory in your \Verb+home+.
  91
  92 \begin{commandshell}
  93 mkdir ~/texmf
  94 \end{commandshell}
  95
  96 Then we have to files to place in the correct directories. First, the
  97 \Verb+luamesh.sty+ file must be in the directory:
  98 \begin{center}
  99   \Verb+~/texmf/tex/latex/luamesh/+
 100 \end{center}
 101 and secondly, the \Verb+luamesh.lua+ must be in the directory:
 102 \begin{center}
 103   \Verb+~/texmf/scripts/luamesh/+
 104 \end{center}
 105
 106 Once you have done this, \luamesh can be included in your document
 107 with
 108 \begin{latexcode}
 109 \usepackage{luamesh}
 110 \end{latexcode}
 111
 112
 113 \section{The Macros}
 114
 115
 116
 117 \subsection{Draw a Complete Mesh}
 118
 119 \subsection{Draw the Set of Points}
 120
 121 \subsection{Draw a Step of the Bowyer and Watson Algorithm}
 122
 123 \section{Gallery of Examples}
 124
 125 \end{document}
 126
 127
 128
 129 %%% Local Variables:
 130 %%% flyspell-mode: 1
 131 %%% ispell-local-dictionary: "american"
 132 %%% End: