diff options
author | Karl Berry <karl@freefriends.org> | 2011-12-11 22:32:04 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2011-12-11 22:32:04 +0000 |
commit | 3cc0c51eddc31f37b82f651016191bf3575f3aac (patch) | |
tree | 85e3f4cfbe245c416571020e0eb1136193596550 /Master/texmf-dist/source/latex/l3kernel/l3skip.dtx | |
parent | c56f30c6154e55286a21f438d5ed545a5169f13b (diff) |
l3kernel 3036 (11dec11)
git-svn-id: svn://tug.org/texlive/trunk@24822 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/source/latex/l3kernel/l3skip.dtx')
-rw-r--r-- | Master/texmf-dist/source/latex/l3kernel/l3skip.dtx | 306 |
1 files changed, 105 insertions, 201 deletions
diff --git a/Master/texmf-dist/source/latex/l3kernel/l3skip.dtx b/Master/texmf-dist/source/latex/l3kernel/l3skip.dtx index dec6cbac2d1..3c5f7951b21 100644 --- a/Master/texmf-dist/source/latex/l3kernel/l3skip.dtx +++ b/Master/texmf-dist/source/latex/l3kernel/l3skip.dtx @@ -35,7 +35,7 @@ % %<*driver|package> \RequirePackage{l3names} -\GetIdInfo$Id: l3skip.dtx 2959 2011-11-14 21:47:18Z joseph $ +\GetIdInfo$Id: l3skip.dtx 3029 2011-12-06 22:47:30Z joseph $ {L3 Experimental dimensions and skips} %</driver|package> %<*driver> @@ -88,131 +88,72 @@ % will initially be equal to $0$\,pt. % \end{function} % -% \begin{function}{\dim_zero:N, \dim_zero:c} +% \begin{function}{\dim_zero:N, \dim_zero:c, \dim_gzero:N, \dim_gzero:c} % \begin{syntax} % \cs{dim_zero:N} \meta{dimension} % \end{syntax} -% Sets \meta{dimension} to $0$\,pt within the scope of the current -% \TeX{} group. -% \end{function} -% -% \begin{function}{\dim_gzero:N, \dim_gzero:c} -% \begin{syntax} -% \cs{dim_gzero:N} \meta{dimension} -% \end{syntax} -% Sets \meta{dimension} to $0$\,pt globally, \emph{i.e.}~not -% restricted by the current \TeX{} group level. +% Sets \meta{dimension} to $0$\,pt. % \end{function} % % \section{Setting \texttt{dim} variables} % -% \begin{function}[updated = 2011-10-22]{\dim_add:Nn, \dim_add:cn} +% \begin{function}[updated = 2011-10-22] +% {\dim_add:Nn, \dim_add:cn, \dim_gadd:Nn, \dim_gadd:cn} % \begin{syntax} % \cs{dim_add:Nn} \meta{dimension} \Arg{dimension expression} % \end{syntax} % Adds the result of the \meta{dimension expression} to the current -% content of the \meta{dimension}. This assignment is local. -% \end{function} -% -% \begin{function}{\dim_gadd:Nn, \dim_gadd:cn} -% \begin{syntax} -% \cs{dim_gadd:Nn} \meta{dimension} \Arg{dimension expression} -% \end{syntax} -% Adds the result of the \meta{dimension expression} to the -% current content of the \meta{dimension}. This assignment is global. +% content of the \meta{dimension}. % \end{function} % -% \begin{function}[updated = 2011-10-22]{\dim_set:Nn, \dim_set:cn} +% \begin{function}[updated = 2011-10-22] +% {\dim_set:Nn, \dim_set:cn, \dim_gset:Nn, \dim_gset:cn} % \begin{syntax} % \cs{dim_set:Nn} \meta{dimension} \Arg{dimension expression} % \end{syntax} % Sets \meta{dimension} to the value of \meta{dimension expression}, which -% must evaluate to a length with units. This assignment is -% restricted to the current \TeX{} group. -% \end{function} -% -% \begin{function}{\dim_gset:Nn, \dim_gset:cn} -% \begin{syntax} -% \cs{dim_gset:Nn} \meta{dimension} \Arg{dimension expression} -% \end{syntax} -% Sets \meta{dimension} to the value of \meta{dimension expression}, which -% must evaluate to a length with units and may include a rubber -% component (for example |1 cm plus 0.5 cm|. This assignment is -% global and is not limited to the current \TeX{} group level. +% must evaluate to a length with units. % \end{function} % % \begin{function} -% {\dim_set_eq:NN, \dim_set_eq:cN, \dim_set_eq:Nc, \dim_set_eq:cc} +% { +% \dim_set_eq:NN, \dim_set_eq:cN, \dim_set_eq:Nc, \dim_set_eq:cc, +% \dim_gset_eq:NN, \dim_gset_eq:cN, \dim_gset_eq:Nc, \dim_gset_eq:cc +% } % \begin{syntax} % \cs{dim_set_eq:NN} \meta{dimension1} \meta{dimension2} % \end{syntax} % Sets the content of \meta{dimension1} equal to that of -% \meta{dimension2}. This assignment is restricted to the current -% \TeX{} group level. +% \meta{dimension2}. % \end{function} % -% \begin{function} -% {\dim_gset_eq:NN, \dim_gset_eq:cN, \dim_gset_eq:Nc, \dim_gset_eq:cc} -% \begin{syntax} -% \cs{dim_gset_eq:NN} \meta{dimension1} \meta{dimension2} -% \end{syntax} -% Sets the content of \meta{dimension1} equal to that of \meta{dimension2}. -% This assignment is global and so is not limited by the current -% \TeX{} group level. -% \end{function} -% -% \begin{function}[updated = 2011-10-22]{\dim_set_max:Nn, \dim_set_max:cn} +% \begin{function}[updated = 2011-10-22] +% {\dim_set_max:Nn, \dim_set_max:cn, \dim_gset_max:Nn, \dim_gset_max:cn} % \begin{syntax} % \cs{dim_set_max:Nn} \meta{dimension} \Arg{dimension expression} % \end{syntax} % Compares the current value of the \meta{dimension} with that of the % \meta{dimension expression}, and sets the \meta{dimension} to the -% larger of these two value. This assignment is local to the current -% \TeX{} group. +% larger of these two value. % \end{function} % -% \begin{function}[updated = 2011-10-22]{\dim_gset_max:Nn, \dim_gset_max:cn} -% \begin{syntax} -% \cs{dim_gset_max:Nn} \meta{dimension} \Arg{dimension expression} -% \end{syntax} -% Compares the current value of the \meta{dimension} with that of the -% \meta{dimension expression}, and sets the \meta{dimension} to the -% larger of these two value. This assignment is global. -% \end{function} -% -% \begin{function}[updated = 2011-10-22]{\dim_set_min:Nn, \dim_set_min:cn} +% \begin{function}[updated = 2011-10-22] +% {\dim_set_min:Nn, \dim_set_min:cn, \dim_gset_min:Nn, \dim_gset_min:cn} % \begin{syntax} % \cs{dim_set_min:Nn} \meta{dimension} \Arg{dimension expression} % \end{syntax} % Compares the current value of the \meta{dimension} with that of the % \meta{dimension expression}, and sets the \meta{dimension} to the -% smaller of these two value. This assignment is local to the current -% \TeX{} group. -% \end{function} -% -% \begin{function}[updated = 2011-10-22]{\dim_gset_min:Nn, \dim_gset_min:cn} -% \begin{syntax} -% \cs{dim_gset_min:Nn} \meta{dimension} \Arg{dimension expression} -% \end{syntax} -% Compares the current value of the \meta{dimension} with that of the -% \meta{dimension expression}, and sets the \meta{dimension} to the -% smaller of these two value. This assignment is global. +% smaller of these two value. % \end{function} % -% \begin{function}[updated = 2011-10-22]{\dim_sub:Nn, \dim_sub:cn} +% \begin{function}[updated = 2011-10-22] +% {\dim_sub:Nn, \dim_sub:cn, \dim_gsub:Nn, \dim_gsub:cn} % \begin{syntax} % \cs{dim_sub:Nn} \meta{dimension} \Arg{dimension expression} % \end{syntax} % Subtracts the result of the \meta{dimension expression} to the -% current content of the \meta{dimension}. This assignment is local. -% \end{function} -% -% \begin{function}{\dim_gsub:Nn, \dim_gsub:cn} -% \begin{syntax} -% \cs{dim_gsub:Nn} \meta{dimension} \Arg{dimension expression} -% \end{syntax} -% Subtracts the result of the \meta{dimension expression} to the -% current content of the \meta{dimension}. This assignment is global. +% current content of the \meta{dimension}. % \end{function} % % \section{Utilities for dimension calculations} @@ -428,6 +369,14 @@ % Displays the value of the \meta{dimension} on the terminal. % \end{function} % +% \begin{function}[added = 2011-11-22]{\dim_show:n} +% \begin{syntax} +% \cs{dim_show:n} \meta{dimension expression} +% \end{syntax} +% Displays the result of evaluating the \meta{dimension expression} +% on the terminal. +% \end{function} +% % \section{Constant dimensions} % % \begin{variable}{\c_max_dim} @@ -466,94 +415,53 @@ % will initially be equal to $0$\,pt. % \end{function} % -% \begin{function}{\skip_zero:N, \skip_zero:c} +% \begin{function}{\skip_zero:N, \skip_zero:c, \skip_gzero:N, \skip_gzero:c} % \begin{syntax} % \cs{skip_zero:N} \meta{skip} % \end{syntax} -% Sets \meta{skip} to $0$\,pt within the scope of the current -% \TeX{} group. -% \end{function} -% -% \begin{function}{\skip_gzero:N, \skip_gzero:c} -% \begin{syntax} -% \cs{skip_gzero:N} \meta{skip} -% \end{syntax} -% Sets \meta{skip} to $0$\,pt globally, \emph{i.e.}~not -% restricted by the current \TeX{} group level. +% Sets \meta{skip} to $0$\,pt. % \end{function} + % % \section{Setting \texttt{skip} variables} % -% \begin{function}[updated = 2011-10-22]{\skip_add:Nn, \skip_add:cn} +% \begin{function}[updated = 2011-10-22] +% {\skip_add:Nn, \skip_add:cn, \skip_gadd:Nn, \skip_gadd:cn} % \begin{syntax} % \cs{skip_add:Nn} \meta{skip} \Arg{skip expression} % \end{syntax} % Adds the result of the \meta{skip expression} to the current -% content of the \meta{skip}. This assignment is local. -% \end{function} -% -% \begin{function}{\skip_gadd:Nn, \skip_gadd:cn} -% \begin{syntax} -% \cs{skip_gadd:Nn} \meta{skip} \Arg{skip expression} -% \end{syntax} -% Adds the result of the \meta{skip expression} to the -% current content of the \meta{skip}. This assignment is global. +% content of the \meta{skip}. % \end{function} % -% \begin{function}[updated = 2011-10-22]{\skip_set:Nn, \skip_set:cn} +% \begin{function}[updated = 2011-10-22] +% {\skip_set:Nn, \skip_set:cn, \skip_gset:Nn, \skip_gset:cn} % \begin{syntax} % \cs{skip_set:Nn} \meta{skip} \Arg{skip expression} % \end{syntax} % Sets \meta{skip} to the value of \meta{skip expression}, which % must evaluate to a length with units and may include a rubber -% component (for example |1 cm plus 0.5 cm|. This assignment is -% restricted to the current \TeX{} group. -% \end{function} -% -% \begin{function}{\skip_gset:Nn, \skip_gset:cn} -% \begin{syntax} -% \cs{skip_gset:Nn} \meta{skip} \Arg{skip expression} -% \end{syntax} -% Sets \meta{skip} to the value of \meta{skip expression}, which -% must evaluate to a length with units and may include a rubber -% component (for example |1 cm plus 0.5 cm|. This assignment is -% global and is not limited to the current \TeX{} group level. +% component (for example |1 cm plus 0.5 cm|. % \end{function} % % \begin{function} -% {\skip_set_eq:NN, \skip_set_eq:cN, \skip_set_eq:Nc, \skip_set_eq:cc} +% { +% \skip_set_eq:NN, \skip_set_eq:cN, \skip_set_eq:Nc, \skip_set_eq:cc, +% \skip_gset_eq:NN, \skip_gset_eq:cN, \skip_gset_eq:Nc, \skip_gset_eq:cc +% } % \begin{syntax} % \cs{skip_set_eq:NN} \meta{skip1} \meta{skip2} % \end{syntax} -% Sets the content of \meta{skip1} equal to that of -% \meta{skip2}. This assignment is restricted to the current -% \TeX{} group level. -% \end{function} -% -% \begin{function} -% {\skip_gset_eq:NN, \skip_gset_eq:cN, \skip_gset_eq:Nc, \skip_gset_eq:cc} -% \begin{syntax} -% \cs{skip_gset_eq:NN} \meta{skip1} \meta{skip2} -% \end{syntax} % Sets the content of \meta{skip1} equal to that of \meta{skip2}. -% This assignment is global and so is not limited by the current -% \TeX{} group level. % \end{function} % -% \begin{function}[updated = 2011-10-22]{\skip_sub:Nn, \skip_sub:cn} +% \begin{function}[updated = 2011-10-22] +% {\skip_sub:Nn, \skip_sub:cn, \skip_gsub:Nn, \skip_gsub:cn} % \begin{syntax} % \cs{skip_sub:Nn} \meta{skip} \Arg{skip expression} % \end{syntax} % Subtracts the result of the \meta{skip expression} to the -% current content of the \meta{skip}. This assignment is local. -% \end{function} -% -% \begin{function}{\skip_gsub:Nn, \skip_gsub:cn} -% \begin{syntax} -% \cs{skip_gsub:Nn} \meta{skip} \Arg{skip expression} -% \end{syntax} -% Subtracts the result of the \meta{skip expression} to the -% current content of the \meta{skip}. This assignment is global. +% current content of the \meta{skip}. % \end{function} % % \section{Skip expression conditionals} @@ -622,6 +530,14 @@ % Displays the value of the \meta{skip} on the terminal. % \end{function} % +% \begin{function}[added = 2011-11-22]{\skip_show:n} +% \begin{syntax} +% \cs{skip_show:n} \meta{skip expression} +% \end{syntax} +% Displays the result of evaluating the \meta{skip expression} +% on the terminal. +% \end{function} +% % \section{Constant skips} % % \begin{variable}{\c_max_skip} @@ -660,100 +576,56 @@ % will initially be equal to $0$\,mu. % \end{function} % -% \begin{function}{\muskip_zero:N, \muskip_zero:c} +% \begin{function} +% {\muskip_zero:N, \muskip_zero:c, \muskip_gzero:N, \muskip_gzero:c} % \begin{syntax} % \cs{skip_zero:N} \meta{muskip} % \end{syntax} -% Sets \meta{muskip} to $0$\,mu within the scope of the current -% \TeX{} group. -% \end{function} -% -% \begin{function}{\muskip_gzero:N, \muskip_gzero:c} -% \begin{syntax} -% \cs{muskip_gzero:N} \meta{muskip} -% \end{syntax} -% Sets \meta{muskip} to $0$\,mu globally, \emph{i.e.}~not -% restricted by the current \TeX{} group level. +% Sets \meta{muskip} to $0$\,mu. % \end{function} % % \section{Setting \texttt{muskip} variables} % -% \begin{function}[updated = 2011-10-22]{\muskip_add:Nn, \muskip_add:cn} +% \begin{function}[updated = 2011-10-22] +% {\muskip_add:Nn, \muskip_add:cn, \muskip_gadd:Nn, \muskip_gadd:cn} % \begin{syntax} % \cs{muskip_add:Nn} \meta{muskip} \Arg{muskip expression} % \end{syntax} % Adds the result of the \meta{muskip expression} to the current -% content of the \meta{muskip}. This assignment is local. -% \end{function} -% -% \begin{function}{\muskip_gadd:Nn, \muskip_gadd:cn} -% \begin{syntax} -% \cs{muskip_gadd:Nn} \meta{muskip} \Arg{muskip expression} -% \end{syntax} -% Adds the result of the \meta{muskip expression} to the -% current content of the \meta{muskip}. This assignment is global. +% content of the \meta{muskip}. % \end{function} % -% \begin{function}[updated = 2011-10-22]{\muskip_set:Nn, \muskip_set:cn} +% \begin{function}[updated = 2011-10-22] +% {\muskip_set:Nn, \muskip_set:cn, \muskip_gset:Nn, \muskip_gset:cn} % \begin{syntax} % \cs{muskip_set:Nn} \meta{muskip} \Arg{muskip expression} % \end{syntax} % Sets \meta{muskip} to the value of \meta{muskip expression}, which % must evaluate to a math length with units and may include a rubber -% component (for example |1 mu plus 0.5 mu|. This assignment is -% restricted to the current \TeX{} group. -% \end{function} -% -% \begin{function}{\muskip_gset:Nn, \muskip_gset:cn} -% \begin{syntax} -% \cs{muskip_gset:Nn} \meta{muskip} \Arg{muskip expression} -% \end{syntax} -% Sets \meta{muskip} to the value of \meta{muskip expression}, which -% must evaluate to a math length with units and may include a rubber -% component (for example |1 mu plus 0.5 mu|. This assignment is -% global and is not limited to the current \TeX{} group level. +% component (for example |1 mu plus 0.5 mu|. % \end{function} % % \begin{function} % { -% \muskip_set_eq:NN, \muskip_set_eq:cN, -% \muskip_set_eq:Nc, \muskip_set_eq:cc +% \muskip_set_eq:NN, \muskip_set_eq:cN, +% \muskip_set_eq:Nc, \muskip_set_eq:cc, +% \muskip_gset_eq:NN, \muskip_gset_eq:cN, +% \muskip_gset_eq:Nc, \muskip_gset_eq:cc % } % \begin{syntax} % \cs{muskip_set_eq:NN} \meta{muskip1} \meta{muskip2} % \end{syntax} % Sets the content of \meta{muskip1} equal to that of -% \meta{muskip2}. This assignment is restricted to the current -% \TeX{} group level. -% \end{function} -% -% \begin{function} -% { -% \muskip_gset_eq:NN, \muskip_gset_eq:cN, -% \muskip_gset_eq:Nc, \muskip_gset_eq:cc -% } -% \begin{syntax} -% \cs{muskip_gset_eq:NN} \meta{muskip1} \meta{muskip2} -% \end{syntax} -% Sets the content of \meta{muskip1} equal to that of \meta{muskip2}. -% This assignment is global and so is not limited by the current -% \TeX{} group level. +% \meta{muskip2}. % \end{function} % -% \begin{function}[updated = 2011-10-22]{\muskip_sub:Nn, \muskip_sub:cn} +% \begin{function}[updated = 2011-10-22] +% {\muskip_sub:Nn, \muskip_sub:cn, \muskip_gsub:Nn, \muskip_gsub:cn} % \begin{syntax} % \cs{muskip_sub:Nn} \meta{muskip} \Arg{muskip expression} % \end{syntax} % Subtracts the result of the \meta{muskip expression} to the -% current content of the \meta{skip}. This assignment is local. -% \end{function} -% -% \begin{function}{\muskip_gsub:Nn, \muskip_gsub:cn} -% \begin{syntax} -% \cs{muskip_gsub:Nn} \meta{muskip} \Arg{muskip expression} -% \end{syntax} -% Subtracts the result of the \meta{muskip expression} to the -% current content of the \meta{muskip}. This assignment is global. +% current content of the \meta{skip}. % \end{function} % % \section{Using \texttt{muskip} expressions and variables} @@ -822,6 +694,14 @@ % Displays the value of the \meta{muskip} on the terminal. % \end{function} % +% \begin{function}[added = 2011-11-22]{\muskip_show:n} +% \begin{syntax} +% \cs{muskip_show:n} \meta{muskip expression} +% \end{syntax} +% Displays the result of evaluating the \meta{muskip expression} +% on the terminal. +% \end{function} +% % \section{Internal functions} % % \begin{function}{\if_dim:w} @@ -1339,6 +1219,14 @@ % \end{macrocode} % \end{macro} % +% \begin{macro}{\dim_show:n} +% Diagnostics. +% \begin{macrocode} +\cs_new_protected:Npn \dim_show:n #1 + { \tex_showthe:D \dim_eval:w #1 \dim_eval_end: } +% \end{macrocode} +% \end{macro} +% % \subsection{Constant dimensions} % % \begin{variable}{\c_zero_dim} @@ -1542,6 +1430,14 @@ % \end{macrocode} % \end{macro} % +% \begin{macro}{\skip_show:n} +% Diagnostics. +% \begin{macrocode} +\cs_new_protected:Npn \skip_show:n #1 + { \tex_showthe:D \etex_glueexpr:D #1 \scan_stop: } +% \end{macrocode} +% \end{macro} +% % \subsection{Constant skips} % % \begin{macro}{\c_zero_skip} @@ -1684,7 +1580,15 @@ \cs_new_eq:NN \muskip_show:N \kernel_register_show:N \cs_generate_variant:Nn \muskip_show:N { c } % \end{macrocode} -% \end{macro} +% \end{macro} +% +% \begin{macro}{\muskip_show:n} +% Diagnostics. +% \begin{macrocode} +\cs_new_protected:Npn \muskip_show:n #1 + { \tex_showthe:D \etex_muexpr:D #1 \scan_stop: } +% \end{macrocode} +% \end{macro} % % \subsection{Experimental skip functions} % |