summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorContext Git Mirror Bot <phg42.2a@gmail.com>2015-12-17 16:15:07 +0100
committerContext Git Mirror Bot <phg42.2a@gmail.com>2015-12-17 16:15:07 +0100
commitd1faffcd5d92925a6c5e66ebb72b4c8dcfae236f (patch)
treec1663d54da8573c0541015e5a307a28e22215a8b /doc
parentadc43c3c243ed95215af6fe02d71e393c178da23 (diff)
downloadcontext-d1faffcd5d92925a6c5e66ebb72b4c8dcfae236f.tar.gz
2015-12-17 15:59:00
Diffstat (limited to 'doc')
-rw-r--r--doc/context/documents/general/manuals/luatex.pdfbin996235 -> 990446 bytes
-rw-r--r--doc/context/scripts/mkiv/mtx-fonts.html8
-rw-r--r--doc/context/scripts/mkiv/mtx-fonts.man2
-rw-r--r--doc/context/scripts/mkiv/mtx-fonts.xml8
-rw-r--r--doc/context/scripts/mkiv/mtx-unicode.html48
-rw-r--r--doc/context/scripts/mkiv/mtx-unicode.man27
-rw-r--r--doc/context/scripts/mkiv/mtx-unicode.xml15
-rw-r--r--doc/context/sources/general/manuals/luatex/luatex-enhancements.tex31
-rw-r--r--doc/context/sources/general/manuals/luatex/luatex-introduction.tex25
-rw-r--r--doc/context/sources/general/manuals/luatex/luatex-languages.tex26
-rw-r--r--doc/context/sources/general/manuals/luatex/luatex-libraries.tex405
-rw-r--r--doc/context/sources/general/manuals/luatex/luatex-math.tex5
-rw-r--r--doc/context/sources/general/manuals/luatex/luatex-modifications.tex26
-rw-r--r--doc/context/sources/general/manuals/luatex/luatex-nodes.tex32
-rw-r--r--doc/context/sources/general/manuals/luatex/luatex.tex9
15 files changed, 419 insertions, 248 deletions
diff --git a/doc/context/documents/general/manuals/luatex.pdf b/doc/context/documents/general/manuals/luatex.pdf
index 426f3ed1d..5ddde1596 100644
--- a/doc/context/documents/general/manuals/luatex.pdf
+++ b/doc/context/documents/general/manuals/luatex.pdf
Binary files differ
diff --git a/doc/context/scripts/mkiv/mtx-fonts.html b/doc/context/scripts/mkiv/mtx-fonts.html
index 8afba10b3..ea2915e87 100644
--- a/doc/context/scripts/mkiv/mtx-fonts.html
+++ b/doc/context/scripts/mkiv/mtx-fonts.html
@@ -56,7 +56,7 @@
<tr><th>--info</th><td></td><td>give more details</td></tr>
<tr><th>--trackers</th><td>list</td><td>enable trackers</td></tr>
<tr><th>--statistics</th><td></td><td>some info about the database</td></tr>
- <tr><th>--names</th><td></td><td>uise name instead of unicodes</td></tr>
+ <tr><th>--names</th><td></td><td>use name instead of unicodes</td></tr>
</table>
<br/>
<h1>Examples</h1>
@@ -73,9 +73,9 @@
<br/><tt>mtxrun --script font --list --file somename</tt>
<br/><tt>mtxrun --script font --list --file --all somename</tt>
<br/><tt>mtxrun --script font --list --file --pattern=*somename*</tt>
-<br/><br/><tt>mtxrun --script font --save --texgyrepagella-regular.otf</tt>
-<br/><tt>mtxrun --script font --convert --texgyrepagella-regular.otf</tt>
-<br/><tt>mtxrun --script font --convert --names --texgyrepagella-regular.otf</tt>
+<br/><br/><tt>mtxrun --script font --save texgyrepagella-regular.otf</tt>
+<br/><tt>mtxrun --script font --convert texgyrepagella-regular.otf</tt>
+<br/><tt>mtxrun --script font --convert --names texgyrepagella-regular.otf</tt>
<br/><br/> </div>
</div>
</body>
diff --git a/doc/context/scripts/mkiv/mtx-fonts.man b/doc/context/scripts/mkiv/mtx-fonts.man
index 26b591c60..21cb63411 100644
--- a/doc/context/scripts/mkiv/mtx-fonts.man
+++ b/doc/context/scripts/mkiv/mtx-fonts.man
@@ -54,7 +54,7 @@ enable trackers
some info about the database
.TP
.B --names
-uise name instead of unicodes
+use name instead of unicodes
.SH AUTHOR
More information about ConTeXt and the tools that come with it can be found at:
diff --git a/doc/context/scripts/mkiv/mtx-fonts.xml b/doc/context/scripts/mkiv/mtx-fonts.xml
index 696f03c55..43f5f47ea 100644
--- a/doc/context/scripts/mkiv/mtx-fonts.xml
+++ b/doc/context/scripts/mkiv/mtx-fonts.xml
@@ -28,7 +28,7 @@
<flag name="info"><short>give more details</short></flag>
<flag name="trackers" value="list"><short>enable trackers</short></flag>
<flag name="statistics"><short>some info about the database</short></flag>
- <flag name="names"><short>uise name instead of unicodes</short></flag>
+ <flag name="names"><short>use name instead of unicodes</short></flag>
</subcategory>
</category>
</flags>
@@ -57,9 +57,9 @@
<example><command>mtxrun --script font --list --file --pattern=*somename*</command></example>
</subcategory>
<subcategory>
- <example><command>mtxrun --script font --save --texgyrepagella-regular.otf</command></example>
- <example><command>mtxrun --script font --convert --texgyrepagella-regular.otf</command></example>
- <example><command>mtxrun --script font --convert --names --texgyrepagella-regular.otf</command></example>
+ <example><command>mtxrun --script font --save texgyrepagella-regular.otf</command></example>
+ <example><command>mtxrun --script font --convert texgyrepagella-regular.otf</command></example>
+ <example><command>mtxrun --script font --convert --names texgyrepagella-regular.otf</command></example>
</subcategory>
</category>
</examples>
diff --git a/doc/context/scripts/mkiv/mtx-unicode.html b/doc/context/scripts/mkiv/mtx-unicode.html
new file mode 100644
index 000000000..c042b28c0
--- /dev/null
+++ b/doc/context/scripts/mkiv/mtx-unicode.html
@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+
+<!-- compare with lmx framework variant -->
+
+<!--
+ filename : context-base.xml
+ comment : companion to mtx-server-ctx-startup.tex
+ author : Hans Hagen, PRAGMA-ADE, Hasselt NL
+ copyright: PRAGMA ADE / ConTeXt Development Team
+ license : see context related readme files
+-->
+
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+ <head>
+ <title>Checker for char-def.lua 1.02</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+ <style type="text/css">
+ body { color: #FFFFFF; background-color: #808080; font-family: optima, verdana, futura, "lucida sans", arial, geneva, helvetica, sans; font-size: 12px; line-height: 18px; } a:link, a:active, a:visited { color: #FFFFFF; } a.dir-view:link, a.dir-view:active, a.dir-view:visited { color: #FFFFFF; text-decoration: underline; } .valid { color: #00FF00; } .invalid { color: #FF0000; } button, .commonlink, .smallbutton { font-weight: bold; font-size: 12px; text-decoration: none; color: #000000; border-color: #7F7F7F; border-style: solid; border-width: .125ex; background-color: #FFFFFF; padding: .5ex; } .smallbutton { width: 1em; } a.commonlink:link, a.commonlink:active, a.commonlink:visited, a.smalllink:link, a.smalllink:active, a.smalllink:visited { font-weight: bold; font-size: 12px; text-decoration: none; color: #000000; } h1, .title { font-style: normal; font-weight: normal; font-size: 18px; line-height: 18px; margin-bottom: 20px; } h2, .subtitle { font-style: normal; font-weight: normal; font-size: 12px; margin-top: 18px; margin-bottom: 18px; } table { line-height: 18px; font-size: 12px; margin: 0; } th { font-weight: bold; text-align: left; padding-bottom: 6px; } .tc { font-weight: bold; text-align: left; } p, li { max-width: 60em; } .empty-line { margin-top: 4px; } .more-room { margin-right: 1.5em; } .much-more-room { margin-right: 3em; } #main { position: absolute; left: 10%; top: 10%; right: 10%; bottom: 10%; z-index: 2; width: 80%; height: 80%; padding: 0%; margin: 0%; overflow: auto; border-style: none; border-width: 0; background-color: #3F3F3F; } #main-settings { margin: 12px; x_max-width: 60em; line-height: 18px; font-size: 12px; } #left { position: absolute; top : 10%; left: 0%; bottom: 0%; right: 90%; z-index: 1; width: 10%; height: 90%; padding: 0%; margin: 0%; font-size: 16px; border-style: none; border-width: 0; background-color: #4F6F6F; } #right { position: absolute; top : 0%; left: 90%; bottom: 10%; right: 0%; z-index: 1; width: 10%; height: 90%; padding: 0%; margin: 0%; font-size: 16px; border-style: none; border-width: 0; background-color: #4F6F6F; _margin-left: -15px; } #bottom { position: absolute; left: 10%; right: 0%; top: 90%; bottom: 0%; z-index: 1; width: 90%; height: 10%; padding: 0%; margin: 0%; font-size: 16px; border-style: none; border-width: 0; background-color: #6F6F8F; } #top { position: absolute; left: 0%; right: 10%; top: 0%; bottom: 90%; z-index: 1; width: 90%; height: 10%; padding: 0%; margin: 0%; font-size: 16px; border-style: none; border-width: 0; background-color: #6F6F8F; } #top-one { position: absolute; bottom: 50%; width: 100%; buggedheight: 100%; } #top-two { position: relative; margin-bottom: -9px; margin-left: 12px; margin-right: 12px; line-height: 18px; text-align: right; vertical-align: middle; } #bottom-one { position: absolute; bottom: 50%; width: 100%; buggedheight: 100%; } #bottom-two { position: relative; margin-bottom: -9px; margin-left: 12px; margin-right: 12px; line-height: 18px; text-align: left; vertical-align: middle; } #left-one { position: absolute; width: 100%; buggedheight: 100%; } #left-two { position: relative; margin-top: 12px; line-height: 18px; text-align: center; vertical-align: top; } #right-one { display: table; height: 100%; width: 100%; } #right-two { display: table-row; height: 100%; width: 100%; } #right-three { display: table-cell; width: 100%; vertical-align: bottom; _position: absolute; _top: 100%; } #right-four { text-align: center; margin-bottom: 2ex; _position: relative; _top: -100%; } #more-top { position: absolute; top: 0%; left: 90%; bottom: 90%; right: 0%; z-index: 3; width: 10%; height: 10%; padding: 0%; margin: 0%; border-style: none; border-width: 0; } #more-top-settings { text-align: center; } #more-right-settings { margin-right: 12px; margin-left: 12px; line-height: 18px; font-size: 10px; text-align: center; } #right-safari { _display: table; width: 100%; height: 100%; }
+ </style>
+ <style type="text/css">
+ </style>
+ </head>
+ <body>
+ <div id="top"> <div id="top-one">
+ <div id="top-two">Checker for char-def.lua 1.02 </div>
+ </div>
+ </div>
+ <div id="bottom"> <div id="bottom-one">
+ <div id="bottom-two">wiki: http://contextgarden.net | mail: ntg-context@ntg.nl | website: http://www.pragma-ade.nl</div>
+ </div>
+ </div>
+ <div id="left"></div>
+ <div id="right"></div>
+ <div id="main">
+ <div id='main-settings'>
+ <h1>Command line options</h1>
+<table>
+ <tr><th style="width: 10em">flag</th><th style="width: 8em">value</th><th>description</th></tr>
+ <tr><th/><td/><td/></tr>
+ <tr><th>--whatever</th><td></td><td>do whatever</td></tr>
+ </table>
+<br/>
+ </div>
+ </div>
+ </body>
+ </html>
diff --git a/doc/context/scripts/mkiv/mtx-unicode.man b/doc/context/scripts/mkiv/mtx-unicode.man
new file mode 100644
index 000000000..367738025
--- /dev/null
+++ b/doc/context/scripts/mkiv/mtx-unicode.man
@@ -0,0 +1,27 @@
+.TH "mtx-unicode" "1" "01-01-2015" "version 1.02" "Checker for char-dat.lua"
+.SH NAME
+.B mtx-unicode
+.SH SYNOPSIS
+.B mtxrun --script unicode [
+.I OPTIONS ...
+.B ] [
+.I FILENAMES
+.B ]
+.SH DESCRIPTION
+.B Checker for char-dat.lua
+.SH OPTIONS
+.TP
+.B --whatever
+do whatever
+.SH AUTHOR
+More information about ConTeXt and the tools that come with it can be found at:
+
+
+.B "maillist:"
+ntg-context@ntg.nl / http://www.ntg.nl/mailman/listinfo/ntg-context
+
+.B "webpage:"
+http://www.pragma-ade.nl / http://tex.aanhet.net
+
+.B "wiki:"
+http://contextgarden.net
diff --git a/doc/context/scripts/mkiv/mtx-unicode.xml b/doc/context/scripts/mkiv/mtx-unicode.xml
new file mode 100644
index 000000000..2ab23f582
--- /dev/null
+++ b/doc/context/scripts/mkiv/mtx-unicode.xml
@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<application>
+ <metadata>
+ <entry name="name">mtx-unicode</entry>
+ <entry name="detail">Checker for char-dat.lua</entry>
+ <entry name="version">1.02</entry>
+ </metadata>
+ <flags>
+ <category name="basic">
+ <subcategory>
+ <flag name="whatever"><short>do whatever</short></flag>
+ </subcategory>
+ </category>
+ </flags>
+</application>
diff --git a/doc/context/sources/general/manuals/luatex/luatex-enhancements.tex b/doc/context/sources/general/manuals/luatex/luatex-enhancements.tex
index 6dfaecaba..19d99b74f 100644
--- a/doc/context/sources/general/manuals/luatex/luatex-enhancements.tex
+++ b/doc/context/sources/general/manuals/luatex/luatex-enhancements.tex
@@ -768,6 +768,37 @@ You can now open upto 127 files with \type {\openout}. When no file is open
writes will go to the console and log. As a consequence a system command is
no longer possible but one can use \type {os.execute} to do the same.
+\section{\type{\nospaces}}
+
+This new primitive can be used to overrule the usual \type {\spaceskip}
+related heuristics when a space character is seen in a text flow. The
+value~\type{1} triggers no injection while \type{2} results in injection of
+a zero skip. Below we see the results for four characters separated by a
+space.
+
+\startlinecorrection
+\startcombination[3*2]
+ {\ruledhbox to 5cm{\vtop{\hsize 10mm\nospaces=0\relax x x x x \par}\hss}} {\type {0 / hsize 10mm}}
+ {\ruledhbox to 5cm{\vtop{\hsize 10mm\nospaces=1\relax x x x x \par}\hss}} {\type {1 / hsize 10mm}}
+ {\ruledhbox to 5cm{\vtop{\hsize 10mm\nospaces=2\relax x x x x \par}\hss}} {\type {2 / hsize 10mm}}
+ {\ruledhbox to 5cm{\vtop{\hsize 1mm\nospaces=0\relax x x x x \par}\hss}} {\type {0 / hsize 1mm}}
+ {\ruledhbox to 5cm{\vtop{\hsize 1mm\nospaces=1\relax x x x x \par}\hss}} {\type {1 / hsize 1mm}}
+ {\ruledhbox to 5cm{\vtop{\hsize 1mm\nospaces=2\relax x x x x \par}\hss}} {\type {2 / hsize 1mm}}
+\stopcombination
+\stoplinecorrection
+
+\section{\type{\letcharcode}}
+
+This primitive is still experimental but can be used to assign a meaning to an active
+character, as in:
+
+\starttyping
+\def\foo{bar} \letcharcode123\foo
+\stoptyping
+
+This can be a bit nicer that using the uppercase tricks (using the property of
+\type {\uppercase} that it treats active characters special).
+
\stopchapter
\stopcomponent
diff --git a/doc/context/sources/general/manuals/luatex/luatex-introduction.tex b/doc/context/sources/general/manuals/luatex/luatex-introduction.tex
index 23b921129..5fcc96546 100644
--- a/doc/context/sources/general/manuals/luatex/luatex-introduction.tex
+++ b/doc/context/sources/general/manuals/luatex/luatex-introduction.tex
@@ -7,7 +7,11 @@
This book will eventually become the reference manual of \LUATEX. At the moment,
it simply reports the behavior of the executable matching the snapshot or beta
-release date in the title page.
+release date in the title page. We don't claim it is complete and we assume that
+the reader knows about \TEX\ as described in \quotation {The \TEX\ Book}, the
+\quotation {\ETEX\ manual}, the \quotation {\PDFTEX\ manual}, etc. Additional
+reference material is published in journals of user groups and \CONTEXT\ related
+documentation.
Features may come and go. The current version of \LUATEX\ can be used for
production (in fact it is used in production by the authors) but users cannot
@@ -18,11 +22,21 @@ list. We're still not at version 1 but when we reach that state the interface
will be stable. Of course we then can decide to move towards version 2 with
different properties.
+This means that occasionally you can encounter functionality not described here.
+Just consider that experimental then. They are either a playground or are being
+tested in real situations first before being finalized. And we can equally well
+kick them out again. When they stay we will descibe them in the manual or more
+extensively in articles.
+
Don't expect \LUATEX\ to behave the same as \PDFTEX ! Although the core
functionality of that 8 bit engine is present, \LUATEX\ can behave different due
-to not only its 32 bit character: there is native \UTF\ input, support for wide
-fonts, and the math machinery is tuned for \OPENTYPE\ math. Also, the log output
-can differ (and will likely differ more as we move forward).
+to its wide (32 bit) characters, many registers and large memory support. There
+is native \UTF\ input, support for large (more that 8 bit) fonts, and the math
+machinery is tuned for \OPENTYPE\ math. Ther ei ssupport for directional
+typesetting too. The log output can differ from other engines and will likely
+differ more as we move forward. When you run plain \TEX\ for sure \LUATEX\ runs
+slower than \PDFTEX\ but when you run for instance \CONTEXT\ it might be faster. But
+in any case: 32 bit all||over combined with more features has a price.
\LUATEX\ consists of a number of interrelated but (still) distinguishable parts.
The organization of the source code is adapted so that it cna glue all these
@@ -67,7 +81,8 @@ code in \TEX\ engines (especially code that is not needed any longer).
Neither \ALEPH's I/O translation processes, nor tcx files, nor \ENCTEX\ can be
used, these encoding|-|related functions are superseded by a \LUA|-|based
-solution (reader callbacks).
+solution (reader callbacks). Most of the \PDFTEX\ backend is available but via a
+bit different interface.
The yearly \TEXLIVE\ version is the stable version, any version between them is
considered beta. Keep in mind that new (or changed) features also need to be
diff --git a/doc/context/sources/general/manuals/luatex/luatex-languages.tex b/doc/context/sources/general/manuals/luatex/luatex-languages.tex
index 83c251473..773cbdf81 100644
--- a/doc/context/sources/general/manuals/luatex/luatex-languages.tex
+++ b/doc/context/sources/general/manuals/luatex/luatex-languages.tex
@@ -127,6 +127,32 @@ process the box using the current paragraph language unless there was a
\type {\setlanguage} issued inside the box. In \LUATEX, all language variables are
already frozen.
+In traditional \TEX\ the process of hyphenation is driven by so called lccodes.
+In \LUATEX\ we made this dependency less strong. There are several strategies
+possible. When you do nothing, the currently used lccodes are used, when loading
+patterns, setting exceptions or hyphenating a list.
+
+When you set \type {\savinghyphcodes} to a value larger than zero the current set of
+lccodes will be saved with the language. In that case changing a lccode afterwards
+has no effect. However, you can adapt the set with:
+
+\starttyping
+\hjcode`a=`a
+\stoptyping
+
+This change is global which makes sense if you keep in mind that the moment that
+hyphenation happens is (normally) when the paragraph or a horizontal box is
+constructed. When \type {\savinghyphcodes} was zero when the language got
+initialized you start out with nothing, otherwise you already have a set.
+
+Carrying all this information with each glyph would give too much overhead and
+also make the definition more complex. A solution with hj codesets was considered
+but rejected because in practice the current approach is sufficient and it would
+not be compatible anyway.
+
+Beware: the values are always saved in the format, independent of the setting
+of \type {\savinghyphcodes} at the mnoment the format is dumped.
+
\section{The main control loop}
In \LUATEX's main loop, almost all input characters that are to be typeset are
diff --git a/doc/context/sources/general/manuals/luatex/luatex-libraries.tex b/doc/context/sources/general/manuals/luatex/luatex-libraries.tex
index 339f25eaf..d7f4bf63d 100644
--- a/doc/context/sources/general/manuals/luatex/luatex-libraries.tex
+++ b/doc/context/sources/general/manuals/luatex/luatex-libraries.tex
@@ -392,36 +392,36 @@ inside this function or infinite recursion may occur. If you return \type {nil},
This callback does not replace any internal code.
-\subsubsection{\type {token_filter}}
-
-This callback allows you to replace the way \LUATEX\ fetches lexical tokens.
-
-\startfunctioncall
-function()
- return <table> token
-end
-\stopfunctioncall
-
-The calling convention for this callback is a bit more complicated than for most
-other callbacks. The function should either return a \LUA\ table representing a
-valid to|-|be|-|processed token or tokenlist, or something else like \type {nil}
-or an empty table.
-
-If your \LUA\ function does not return a table representing a valid token, it
-will be immediately called again, until it eventually does return a useful token
-or tokenlist (or until you reset the callback value to nil). See the description
-of \type {token} for some handy functions to be used in conjunction with this
-callback.
-
-If your function returns a single usable token, then that token will be processed
-by \LUATEX\ immediately. If the function returns a token list (a table consisting
-of a list of consecutive token tables), then that list will be pushed to the
-input stack at a completely new token list level, with its token type set to
-\quote {inserted}. In either case, the returned token(s) will not be fed back
-into the callback function.
-
-Setting this callback to \type {false} has no effect (because otherwise nothing
-would happen, forever).
+% \subsubsection{\type {token_filter}}
+%
+% This callback allows you to replace the way \LUATEX\ fetches lexical tokens.
+%
+% \startfunctioncall
+% function()
+% return <table> token
+% end
+% \stopfunctioncall
+%
+% The calling convention for this callback is a bit more complicated than for most
+% other callbacks. The function should either return a \LUA\ table representing a
+% valid to|-|be|-|processed token or tokenlist, or something else like \type {nil}
+% or an empty table.
+%
+% If your \LUA\ function does not return a table representing a valid token, it
+% will be immediately called again, until it eventually does return a useful token
+% or tokenlist (or until you reset the callback value to nil). See the description
+% of \type {token} for some handy functions to be used in conjunction with this
+% callback.
+%
+% If your function returns a single usable token, then that token will be processed
+% by \LUATEX\ immediately. If the function returns a token list (a table consisting
+% of a list of consecutive token tables), then that list will be pushed to the
+% input stack at a completely new token list level, with its token type set to
+% \quote {inserted}. In either case, the returned token(s) will not be fed back
+% into the callback function.
+%
+% Setting this callback to \type {false} has no effect (because otherwise nothing
+% would happen, forever).
\subsection{Node list processing callbacks}
@@ -606,25 +606,6 @@ end
This callback does not replace any internal code.
-\subsubsection{\type {hpack_quality} and \type {vpack_quality}}
-
-These two callbacks can be used to intercept the overfull messages. They get a few
-arguments:
-
-\startfunctioncall
-function(<string> incident, <number> detail, <node> head, <number> first,
- <number> last)
- return <node> whatever
-end
-\stopfunctioncall
-
-The incident is one of \type {overfull}, \type {underfull}, \type {loose} or
-\type {tight}. The detail is either the amount of overflow (in case of \type
-{overerful}, or the badness. The head is the list that is constructed (when
-protrusion or expansion is enabled, this is an intermediate list). For a hpack
-you can return a node (for instance an overfull rule indicator). That node will
-be appended to the list (just like \TEX's own rule would).
-
\subsubsection{\type {hpack_quality}}
This callback can be used to intercept the overfull messages that can result from
@@ -661,6 +642,13 @@ The incident is one of \type {overfull}, \type {underfull}, \type {loose} or
\type {tight}. The detail is either the amount of overflow in case of \type
{overfull}, or the badness otherwise. The head is the list that is constructed.
+\subsubsection{\type {process_rule}}
+
+This is an experimental callback. It can be used with rules of subtype~4
+(user). The callback gets three arguments: the node, the width and the
+height. The callback can use \type {pdf.print} to write code to the \PDF\
+file but beware of not messing up the final result. No checking is done.
+
\subsubsection{\type {pre_output_filter}}
This callback is called when \TEX\ is ready to start boxing the box 255 for \type
@@ -3189,9 +3177,10 @@ ones. The syntax of the string is explained in~\in {section}
lang.clear_hyphenation(<language> l)
\stopfunctioncall
-Clears the exception dictionary for this language.
+Clears the exception dictionary (string) for this language.
\startfunctioncall
+<string> n = lang.clean(<language> l, <string> o)
<string> n = lang.clean(<string> o)
\stopfunctioncall
@@ -3261,6 +3250,16 @@ nodes with the node subtype having the value \type {1}. Glyph modes with
different subtypes are not processed. See \in {section~} [charsandglyphs] for
more details.
+The following two commands can be used to set or query hj codes:
+
+\startfunctioncall
+lang.sethjcode(<language> l, <number> char, <number> usedchar)
+<number> usedchar = lang.gethjcode(<language> l, <number> char)
+\stopfunctioncall
+
+When you set a hjcode the current sets get initialized unless the set was already
+initialized due to \type {\savinghyphcodes} being larger than zero.
+
\section{The \type {lua} library}
This library contains one read|-|only item:
@@ -4378,12 +4377,27 @@ The preferred interface is now \type {pdf.setxformattributes} and \type
These two functions set the level of compression. The minimum valu sis~0,
the maximum is~9.
+\subsection{\type {pdf.setdecimaldigits} and \type {pdf.getdecimaldigits}}
+
+These two functions set the accuracy of floats written to the \PDF file.
+
\subsection{\type {pdf.lastobj}, \type {pdf.lastlink}, \type {pdf.lastannot},
and \type {pdf.retval}}
These status variables are similar to the ones traditionally used at the \TEX\
end.
+\subsection{\type {pdf.setorigin}}
+
+This one is used to set the horizonal and/or vertical offset (a traditional
+backend property).
+
+\starttyping
+pdf.setorigin() -- sets both to 0pt
+pdf.setorigin(tex.sp("1in")) -- sets both to 1in
+pdf.setorigin(tex.sp("1in"),tex.sp("1in"))
+\stoptyping
+
\subsection{\type {pdf.h}, \type {pdf.v}}
These are the \type {h} and \type {v} values that define the current location on
@@ -4810,10 +4824,11 @@ The current list is:
\NC callbacks \NC total number of executed callbacks so far \NC \NR
\NC indirect_callbacks \NC number of those that were themselves
a result of other callbacks (e.g. file readers) \NC \NR
-\NC luatex_svn \NC the luatex repository id \NC \NR
\NC luatex_version \NC the luatex version number \NC \NR
\NC luatex_revision \NC the luatex revision string \NC \NR
\NC ini_version \NC \type {true} if this is an \INITEX\ run \NC \NR
+\NC shell_escape \NC \type {0} means disabled, \type {1} is restricted and
+ \type {2} means anything is permitted \NC \NR
\stoptabulate
The error and warning messages can be wiped with the \type {resetmessages}
@@ -4920,24 +4935,6 @@ tex.month
tex.newlinechar
tex.outputpenalty
tex.pausing
-tex.pdfadjustspacing
-tex.pdfcompresslevel
-tex.pdfdecimaldigits
-tex.pdfgamma
-tex.pdfgentounicode
-tex.pdfimageapplygamma
-tex.pdfimagegamma
-tex.pdfimagehicolor
-tex.pdfimageresolution
-tex.pdfinclusionerrorlevel
-tex.pdfminorversion
-tex.pdfobjcompresslevel
-tex.pdfoutput
-tex.pdfpagebox
-tex.pdfpkresolution
-tex.pdfprotrudechars
-tex.pdftracingfonts
-tex.pdfuniqueresname
tex.postdisplaypenalty
tex.predisplaydirection
tex.predisplaypenalty
@@ -4971,6 +4968,25 @@ tex.year
\stoptyping
\stoptwocolumns
+% tex.pdfadjustspacing
+% tex.pdfcompresslevel
+% tex.pdfdecimaldigits
+% tex.pdfgamma
+% tex.pdfgentounicode
+% tex.pdfimageapplygamma
+% tex.pdfimagegamma
+% tex.pdfimagehicolor
+% tex.pdfimageresolution
+% tex.pdfinclusionerrorlevel
+% tex.pdfminorversion
+% tex.pdfobjcompresslevel
+% tex.pdfoutput
+% tex.pdfpagebox
+% tex.pdfpkresolution
+% tex.pdfprotrudechars
+% tex.pdftracingfonts
+% tex.pdfuniqueresname
+
Read|-|only:
\startthreecolumns
@@ -6135,131 +6151,136 @@ This function behaves like \type {texio.write}, but make sure that the given
strings will appear at the beginning of a new line. You can pass a single empty
string if you only want to move to the next line.
-\section[luatokens]{The \type {oldtoken} library (obsolete)}
-
-{\em Nota Bene: This library will disappear soon. It is replaced by the \type
-{token} library, that used to be called \type {newroken}.}
-
-The \type {token} table contains interface functions to \TEX's handling of
-tokens. These functions are most useful when combined with the \type
-{token_filter} callback, but they could be used standalone as well.
-
-A token is represented in \LUA\ as a small table. For the moment, this table
-consists of three numeric entries:
-
-\starttabulate[|l|l|p|]
-\NC \bf index \NC \bf meaning \NC \bf description \NC \NR
-\NC 1 \NC command code \NC this is a value between~$0$ and~$130$ (approximately)\NC \NR
-\NC 2 \NC command modifier \NC this is a value between~$0$ and~$2^{21}$ \NC \NR
-\NC 3 \NC control sequence id \NC for commands that are not the result of control
- sequences, like letters and characters, it is zero,
- otherwise, it is a number pointing into the \quote
- {equivalence table} \NC \NR
-\stoptabulate
-
-\subsection{\type {oldtoken.get_next}}
+\subsubsection{\type {texio.setescape}}
-\startfunctioncall
-token t = oldtoken.get_next()
-\stopfunctioncall
-
-This fetches the next input token from the current input source, without
-expansion.
-
-\subsection{\type {oldtoken.is_expandable}}
-
-\startfunctioncall
-<boolean> b = oldtoken.is_expandable(<token> t)
-\stopfunctioncall
-
-This tests if the token \type {t} could be expanded.
-
-\subsection{\type {oldtoken.expand}}
-
-\startfunctioncall
-oldtoken.expand(<token> t)
-\stopfunctioncall
-
-If a token is expandable, this will expand one level of it, so that the first
-token of the expansion will now be the next token to be read by \type
-{oldtoken.get_next()}.
-
-\subsection{\type {oldtoken.is_activechar}}
-
-\startfunctioncall
-<boolean> b = oldtoken.is_activechar(<token> t)
-\stopfunctioncall
-
-This is a special test that is sometimes handy. Discovering whether some control
-sequence is the result of an active character turned out to be very hard
-otherwise.
-
-\subsection{\type {oldtoken.create}}
-
-\startfunctioncall
-token t = oldtoken.create(<string> csname)
-token t = oldtoken.create(<number> charcode)
-token t = oldtoken.create(<number> charcode, <number> catcode)
-\stopfunctioncall
-
-This is the token factory. If you feed it a string, then it is the name of a
-control sequence (without leading backslash), and it will be looked up in the
-equivalence table.
-
-If you feed it number, then this is assumed to be an input character, and an
-optional second number gives its category code. This means it is possible to
-overrule a character's category code, with a few exceptions: the category codes~0
-(escape), 9~(ignored), 13~(active), 14~(comment), and 15 (invalid) cannot occur
-inside a token. The values~0, 9, 14 and~15 are therefore illegal as input to
-\type {oldtoken.create()}, and active characters will be resolved immediately.
-
-Note: unknown string sequences and never defined active characters will result in
-a token representing an \quote {undefined control sequence} with a near|-|random
-name. It is {\em not} possible to define brand new control sequences using
-\type {oldtoken.create}!
-
-\subsection{\type {oldtoken.command_name}}
-
-\startfunctioncall
-<string> commandname = oldtoken.command_name(<token> t)
-\stopfunctioncall
-
-This returns the name associated with the \quote {command} value of the token in
-\LUATEX. There is not always a direct connection between these names and
-primitives. For instance, all \type {\ifxxx} tests are grouped under \type
-{if_test}, and the \quote {command modifier} defines which test is to be run.
-
-\subsection{\type {oldtoken.command_id}}
-
-\startfunctioncall
-<number> i = oldtoken.command_id(<string> commandname)
-\stopfunctioncall
-
-This returns a number that is the inverse operation of the previous command, to
-be used as the first item in a token table.
-
-\subsection{\type {oldtoken.csname_name}}
-
-\startfunctioncall
-<string> csname = oldtoken.csname_name(<token> t)
-\stopfunctioncall
-
-This returns the name associated with the \quote {equivalence table} value of the
-token in \LUATEX. It returns the string value of the command used to create the
-current token, or an empty string if there is no associated control sequence.
-
-Keep in mind that there are potentially two control sequences that return the
-same csname string: single character control sequences and active characters have
-the same \quote {name}.
-
-\subsection{\type {oldtoken.csname_id}}
-
-\startfunctioncall
-<number> i = oldtoken.csname_id(<string> csname)
-\stopfunctioncall
+You can disable \type {^^} escaping of control characters by passing a value of
+zero.
-This returns a number that is the inverse operation of the previous command, to
-be used as the third item in a token table.
+% \section[luatokens]{The \type {oldtoken} library (obsolete)}
+%
+% {\em Nota Bene: This library will disappear soon. It is replaced by the \type
+% {token} library, that used to be called \type {newroken}.}
+%
+% The \type {token} table contains interface functions to \TEX's handling of
+% tokens. These functions are most useful when combined with the \type
+% {token_filter} callback, but they could be used standalone as well.
+%
+% A token is represented in \LUA\ as a small table. For the moment, this table
+% consists of three numeric entries:
+%
+% \starttabulate[|l|l|p|]
+% \NC \bf index \NC \bf meaning \NC \bf description \NC \NR
+% \NC 1 \NC command code \NC this is a value between~$0$ and~$130$ (approximately)\NC \NR
+% \NC 2 \NC command modifier \NC this is a value between~$0$ and~$2^{21}$ \NC \NR
+% \NC 3 \NC control sequence id \NC for commands that are not the result of control
+% sequences, like letters and characters, it is zero,
+% otherwise, it is a number pointing into the \quote
+% {equivalence table} \NC \NR
+% \stoptabulate
+%
+% \subsection{\type {oldtoken.get_next}}
+%
+% \startfunctioncall
+% token t = oldtoken.get_next()
+% \stopfunctioncall
+%
+% This fetches the next input token from the current input source, without
+% expansion.
+%
+% \subsection{\type {oldtoken.is_expandable}}
+%
+% \startfunctioncall
+% <boolean> b = oldtoken.is_expandable(<token> t)
+% \stopfunctioncall
+%
+% This tests if the token \type {t} could be expanded.
+%
+% \subsection{\type {oldtoken.expand}}
+%
+% \startfunctioncall
+% oldtoken.expand(<token> t)
+% \stopfunctioncall
+%
+% If a token is expandable, this will expand one level of it, so that the first
+% token of the expansion will now be the next token to be read by \type
+% {oldtoken.get_next()}.
+%
+% \subsection{\type {oldtoken.is_activechar}}
+%
+% \startfunctioncall
+% <boolean> b = oldtoken.is_activechar(<token> t)
+% \stopfunctioncall
+%
+% This is a special test that is sometimes handy. Discovering whether some control
+% sequence is the result of an active character turned out to be very hard
+% otherwise.
+%
+% \subsection{\type {oldtoken.create}}
+%
+% \startfunctioncall
+% token t = oldtoken.create(<string> csname)
+% token t = oldtoken.create(<number> charcode)
+% token t = oldtoken.create(<number> charcode, <number> catcode)
+% \stopfunctioncall
+%
+% This is the token factory. If you feed it a string, then it is the name of a
+% control sequence (without leading backslash), and it will be looked up in the
+% equivalence table.
+%
+% If you feed it number, then this is assumed to be an input character, and an
+% optional second number gives its category code. This means it is possible to
+% overrule a character's category code, with a few exceptions: the category codes~0
+% (escape), 9~(ignored), 13~(active), 14~(comment), and 15 (invalid) cannot occur
+% inside a token. The values~0, 9, 14 and~15 are therefore illegal as input to
+% \type {oldtoken.create()}, and active characters will be resolved immediately.
+%
+% Note: unknown string sequences and never defined active characters will result in
+% a token representing an \quote {undefined control sequence} with a near|-|random
+% name. It is {\em not} possible to define brand new control sequences using
+% \type {oldtoken.create}!
+%
+% \subsection{\type {oldtoken.command_name}}
+%
+% \startfunctioncall
+% <string> commandname = oldtoken.command_name(<token> t)
+% \stopfunctioncall
+%
+% This returns the name associated with the \quote {command} value of the token in
+% \LUATEX. There is not always a direct connection between these names and
+% primitives. For instance, all \type {\ifxxx} tests are grouped under \type
+% {if_test}, and the \quote {command modifier} defines which test is to be run.
+%
+% \subsection{\type {oldtoken.command_id}}
+%
+% \startfunctioncall
+% <number> i = oldtoken.command_id(<string> commandname)
+% \stopfunctioncall
+%
+% This returns a number that is the inverse operation of the previous command, to
+% be used as the first item in a token table.
+%
+% \subsection{\type {oldtoken.csname_name}}
+%
+% \startfunctioncall
+% <string> csname = oldtoken.csname_name(<token> t)
+% \stopfunctioncall
+%
+% This returns the name associated with the \quote {equivalence table} value of the
+% token in \LUATEX. It returns the string value of the command used to create the
+% current token, or an empty string if there is no associated control sequence.
+%
+% Keep in mind that there are potentially two control sequences that return the
+% same csname string: single character control sequences and active characters have
+% the same \quote {name}.
+%
+% \subsection{\type {oldtoken.csname_id}}
+%
+% \startfunctioncall
+% <number> i = oldtoken.csname_id(<string> csname)
+% \stopfunctioncall
+%
+% This returns a number that is the inverse operation of the previous command, to
+% be used as the third item in a token table.
\subsection{The \type {token} libray}
diff --git a/doc/context/sources/general/manuals/luatex/luatex-math.tex b/doc/context/sources/general/manuals/luatex/luatex-math.tex
index 6c83b7786..0fcf0e52f 100644
--- a/doc/context/sources/general/manuals/luatex/luatex-math.tex
+++ b/doc/context/sources/general/manuals/luatex/luatex-math.tex
@@ -958,6 +958,11 @@ formula.
% if needed we can put the value in stylenodes but maybe more should go there
+\subsection {Tracing}
+
+Because there are quite some math related parameters and values, it is possible
+to limit tracing. Only when \type {tracingassigns} and|/|or \type
+{tracingrestores} are set to~2 or more they will be traced.
\subsection {Math options}
diff --git a/doc/context/sources/general/manuals/luatex/luatex-modifications.tex b/doc/context/sources/general/manuals/luatex/luatex-modifications.tex
index 5b35f3ec1..0fbd16dc7 100644
--- a/doc/context/sources/general/manuals/luatex/luatex-modifications.tex
+++ b/doc/context/sources/general/manuals/luatex/luatex-modifications.tex
@@ -96,11 +96,6 @@ functionality, but with a few small adaptions.
\stopitem
\startitem
- The \type {\savinghyphcodes} command is a no|-|op. \in {Chapter} [languages]
- explains why.
-\stopitem
-
-\startitem
When kpathsea is used to find files, \LUATEX\ uses the \type {ofm} file
format to search for font metrics. In turn, this means that \LUATEX\ looks at
the \type {OFMFONTS} configuration variable (like \OMEGA\ and \ALEPH) instead
@@ -250,16 +245,6 @@ which in turn triggered renaming primitives.
\stopitem
\startitem
- Candidates for removal are \type {\pdfcolorstackinit} and \type
- {\pdfcolorstack}.
-\stopitem
-
-\startitem
- Candidates for replacement are \type {\pdfoutput} (\type {\outputmode}) and
- \type {\pdfmatrix} (something with a normal syntax).
-\stopitem
-
-\startitem
The introspective primitives \type {\pdflastximagecolordepth} and \type
{\pdfximagebbox} have been removed. One can use external applications to
determine these properties or use the built|-|in \type {img} library.
@@ -370,8 +355,13 @@ we say next applies to both these programs.
\stopitem
\startitem
- The \type {^^} notation can come in five and six item repetitions also, to
- insert characters that do not fit in the BMP.
+ The \type {^^} notation has been extended: after \type {^^^^} four hexadecimal
+ characters are expected and after \type {^^^^^^} six hexadecimal characters
+ have to be given. The original \TEX\ interpretation is still valid for the
+ \type {^^} case but the four and six variants do no backtracking, i.e.\ when
+ they are not followed by the right number of hexadecimal digits they issue an
+ error message. Because \type{^^^} is a normal \TEX\ case, we don't support the
+ odd number of \type {^^^^^} either.
\stopitem
\startitem
@@ -553,7 +543,6 @@ The configuration related registers have become:
\edef\pdfpkresolution {\pdfvariable pkresolution}
\edef\pdfinclusioncopyfonts {\pdfvariable inclusioncopyfonts}
\edef\pdfinclusionerrorlevel {\pdfvariable inclusionerrorlevel}
-\edef\pdfreplacefont {\pdfvariable replacefont}
\edef\pdfgentounicode {\pdfvariable gentounicode}
\edef\pdfpagebox {\pdfvariable pagebox}
\edef\pdfminorversion {\pdfvariable minorversion}
@@ -607,7 +596,6 @@ the defaults; these are:
\pdfpkresolution 72
\pdfinclusioncopyfonts 0
\pdfinclusionerrorlevel 0
-\pdfreplacefont 0
\pdfgentounicode 0
\pdfpagebox 0
\pdfminorversion 4
diff --git a/doc/context/sources/general/manuals/luatex/luatex-nodes.tex b/doc/context/sources/general/manuals/luatex/luatex-nodes.tex
index d59efbf19..f9d240689 100644
--- a/doc/context/sources/general/manuals/luatex/luatex-nodes.tex
+++ b/doc/context/sources/general/manuals/luatex/luatex-nodes.tex
@@ -1105,32 +1105,18 @@ The \type {type} can have one of five distinct values:
\section{Two access models}
-After doing lots of tests with \LUATEX\ and \LUAJITTEX\, with and without just in
-time compilation enabled, and with and without using ffi, we came to the
-conclusion that userdata prevents a speedup. We also found that the checking of
-metatables as well as assignment comes with overhead that can't be neglected.
-This is normally not really a problem but when processing fonts for more complex
-scripts it could have quite some overhead.
-
-Because the userdata approach has some benefits, this remains the recommended way
-to access nodes. We did several experiments with faster access using this model,
-but eventually settled for the \quote {direct} approach. For code that is proven
-to be okay, one can use this access model that operates on nodes more directly.
-
-Deep down in \TEX\ a node has a number which is an entry in a memory table. In
-fact, this model, where \TEX\ manages memory is real fast and one of the reasons
-why plugging in callbacks that operate on nodes is quite fast. No matter what
-future memory model \LUATEX\ has, an internal reference will always be a simple
-data type (like a number or light userdata in \LUA\ speak). So, if you use the
-direct model, even if you know that you currently deal with numbers, you should
+Deep down in \TEX\ a node has a number which is an numeric entry in a memory
+table. In fact, this model, where \TEX\ manages memory is real fast and one of
+the reasons why plugging in callbacks that operate on nodes is quite fast. So, if
+you use the direct model, even if you know that you deal with numbers, you should
not depend on that property but treat it an abstraction just like traditional
nodes. In fact, the fact that we use a simple basic datatype has the penalty that
less checking can be done, but less checking is also the reason why it's somewhat
faster. An important aspect is that one cannot mix both methods, but you can cast
both models.
-So our advice is: use the indexed approach when possible and investigate the
-direct one when speed might be an issue. For that reason we also provide the
+So our advice is: use the indexed (table) approach when possible and investigate
+the direct one when speed might be an issue. For that reason we also provide the
\type {get*} and \type {set*} functions in the top level node namespace. There is
a limited set of getters. When implementing this direct approach the regular
index by key variant was also optimized, so direct access only makes sense when
@@ -1262,14 +1248,15 @@ summarized this:
\NC \type {is_char} \NC \yes \NC \yes \NC \NR
\NC \type {is_direct} \NC \nop \NC \yes \NC \NR
\NC \type {is_node} \NC \yes \NC \yes \NC \NR
-\NC \type {kerning} \NC \yes \NC \nop \NC \NR
+\NC \type {kerning} \NC \yes \NC \yes \NC \NR
\NC \type {last_node} \NC \yes \NC \yes \NC \NR
\NC \type {length} \NC \yes \NC \yes \NC \NR
-\NC \type {ligaturing} \NC \yes \NC \nop \NC \NR
+\NC \type {ligaturing} \NC \yes \NC \yes \NC \NR
\NC \type {mlist_to_hlist} \NC \yes \NC \nop \NC \NR
\NC \type {new} \NC \yes \NC \yes \NC \NR
\NC \type {next} \NC \yes \NC \nop \NC \NR
\NC \type {prev} \NC \yes \NC \nop \NC \NR
+\NC \type {protect_glyph} \NC \yes \NC \yes \NC \NR
\NC \type {protect_glyphs} \NC \yes \NC \yes \NC \NR
\NC \type {protrusion_skippable} \NC \yes \NC \yes \NC \NR
\NC \type {remove} \NC \yes \NC \yes \NC \NR
@@ -1290,6 +1277,7 @@ summarized this:
\NC \type {tonode} \NC \yes \NC \yes \NC \NR
\NC \type {tostring} \NC \yes \NC \yes \NC \NR
\NC \type {traverse_id} \NC \yes \NC \yes \NC \NR
+\NC \type {traverse_char} \NC \yes \NC \yes \NC \NR
\NC \type {traverse} \NC \yes \NC \yes \NC \NR
\NC \type {types} \NC \yes \NC \nop \NC \NR
\NC \type {type} \NC \yes \NC \nop \NC \NR
diff --git a/doc/context/sources/general/manuals/luatex/luatex.tex b/doc/context/sources/general/manuals/luatex/luatex.tex
index bcb543c54..a04592760 100644
--- a/doc/context/sources/general/manuals/luatex/luatex.tex
+++ b/doc/context/sources/general/manuals/luatex/luatex.tex
@@ -1,13 +1,20 @@
+% macros=mkvi
+
% \tex vs \type vs \syntax vs. \luatex
% \em \it \/
+% \enabledirectives[nodes.basepass*]
+
+% \unprotect
+% \protect
+
\environment luatex-style
\environment luatex-logos
\dontcomplain
\startdocument
- [beta=0.85.0]
+ [beta=0.87.0]
\component luatex-titlepage