summaryrefslogtreecommitdiff
path: root/macros/luatex/generic/minim-math/minim-math.doc
diff options
context:
space:
mode:
Diffstat (limited to 'macros/luatex/generic/minim-math/minim-math.doc')
-rw-r--r--macros/luatex/generic/minim-math/minim-math.doc42
1 files changed, 31 insertions, 11 deletions
diff --git a/macros/luatex/generic/minim-math/minim-math.doc b/macros/luatex/generic/minim-math/minim-math.doc
index 3648458b57..c46d288cb5 100644
--- a/macros/luatex/generic/minim-math/minim-math.doc
+++ b/macros/luatex/generic/minim-math/minim-math.doc
@@ -8,8 +8,8 @@
\else \startmetadata
author {Esger Renkema}
title {minim-math}
- date {2024-01-05}
- version {2024/1.4}
+ date {2025-02-12}
+ version {2025/1.5}
keywords {LuaTeX; Plain TeX; Unicode mathematics}
stopmetadata
\maketitle \fi
@@ -26,6 +26,26 @@ It will not, however, select mathematical fonts for you. That you will have to
do for yourself; see below for instructions.
+\section Experimental LaTeX support
+
+As of version 1.5, an experimental latex package is available as a faster
+alternative to unicode-math.
+The unicode-math user interface is not replicated though: it adds nothing to
+the plain tex version but the ⟦\setfontfam⟧ macro for loading a math font.
+Use it like this:
+
+{\leftskip2em
+⟦\usepackage {minim-mp}
+% additional fonts can be loaded with \setfontfam
+\textfam = 1 % for the \text command; see below
+\setfontfam \textfam {Latin Modern Roman}
+% the next line is also the default
+\setfontfam 0 {Latin Modern Math} ⟧
+\par}
+
+Bugs are likely many at this point; reports are welcome.
+
+
\section Styles and alphabets
For some (mostly alphabetical) characters, multiple variants are available,
@@ -167,18 +187,17 @@ Do note that various spacing constants are set according to the \emph{last}
math family that is assigned to. Therefore, you should assign your main math
font to a family after all others.
-
-\section Shorthands and additions
-
You can use ⟦*\text⟧ for adding nonmathematical text to your equations.
It will behave well in sub- and superscripts:
⟦\text{word}^\text{word}⟧ gives $\smash{\text{word}^\text{word}}$.
By default, the font used is the normal mathematical font. You can change this
by setting the ⟦*\textfam⟧ parameter to some nonzero value and assigning
-a different font to that family (see above).
-You probably want to do this, since most commonly-used mathematical fonts do not
+a different font to that family.
+You probably want this, since most commonly-used mathematical fonts do not
include a normal kerning table.
+\section Shorthands and additions
+
All the usual arrows can be made extensible by prefacing them with an ⟦x⟧,
including ⟦\xmapsto⟧ and ⟦\xmapsfrom⟧. Alternatively, you can use ⟦\→⟧ etc. as
shorthands. Additionally, you can use the following:
@@ -214,9 +233,9 @@ brackets:
⟦$$\underbrace[=1]{(x^2+∥penalty0y^2)}$$⟧ gives
$$\underbrace[=1]{(x^2 + y^2)}.$$
-Finally, the following (entirely optional) alternative to using dollar signs is
-provided, which also offers slight improvements in the spacing of displayed
-equations:
+Finally, for plain tex only, the following (entirely optional) alternative to
+using dollar signs is provided, which also offers slight improvements in the
+spacing of displayed equations:
\stopformulatagging\Ustartdisplaymath
\halign{# \hfil&#\quad&#\hfil\cr
&⟦\[ ... \]⟧&inline mathematics\cr
@@ -227,7 +246,8 @@ equations:
The automatic display numbering uses the count ⟦\equationnumber⟧ and the token
list ⟦\setequationnumber⟧ internally. All displays created this way can be made
-left-aligned by saying ⟦\leftdisplaystrue⟧.
+left-aligned by saying ⟦\leftdisplaystrue⟧. In that case, the displays are
+offset from the margin by ⟦\leftdisplayindent⟧ (a muskip, default value~⟦0mu⟧).
\section Best practices