Debian Codegraph @

texmf-dist/doc/optex/base/README

raw
1 OpTeX: the LuaTeX format based on Plain TeX and OPmac
2
3 Author: Petr Olsak, <[email protected]>
4
5 Co-author: Michal Vlasák, <[email protected]>
6 (Lua code, colors by attributes, interface to tikz, minim)
7
8 This software is in public domain.
9
10 See http://petr.olsak.net/optex
11
12 Files:
13
14 base/ ... basic set of macro files used when optex.fmt is generated
15 and more basic macros loaded on demand during document processing.
16 demo/ ... examples: short document: op-demo.tex, short letter: op-letter.tex,
17 presentation slides: op-slides.tex.
18 pkg/ ... external macros. Maybe, they can be created by other authors if
19 the macro file conforms to the rules given in the section 2.2.5
20 in the OpTeX documentation.
21 doc/ ... PDF version of the OpTeX documentation and sources.
22
23 History:
24
25 <1.20> May 2026:
26 Box-direction dependent macros corrected / reimplemented (thanks Udi-Fogiel).
27 Extensible arrows implemented in math.opm package.
28 A filter for creating bib. references enabled.
29 \mathadef, \inspicto, \ordnum, \tracingnone, \verbhyphens introduced.
30 \frquotes redefined.
31 Various little bugs fixed.
32 <1.19> Feb 2026:
33 Little improvements and bug fixes
34 f-raleway font file added
35 More OpTeX tricks
36 <1.18> May 2025:
37 Bug causing slow processing fixed (the bug occurred in version 1.17)
38 \foreachx introduced
39 several font files added
40 doc.opm enables to set strings without backslash as main-point too
41
42 <1.17> Feb 2025:
43 OpTeX uses luahbtex instead luatex as default engine (from TeXlive 2025)
44 Default PDF version changed from 1.5 to 1.7
45 f-alegreya added
46 math.opm: \mathselector (for using text fonts in math mode) introduced
47 \it, \rm in math mode use script=latn, no italic corrections between letters
48 \pdfstring implemented using Lua, newly used for PDF outlines
49 optex.lua modified
50 several OpTeX tricks added
51 minor bugs fixed
52 <1.16> Dec 2024:
53 JSON files and tree structure support as a set of OpTeX tricks
54 CSV databases support as a set of OpTeX tricks
55 \xloop implemented
56 Processing speed slightly improved for sort and \replstring
57 \replstring, \foreach: fixed the braces-loss problem
58 Font family files added
59 Multicolumn: measurement of big boxes improved
60 Minor corrections, small improvements
61 <1.15> Jun 2024:
62 \qcasesof improved: more alternative patterns can be declared using |.
63 \loadtrick is expandable now.
64 More OpTeX tricks added.
65 Minor improvements and minor bug fixes.
66 <1.14> Feb 2024:
67 More links in doc: TeX primitives linked to TeX in a Nutshell.
68 \trykv returns unexpanded value of the key=value pair.
69 \bracedparam reimplemented, improved.
70 \optdef can create an expandable macro.
71 <1.13> Nov 2023:
72 \usebib completely reimplemented, libranian package not needed from now.
73 Selected OpTeX tricks are automatically loaded when a relevant macro is used.
74 Font file for variable font Fraunces added.
75 Clara serif and more font files added.
76 Hebrew data, font family and Hebrew example added.
77 More robust key-value scanner.
78 Minor improvements and minor bug fixes.
79 <1.12> May 2023:
80 Support for right-to-left (Hebrew) typesseting introduced.
81 More features in math.opm style.
82 \_createbibmark in bib-styles introduced.
83 Heuristica and more font-files added.
84 Minor more improvements and bug fixes.
85 <1.11> Mar 2023:
86 \fontfamsub: the substitution of missing families introduced.
87 New font family files created.
88 Minor bugs fixed.
89 <1.10> Feb 2023:
90 key-values improved: \iskv, \kvx, \nokvx introduced.
91 unimath-codes: control sequences are macros, no \chardef.
92 \bp, \expr: optional syntax for setting the number of digits after decimal point.
93 \isnextchar is expandable.
94 math.opm: various improvements.
95 <1.09> Dec 2022:
96 New math.opm package: doing math more comfortable.
97 The math.opm package can be a package template for macro writers.
98 \docgen for printing doucumantation of packages introduced.
99 unimath control sequences are almost all declared by \chardef, no \mathchardef.
100 \casesof, \currfile, \nospaceafter (tools for macro programmers) introduced.
101 \setpos, \posx, \posy moved from OpTeX trick to the format.
102 \sfont, \ufont introduced.
103 More robust \caption parameter.
104 Lato, Kurier, Iwona font families registered.
105 Minor more improvements and bug fixing.
106 <1.08> Aug 2022:
107 Sorting rules for German, French, Polish, Hungarian, ... added.
108 Font files for Montserrat, STIX, XITS, STIXtwo, Overlock added.
109 Minor improvements and bug fixing.
110 <1.07> May 2022:
111 Tikz's \foreach works only in its environment.
112 \lipsum syntax enlarged by dot after paragraph num, example: \lipsum[3.].
113 f-baskervald.opm added.
114 expandable \isinlist implemented.
115 bibstyles \. replaced by \: }due to collision with \oldaccents).
116 Fixed a few bugs.
117 <1.06> Mar. 2022:
118 \transparency selector using attributes implemented.
119 Interface to minim (minim-mp.opm, minim-pdf.opm) introduced.
120 Interface to TikZ (tikz.opm) improved.
121 PDF page resources: management by Lua code implemented.
122 Possibility of preloading no fonts to the format by \let\fontspreload=\relax.
123 hisyntax-lua.opm introduced.
124 plain-at.opm macros included to the format.
125 Language/hyphenations macros reimplemented, phrases file introduced.
126 Font selection: low level macros reimplemented, \fontsel introduced.
127 <1.05> Jan. 2022:
128 \_par used internally instead \par if \partokenname is available.
129 Extended format \ref[label]{text} and \pgref[label]{text} introduced.
130 Fixed a few bugs.
131 <1.04> Aug. 2021:
132 Color handling reimplemented, LuaTeX's attributes are used now.
133 Loading Unicode math fonts reimplemented, (s)script size given by font.
134 Better compatibility with TikZ using tikz.opm package.
135 .ref file: consistency checking added.
136 Versions of .opm files printed only to .log.
137 \tracingmacros=3 or 4 enabled.
138 Bugs fixing.
139 <1.03> Jun. 2021:
140 mte: Package for MicroTypographic Extensions released.
141 Erewhon: font family support added.
142 \rgbcmykmap for RGB-CMYK mapping introduced.
143 \table: sum of \tsizes allowed different from one.
144 doc: hyperlinks from Index created.
145 \url and \link macros re-written.
146 Bugs fixing.
147 <1.02> Apr. 2021
148 Location CTAN:macros/luatex/optex moved to CTAN:macros/optex (similarly for TDS).
149 NewComputerModern font support added.
150 Microtypography support added.
151 Various colors for links can be declared by \def\_<type>linkolor.
152 unimath-codes: \nabla math-code set similar as \Delta.
153 Up to date version of UnicodeData.txt read during format generation.
154 Reading mathclacss.opm improved.
155 slides: hyperlink destinations allowed in \slideshow mode too.
156 \bibpart allows to create independent bib-lists in single document.
157 \setwordspace: format of the parameter improved.
158 <1.01> Mar. 2021
159 Minor code fixes (thanks to reports from users).
160 LibreCaslon font file added.
161 two new callbacks from new LuaTeX 1.13 added to optex.lua
162 active * (in lists) works as normal in math mode.
163 f-heros(\slides): additional font XITSMath loaded (to the base FiraMath font).
164 \_xhsize setting added to \margins.
165 <1.00> Feb. 2021
166 The OMLS (OpTeX Markup Language Standard) was developed. It helps to create
167 converters from/to OpTeX documents and similar applications.
168 \pdfunidef re-imeplemted.
169 \thisoutline introduced.
170 \verbchar introduced instead \activettchar.
171 Bugs fixing.
172 <0.19> Jan. 2021
173 emoji support as pkg/emoji.opm.
174 non-braakable places generated by luavlna, supported as pkg/vlna.opm.
175 \begblock...\endblock introduced.
176 comment character allowed after \begtt.
177 more robust macros: \replstring, \table.
178 complete revision of documentation, spelling corrections.
179 Several bugs fixed.
180 <0.18> Dec. 2020
181 Font support for next 9 families added.
182 Font selection system improved.
183 Documentation (especially about font selection system) corrected.
184 Macros supporting key=value included to the format.
185 \foreach macro improved.
186 Concept of multilang in bib rewritten.
187 \opwarning format changed (line numbers are printed too).
188 Several bugs fixed.
189 <0.17> Nov. 2020
190 optex.lua introduced (instead external ltluatex.lua)
191 hyph.patterns are loaded directly by \patterns, not using lua code
192 \commentchars introduced (comments which are able to interrupt verbatim mode)
193 <0.16> Oct. 2020
194 callback.register_x introduced, namespaces for packages corrected
195 kerkis and EBGaramond fontfiles added
196 little corrections
197 optex-math manual: Index added
198 <0.15> Jun. 2020
199 Release for Overleaf - TL2020.
200 More vertical space above in \chap and \secc.
201 <0.14> Jun. 2020
202 Typeseting Math with OpTeX: new document added.
203 Math macros corrected.
204 In-line verbatim in section titles allowed.
205 \eqbox implemented.
206 "\mnote up", "\displaylines to" (new features implemented)
207 <0.13> May 2020
208 \table have more features: \tabskip, \table to, \table pxto, \vspan
209 The \eqalign reimplemented to be more flexible.
210 The boundary character ":" introduced in the \table.
211 \| undefined in 8bit math: bug fixed.
212 \isnextchar: \let\tmp=#1 -> \let\tmp= #1
213 <0.12> May 2020
214 The external macro qrcode.opm introduced
215 New directory structure: base/, demo/, pkg/, doc/ introduced.
216 \load macro introduced
217 \newif: bug fixed, other bug fixed.
218 <0.11> Apr. 2020
219 \phi, \varpi in Unicode: bug fixed
220 \mathstyles introduced.
221 <0.10> Apr. 2020
222 Technical documentation added
223 \_famdecl instedad \_fontdecl in font family files (incompatible change).
224 <0.09> Syntax highlighting implemented.
225 <0.08> \numberedpar implemented. \emergencystretch=20pt added as default.
226 \inoval, \incircle, \clipinoval, \clipincircle imlemented.
227 \puttext, \putpic x,y instead -y,x (incompatible change!)
228 footnotes have separated color stack now.
229 \fnotelinks implemented.
230 Lists by \begitems...\enditems improved (\novspaces \_vspacehalf, \ilevel).
231 <0.07> demos: op-letter.tex and op-slides.tex added.
232 \inkinspic, \transformbox, \slides added.
233 documentation improved and updated.
234 <0.06> tables re-implemented, opmac-rest removed.
235 footnotes, marginal notes reimplemented.
236 sections.opm, graphics.opm, colors.opm, languages re-implemented
237 Cite-bib re-implemented.
238 Index, sorting re-implemented.
239 <0.05> \boldmath reimplemented
240 \fontcolor, \letterspacing implemented
241 font catalogue improved
242 <0.04> references.opl, hyperlinks.opl re-implemented.
243 \fontfam, f-* rewritten: no usage of boundary "..." in \_fontnamegen
244 \fnote{...} corrected: (parameter is not really parameter)
245 verbatim.opl re-implemented + doc added
246 file-ref.opl implemented (new \_Xrefversion{3})
247 bugfixing
248 <0.03> optex-doc optex.1 included,
249 verbatim.opm re-implemented,
250 math-unicode implemented,
251 usebib.opm + bib-style.opm included
252 \catcodetable stack implemented
253 bugfixing of macros.
254 catcodes.opl: removed, one can use \catcodetable, ... primitives,
255 pdfuni-string: lua code for lua5.3 fixed.
256 <0.02> Released.