summaryrefslogtreecommitdiff
path: root/macros/optex/doc/optex-userdoc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/optex/doc/optex-userdoc.tex')
-rw-r--r--macros/optex/doc/optex-userdoc.tex19
1 files changed, 12 insertions, 7 deletions
diff --git a/macros/optex/doc/optex-userdoc.tex b/macros/optex/doc/optex-userdoc.tex
index 16fd468c1f..3fefc22657 100644
--- a/macros/optex/doc/optex-userdoc.tex
+++ b/macros/optex/doc/optex-userdoc.tex
@@ -564,7 +564,8 @@ if optional parameter
`[<label>]` is appended to \^`\chap`, \^`\sec`,
\^`\secc`, \^`\caption/t`, \^`\caption/f` or \^`\eqmark`. The alternative syntax is
to use \^`\label[<label>]` before mentioned commands (not necessarily directly
-before). The reference is realized by \^`\ref[<label>]` or \^`\pgref[<label>]`.
+before). The reference is realized by \^`\ref[<label>]` (prints the number
+of the referenced object) or \^`\pgref[<label>]` (prints the page number).
Example:
\begtt
@@ -582,6 +583,13 @@ or write something about the equation~\ref[pythagoras]. Finally there
is an interesting Table~\ref[comp-depend].
\endtt
+The text printed by \^`\ref` or \^`\pgref` can be given explicitly by
+\^`\ref[<label>]{<text>}` or \^`\pgref[<label>]{<text>}`. If the `<text>`
+includes the `@` character, it is replaced by implicitly printed text.
+Example: `see \ref[lab]{section~@}` prints the same as `see section~\ref[lab]`,
+but first case creates larger active area for mouse clicking, when
+\~`\hyperlinks` are declared.
+
If there are forward referenced objects then users have to run \TeX{} twice.
During each pass, the working `*.ref` file (with references data) is created
and this file is used (if it exists) at the beginning of the document.
@@ -663,7 +671,7 @@ 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 characters \code{\%}, `\`, `#`, `{`, and `}` must be escaped in
the <url> parameter.
The PDF format provides {\em outlines} which are notes placed in the special frame of
@@ -1862,7 +1870,6 @@ put it as the first command in your document:
~magscale'[factor] % resize typesetting, line/page breaking unchanged
~margins'/pg format (left, right, top, bottom)unit % margins setting
-
~report' ~letter' ~slides' % style declaration macros
\endtt
@@ -1959,11 +1966,9 @@ control sequences with the same meaning: in prefixed and unprefixed form.
For example `\hbox` is equal to `\_hbox`.
Internal macros of \OpTeX/ have and use only prefixed form. User should use
unprefixed forms, but prefixed forms are accessible too because the `_` is
-set as a letter category code globally (in macro files and users document too). User
+set as a letter category code globally (in macro files and users document too). Users
should re-define unprefixed forms of control sequences without worries that
-something internal will be broken (only the sequence `\par` cannot be
-re-defined without change of internal \TeX/ behavior because it is
-hard-coded in \TeX/, unfortunately).
+something internal will be broken.
\new
The Latin Modern 8bit fonts instead Computer Modern 7bit fonts are