summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/l3experimental/l3draw.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/l3experimental/l3draw.dtx')
-rw-r--r--macros/latex/contrib/l3experimental/l3draw.dtx60
1 files changed, 43 insertions, 17 deletions
diff --git a/macros/latex/contrib/l3experimental/l3draw.dtx b/macros/latex/contrib/l3experimental/l3draw.dtx
index a713774f8c..cccade7044 100644
--- a/macros/latex/contrib/l3experimental/l3draw.dtx
+++ b/macros/latex/contrib/l3experimental/l3draw.dtx
@@ -110,7 +110,7 @@
% }^^A
% }
%
-% \date{Released 2021-07-12}
+% \date{Released 2021-08-04}
%
% \maketitle
%
@@ -185,6 +185,43 @@
% axes at the driver level: this is then \enquote{transparent} to the
% \pkg{draw} level, and so should be used only when strictly required.)
%
+% The bounding box of the drawing is determined by tracking the size of the
+% \pkg{draw} commands between the start and end. The bounding box is (roughly)
+% the smallest box that contains all of the co-ordinates mentioned within the
+% drawing. This can include those automatically generated, for example the
+% supporting points needed to construct an arc.
+%
+% \begin{function}{\draw_baseline:n}
+% \begin{syntax}
+% \cs{draw_baseline:n} \Arg{length}
+% \end{syntax}
+% As standard, the baseline of the bounding box of a drawing is calculated
+% automatically at the bottom of the drawing. It is possible to adjust this
+% using the \cs{draw_baseline:n} function. If the drawing co-ordinates lead
+% to lower $y$-axis values than the \meta{length}, then the drawing will have
+% a depth as well as a height.
+% \begin{demo}
+% text
+% \draw_begin:
+% \draw_path_rectangle:nn { 0 , 0 } { 2ex , 1ex }
+% \draw_path_use:n { stroke }
+% \draw_end:
+% text
+% \draw_begin:
+% \draw_path_rectangle:nn { 0 , 1ex } { 2ex , 1ex }
+% \draw_baseline:n { 0pt }
+% \draw_path_use:n { stroke }
+% \draw_end:
+% text
+% \draw_begin:
+% \draw_path_rectangle:nn { 0 , -1ex } { 2ex , 1ex }
+% \draw_baseline:n { -0.5ex }
+% \draw_path_use:n { stroke }
+% \draw_end:
+% text
+% \end{demo}
+% \end{function}
+%
% \begin{function}{\draw_suspend_begin:, \draw_suspend_end:}
% \begin{syntax}
% \cs{draw_suspend_begin:}
@@ -363,21 +400,10 @@
% \subsection{Points}
%
% Functions supporting the calculation of points (co-ordinates) are expandable
-% and may be used outside of the drawing environment. When used in this
-% way, they all yield a co-ordinate tuple, for example
-% \begin{verbatim}
-% \tl_set:Nx \l_tmpa_tl { \draw_point:nn { 1 } { 2 } }
-% \tl_show:N \l_tmpa_tl
-% \end{verbatim}
-% gives
-% \begin{verbatim}
-% > \l_tmpa_tl=1pt,2pt.
-% <recently read> }
-% \end{verbatim}
-%
-% This output form is then suitable as \emph{input} for subsequent point
-% calculations, \emph{i.e.}~where a \meta{point} is required it may be
-% given as a tuple. This \emph{may} include units and surrounding
+% and may be used outside of the drawing environment. The outputs of all of the
+% point functions are tuples. This output form is then suitable as \emph{input}
+% for subsequent point calculations, \emph{i.e.}~where a \meta{point} is required
+% it may be given as a tuple. This \emph{may} include units and surrounding
% parentheses, for example
% \begin{verbatim}
% 1,2
@@ -1136,7 +1162,7 @@
% \end{macrocode}
%
% \begin{macrocode}
-\ProvidesExplPackage{l3draw}{2021-07-12}{}
+\ProvidesExplPackage{l3draw}{2021-08-04}{}
{L3 Experimental core drawing support}
% \end{macrocode}
%