From 7428e668f046bec10d1200214789e40390fa51e7 Mon Sep 17 00:00:00 2001 From: Norbert Preining Date: Wed, 10 Feb 2021 03:01:13 +0000 Subject: CTAN sync 202102100301 --- macros/luatex/optex/doc/optex-userdoc.tex | 45 ++++++++++++++++++------------- 1 file changed, 27 insertions(+), 18 deletions(-) (limited to 'macros/luatex/optex/doc/optex-userdoc.tex') diff --git a/macros/luatex/optex/doc/optex-userdoc.tex b/macros/luatex/optex/doc/optex-userdoc.tex index 8f2fe4d3d3..899b1d55aa 100644 --- a/macros/luatex/optex/doc/optex-userdoc.tex +++ b/macros/luatex/optex/doc/optex-userdoc.tex @@ -650,7 +650,7 @@ The \^`\url` macro prints its parameter in \~`\tt` font and creates a potential breakpoints in it (after slash or dot, for example). If the \^`\hyperlinks` declaration is used then the parameter of \^`\url` is treated as an external URL link. An example: `\url{http://www.olsak.net}` creates \url{http://www.olsak.net}. -The characters \code{\%}, `\`, `#`, `{` and `}` have to be protected by +The characters \code{\%}, `\`, `#`, `{`, and `}` have to be protected by backslash in the \^`\url` argument, the other special characters `~`, `^`, `&` can be written as single character\fnote {More exactly, there are the same rules as for `\code` command, see @@ -663,6 +663,8 @@ If the linked text have to be different than the URL, you can use `\ulink[http://petr.olsak.net/optex]{\OpTeX/ page}` outputs to the text \ulink[http://petr.olsak.net/optex]{\OpTeX/ page}. +The characters \code{\%}, `\`, `#`, `{`, and `}` must by escaped in +the parameter. The PDF format provides {\em outlines} which are notes placed in the special frame of the PDF viewer. These notes can be managed as a structured and hyperlinked @@ -683,6 +685,11 @@ the main level~0. These entries can be placed before the table of contents (crea by \^`\outlines`) or after it. Their hyperlink destination is in the place where the \^`\insertoutline` macro is used. +The command \^`\thisoutline{}` uses in the outline instead of default +title text for the first following `\chap`, `\sec`, or `\secc`. +Special case: \^`\thisoutline{\relax}` doesn't create any outline for the following +`\chap`, `\sec`, or `\secc`. + \secc Lists %%%%%%%%%% @@ -768,9 +775,9 @@ These letters can be combined by the `|` character (vertical line). Example July & yacht & k\$ 170 \crl} \endtt % -generates the following result: +generates the result: -\medskip +\vskip-\medskipamount \noindent\hfil\table{||lc|r||}{ \crl Month & commodity & price \crli \tskip2pt January & notebook & \$ 700 \cr @@ -902,29 +909,28 @@ You can use this for creating tables like in the following example: & Exclusive & \mspan3[c|]{} &\mspan3[c|] X \crl \vspan2{II} & Informal & \mspan3[c|] X &\mspan3[c|] X \crlp{2-8} & Formal & \mspan6[c|] X \crl - \vspan2{III} & Informal & \vspan2 O & X & X &\mspan2[c|] X & \vspan2 O \crlp{2,4-7} + \vspan2{III} & Informal & \vspan2{O} & X & X &\mspan2[c|] X & \vspan2{O} \crlp{2,4-7} & Formal & &\mspan4[c|] X & \crl }}\pdfrestore} \hangindent=-7.5cm \hangafter=0 -The parameter of \^`\vspan` must be one-digit number. -If you want to set more digits then use braces. -You can use non-integer values too if you feel that the -result is better, for example \^`\vspan{2.1}{text}`. +You can use \^`\vspan` with non-integer parameter too if you feel that the +result looks better, for example \^`\vspan2.1{text}`. \hangindent=-7.5cm \hangafter=0 The rule width of tables and implicit width of all `\vrule`s and `\hrule`s can be set by the command \^`\rulewidth=`. The default value given by \TeX/ is 0.4\,pt. +\hangindent=-7.5cm \hangafter=-2 The `c`, `l`, `r` and `p` are default \"declaration letters" but you can define more such letters by `\def\_tabdeclare{##}`. More about it is in technical documentation in section~\ref[table.impl]. -See the definition of the \^`\tabdeclarec` macro, for example. +See the definition of the \^`\_tabdeclarec` macro, for example. The `:` columns boundary declarator is described in section~\ref[table.bound]. The tables with given width can be declared by `to` or `pxto`. -More about it is in section~\ref[table.w] +More about it is in section~\ref[table.w]. Many tips about tables can be seen on the site \url{http://petr.olsak.net/optex/optex-tricks.html}. @@ -935,7 +941,7 @@ The display verbatim text have to be surrounded by the \^`\begtt` and \^`\endtt` couple. The in-line verbatim have to be tagged (before and after) by a character which is declared by -\^`\activettchar```. For example \code{\\activettchar`} +\^`\verbchar```. For example \code{\\verbchar`} declares the character \code{`} for in-line verbatim markup. And you can use \code{`\\relax`} for @@ -974,7 +980,7 @@ the parameter of \^`\everytt` is read. So you don't have to worry about active categories in this parameter. There is an alternative to \^`\everytt` named \^`\everyintt` which is used for -in-line verbatim surrounded by an \^`\activettchar` or processed by the \~`\code` +in-line verbatim surrounded by an \^`\verbchar` or processed by the \~`\code` command. The \^`\everytt` is applied to all \^`\begtt...`\^`\endtt` environments (if it is not @@ -997,7 +1003,7 @@ Each occurrence of ? will be changed to ! and vice versa. @ \endtt -The in-line verbatim surrounded by an `\activettchar` doesn't work in +The in-line verbatim surrounded by a \^`\verbchar` doesn't work in parameter of macros and macro definitions. (It works in titles declared by \~`\chap`, \~`\sec` etc. and in \~`\fnote`s, because these macros are specially defined in \OpTeX/). @@ -1556,10 +1562,11 @@ coordinates ``, ``. More exactly the left edge of its baseline is at that position. \new -The \^`\putpic` ` {}` puts the `` of given +The \^`\putpic` ` {}` puts an image +given by `` (including extension) of given `` and `` at given position (its left-bottom corner). -You can write \^`\nospec` instead `` or `` if this parameter is -not given. +You can write \^`\nospec` instead `` or `` if this parameter +is not specified. \sec Others %%%%%%%%%%% @@ -1795,7 +1802,7 @@ put it as the first command in your document: ~endblock' % end of block of text ~begtt' % start a verbatim text ~endtt' % end verbatim text -~activettchar' X % initialization character X for in-text verbatim +~verbchar' X % initialization character X for in-text verbatim ~code' % another alternative for in-text verbatim ~verbinput' % verbatim extract from the external file ~begmulti' num % start multicolumn text (num columns) @@ -1873,7 +1880,8 @@ documentation. \^`\foreach` `\do {}` is exapandable loop over .\nl \^`\foreachdef` `\macro {}` declares expandable `\macro` as loop over .\nl \^`\fornum` `..\do {}` is expanadable loop with numeric variable.\nl -\^`\ignoreit` ``, \^`\ignoresecond` ``, \^`\usesecond` `` ignores parameters.\nl +\^`\incr` `` increases and \^`\decr` `` decreases `` by one globally.\nl +\^`\ignoreit` ``, \^`\ignoresecond` `` ignores given parameter.\nl `\expandafter` \^`\ignorept` `\the` expands to decimal number without `pt`.\nl \~`\isempty`, \~`\istoksempty`, \~`\isequal`, \~`\ismacro`, \~`\isdefined`, \~`\isinlist` \~`\isfile`, \~`\isfont` do various tests. Example: \~`\isinlist\list{}\iftrue` does @@ -1899,6 +1907,7 @@ documentation. \^`\slet` `{}{}` behaves like `\let\=\`\nl \^`\sxdef` `{}{}` behaves like `\xdef\{}`.\nl \^`\trycs`` {}{}` expands `\` if it is defined else expands .\nl +\^`\useit` ``, \^`\usesecond` `` uses given parameter.\nl \^`\wlog`` {}` writes to .log file.\nl \^`\wterm`` {}` writes to the terminal and .log file.\nl \^`\xargs`` ... ;` repeats for each .\nl -- cgit v1.2.3