diff options
author | Norbert Preining <norbert@preining.info> | 2020-05-07 03:01:09 +0000 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2020-05-07 03:01:09 +0000 |
commit | 56bd1f5b8377f54b4af39a114362a7762d27f13c (patch) | |
tree | 882c573288f2a3f158b490ea3de1672fca9e94a9 /macros/luatex/optex/doc | |
parent | 36d8a5cd45b5a96007208a0d5b1f52e708d0fec8 (diff) |
CTAN sync 202005070301
Diffstat (limited to 'macros/luatex/optex/doc')
-rw-r--r-- | macros/luatex/optex/doc/optex-doc.pdf | bin | 1147940 -> 1172140 bytes | |||
-rw-r--r-- | macros/luatex/optex/doc/optex-doc.tex | 21 | ||||
-rw-r--r-- | macros/luatex/optex/doc/optex-techdoc.tex | 9 | ||||
-rw-r--r-- | macros/luatex/optex/doc/optex-userdoc.tex | 50 |
4 files changed, 59 insertions, 21 deletions
diff --git a/macros/luatex/optex/doc/optex-doc.pdf b/macros/luatex/optex/doc/optex-doc.pdf Binary files differindex 7f9ec85ac8..caaf6319c7 100644 --- a/macros/luatex/optex/doc/optex-doc.pdf +++ b/macros/luatex/optex/doc/optex-doc.pdf diff --git a/macros/luatex/optex/doc/optex-doc.tex b/macros/luatex/optex/doc/optex-doc.tex index b4e41b6874..267474b24b 100644 --- a/macros/luatex/optex/doc/optex-doc.tex +++ b/macros/luatex/optex/doc/optex-doc.tex @@ -1,33 +1,34 @@ %% This is part of OpTeX project, see http://petr.olsak.net/optex -% Run optex optex-doc (three times) to generate OpTeX documentation. +% Run optex optex-doc +% (three times) to generate OpTeX documentation including references and the index. -\input doc.opm \let\enddocument=\endinput +\load [doc.opm] \let\enddocument=\endinput -\typosize[10/12] +\typosize[10/12] % Main size (used in techdoc) -\let\new=\relax +\begingroup \typosize [11/13.5] % Different size used in useroc. -\begingroup \typosize [11/13.5] +\insertoutline{OpTeX} % PDF outlines generated from TOC -\insertoutline{OpTeX} +% Title: \vglue1cm \centerline{\setfontsize{at50pt}\rm\OpTeX} \vskip-8mm \tit Format Based on Plain \TeX/ and OPmac\fnotemark1 -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\hfill Version 0.10 +\hfill Version 0.12 \centerline{\it Petr Olšák, 2020} \bigskip \centerline{\url{http://petr.olsak.net/optex}} -\fnotetext {The OPmac package is a set of simple additional macros to Plain \TeX{}. It -enables users to take advantage of \LaTeX/ functionality but keeps +\fnotetext {The OPmac package is a set of simple additional macros to Plain \TeX{}. +It enables users to take advantage of \LaTeX/ functionality but keeps Plain \TeX/ simplicity. See \url{http://petr.olsak.net/opmac-e.html} for more information about it.} diff --git a/macros/luatex/optex/doc/optex-techdoc.tex b/macros/luatex/optex/doc/optex-techdoc.tex index 802a87d89f..561f2a8685 100644 --- a/macros/luatex/optex/doc/optex-techdoc.tex +++ b/macros/luatex/optex/doc/optex-techdoc.tex @@ -1,9 +1,10 @@ %% This is part of OpTeX project, see http://petr.olsak.net/optex % This file is read from optex-doc.tex -% Use: optex optex-doc (three times) to create whole documentation. +% Use: optex optex-doc +% (three times) to create whole documentation including all references and the index. -\ifx\printdoc\undefined \input doc.opm \fi +\load [doc.opm] \chap Technical documentation @@ -81,9 +82,7 @@ the `\dump` command. \printdoctail prefixed.opm \secc The implementation of the name spaces -\edef\_Endcode{\_bslash _endcode\_pcent} \printdoc prefixed.opm -\edef\_Endcode{\_bslash _endcode} \sec pdf\TeX/ initialization \printdoctail luatex-ini.opm @@ -124,7 +123,7 @@ Differences are mentioned in the documentation below. \secc Implementation of the Font Selection System \printdoc fonts-select.opm -\sec Preloaded fonts for math mode +\sec [math-preload] Preloaded fonts for math mode \printdoctail math-preload.opm \printdoc math-preload.opm diff --git a/macros/luatex/optex/doc/optex-userdoc.tex b/macros/luatex/optex/doc/optex-userdoc.tex index 470214dfdc..d9c537559f 100644 --- a/macros/luatex/optex/doc/optex-userdoc.tex +++ b/macros/luatex/optex/doc/optex-userdoc.tex @@ -3,6 +3,8 @@ % This file is read from optex-doc.tex % Use: optex optex-doc (three times) to create whole documentation. +\let\new=\relax + \sec Starting with \OpTeX/ %%%%%%%%%%%%%%%%%%%%%%%%% @@ -389,7 +391,7 @@ The following math alphabets are available: The last two selectors \^`\bf` and \^`\bi` select the sans serif fonts in math regardless the current text font family. This is common notation for vectors and -matrices. You can re-declare it, see the file `unimath-codes.opm` where +matrices. You can re-declare them, see the file `unimath-codes.opm` where Unicode math variants of \^`\bf` and \^`\bi` selectors are defined. The math fonts can be scaled by \^`\typosize` and \^`\typoscale` macros. @@ -401,7 +403,9 @@ is usable for math formulae in titles typeset in bold, for example. You can use \^`\mathbox{<text>}` inside math mode. It behaves as `{\hbox{<text>}}` (i.e. the <text> is printed in horizontal non-math mode) but the size of the <text> is adapted to the context of math size (text or script or -scriptscript). +scriptscript). Moreover, there is the macro \^`\mathstyles{<math list>}` which depends on +the current math style. It is documented at the end of the +section~\ref[math-macros]. \sec Typical elements of document @@ -1599,6 +1603,30 @@ Analogical declaration macro `\book` is not prepared. Each book needs an individual typographical care. You need to create specific macros for design. +\secc Loading other macro packages +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +You can load more macro packages by `\input{<file-name>}` or by +\^`\load[<file-names>]`. The first case is \TeX/ primitive command, it can be +used in the alternative old syntax `\input <filename><space>` too. The +second case allows to specify a comma separated list of included files. +Moreover, the \^`\load` macro loads each macro file only once, it sets +temporarily standard category codes during loading and it tries to +load `<filename>.opm` or `<filename>.tex` or `<filename>`, first occurence +wins. Example: +\begtt +\load [qrcode, tikz] +\endtt +% +does `\input qrcode.opm` \,and `\input tikz.tex` \,and it saves +local information about the fact that these file names +`qrcode` and `tikz` were already used, i.\,e. next \^`\load` will skip them. + +It is strongly recommended to use the `\load` macro for loading external +macros, if you need them. On the other hand, if your document is structured +to more files, use simply the `\input` primitive. + + \secc Lorem ipsum dolor sit %%%%%%%%%%%%%%%%%%%%%%%%%%% @@ -1658,7 +1686,7 @@ put it as the first command in your document: \sec Summary %%%%%%%%%%%% -\begtt \typosize[10/12]\adef!{\string\endtt}\adef&{\kern.25em} +\begtt \typosize[9/11]\adef!{\string\endtt}\adef&{\kern.25em} \tit Title (terminated by end of line) \chap Chapter Title (terminated by end of line) \sec Section Title (terminated by end of line) @@ -1692,6 +1720,7 @@ put it as the first command in your document: \bib [labname] % an item in the list of references \usebib/? (style) bib-base % direct using of .bib file, ? in {s,c} +\load [<filenames>] % loadaing macro files \fontfam [FamilyName] % selection of font family \typosize [font-size/baselineskip] % size setting of typesetting \typoscale [factor-font/factor-baselineskip] % size scaling @@ -1738,11 +1767,17 @@ use after the command \~`\fontfam[LMfonts]` which reads the fonts in OTF format. \new -The text accents macros like `\'`, `\v`, `\"` are undefined\fnote +Plain \TeX/ defines `\newcount`, `\bye` etc. as `\outer` macros. \OpTeX/ +doesn't set any macro as `\outer`. Macros like `\TeX`, `\rm` are defined as +`\protected`. + +\new +The text accents macros `\"`, `\'`, `\v`, `\u`, `\=`, `\^`, `\.`, `\H`, +`\~`, \code{\\`}, `\t` are undefined\fnote {The math accents macros like `\acute`, `\bar`, `\dot`, `\hat` still work.} in \OpTeX/. Use real -letters like á, ř, ž in your source document instead these old accents macros. -If you really want to use them, you can initialize them by \^`\oldaccents` +letters like á, ř, ž in your source document instead of these old accents macros. +If you really want to use them, you can initialize them by the \^`\oldaccents` command. But we don't recommend it. \new @@ -1756,6 +1791,9 @@ The origin for typographical area is not at top left 1\,in 1\,in coordinates but at top left paper corner exactly. For example, `\hoffset` includes directly left margin. +The `\sec` macro is reserved to sections but original Plain \TeX/ declares this +control sequence for math secans. + \enddocument |