summaryrefslogtreecommitdiff
path: root/macros/luatex/generic/minim/minim.doc
blob: a0ad8f2d4a124c9e13ac23b21a7f39d5f2a9f84c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

\input minim-doc.sty

\startmetadata
    author   {Esger Renkema}
    title    {minim}
    date     {2022-03-03}
    version  {2022/1.1}
    keywords {LuaTeX; Plain TeX; MetaPost; PDF/A; Tagged PDF; accessibility; a11y;
              Unicode mathematics; XMP; metadata; hypertext; bookmarks}
stopmetadata

\maketitle

This is a modern plain format for the LuaTeX engine, adding improved low-level 
support for many LuaTeX extensions and newer PDF features. While it can be 
used as drop-in replacement for plain TeX, it probably is most useful as 
a basis for your own formats.

Most features included in the format are provided by separate packages that can 
be used on their own; see the packages

\smallskip\marktableaslist \halign {\strut
    \vrule height10ptdepth2ptwidth0pt\qquad
    \red{#}\quad\hfil&#\hfil\cr
minim-mp&for mplib (MetaPost) support\cr
minim-math&for Unicode mathematics\cr
minim-pdf&for hypertext and Tagged PDF\cr
minim-xmp&for XMP (metadata) inclusion\cr}

The documentation for the above packages will be replicated in separate 
chapters below.

You can use this package by simply saying ⟦\input minim⟧; this will load the 
file \red{minim.tex}.
For building your own format files, you can re-use the file \red{minim.ini}:
if you define ⟦\fmtname⟧ before inputting this file, no ⟦\dump⟧ will be 
performed.


\bigskip

\tocfalse \section Contents \par \bigskip
\begingroup \parskip1pt
\protected\def\chapter#1#2#3{%
    \stopelement{TOC}\smallskip
    \nextpartag{}\red{\tenbf\marktocentry{#2}{}{\strut#1}{\hfill~}{#3}}%
    \smallskip\startelement{TOC}}
\protected\def\section#1#2#3{%
    \marktocentry{#2}{}{\strut\quad#1}{\dotfill~}{#3}\par}
\startelement{TOC} \startelement{TOC}
\the\toc
\stopelement{TOC} \stopelement{TOC}
\endgroup

\section Compatibility

One central design goal of minim is to be as unobtrusive as possible: you 
should be able to safely ignore any function you do not want to use.
Please get in touch if you find this not the case.

Particular care has been taken to be compatible with \red{ltluatex}. All 
overlapping functions should produce the same results and ltluatex can be 
loaded either before or after minim.
Earlier incompatibilities with \red{pgf} have been resolved.

\licencesection

\input minim-mp.doc
\input minim-math.doc
\input minim-pdf.doc
\input minim-xmp.doc
\input minim-alloc.doc

\bye