summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHans Hagen <pragma@wxs.nl>2021-11-05 13:35:55 +0100
committerContext Git Mirror Bot <phg@phi-gamma.net>2021-11-05 13:35:55 +0100
commitce22f093d2d9af63927792e2a821e81a49a2ca10 (patch)
tree6957d03f5c5723a60e62716250c8e2d0e772c9d0 /doc
parentca2f0f64dbb46140d36db84ac6e1b6079a386cfa (diff)
downloadcontext-ce22f093d2d9af63927792e2a821e81a49a2ca10.tar.gz
2021-11-05 12:35:00
Diffstat (limited to 'doc')
-rw-r--r--doc/context/documents/general/manuals/lowlevel-localboxes.pdfbin61262 -> 61248 bytes
-rw-r--r--doc/context/sources/general/manuals/lowlevel/lowlevel-localboxes.tex26
2 files changed, 13 insertions, 13 deletions
diff --git a/doc/context/documents/general/manuals/lowlevel-localboxes.pdf b/doc/context/documents/general/manuals/lowlevel-localboxes.pdf
index 0a2e8017f..66de25c6a 100644
--- a/doc/context/documents/general/manuals/lowlevel-localboxes.pdf
+++ b/doc/context/documents/general/manuals/lowlevel-localboxes.pdf
Binary files differ
diff --git a/doc/context/sources/general/manuals/lowlevel/lowlevel-localboxes.tex b/doc/context/sources/general/manuals/lowlevel/lowlevel-localboxes.tex
index 891b361be..a0ca15975 100644
--- a/doc/context/sources/general/manuals/lowlevel/lowlevel-localboxes.tex
+++ b/doc/context/sources/general/manuals/lowlevel/lowlevel-localboxes.tex
@@ -35,7 +35,7 @@ code and it then pays of to use it when possible. Among the extensions are a
callback that is triggered when the left and right boxes get added and
experiments with that showed some potential but in order to retain performance as
well as limit extensive node memory usage (par nodes are large) a system of
-classes was added. All this will be illustrated below. Warning: the mechanism in
+indices was added. All this will be illustrated below. Warning: the mechanism in
\LUAMETATEX\ is not compatible with \LUATEX.
{\em This is a preliminary, uncorrected manual.}
@@ -57,11 +57,11 @@ This mechanism is rather useless when not wrapped into some high level mechanism
because by default setting these boxes wipes the existing value. In \LUAMETATEX\
you can actually access the boxes so prepending and appending is possible but
experiments showed that this could come with a huge performance hit when the
-lists are not cleaned up during a run. This is why we have introduced classes:
-when you assign local boxes using the class option that specific class will be
+lists are not cleaned up during a run. This is why we have introduced indices:
+when you assign local boxes using the index option that specific index will be
replaced and therefore we have a more sparse solution. So, contrary to \LUATEX,
in \LUAMETATEX\ the local box registers have a linked lists of local boxes tagged
-by class. Unless you manipulate in \LUA, this is hidden from the user. One can
+by index. Unless you manipulate in \LUA, this is hidden from the user. One can
access the boxes from the \TEX\ the but there can be no confusion with \LUATEX\
here because there we don't have access. This is why usage as in \LUATEX\ will
also work in \LUAMETATEX.
@@ -135,7 +135,7 @@ specific.
One (nasty) side effect is that when you set these boxes ungrouped they are
applied to whatever follows, which is why resetting them is built in the relevant
parts of \CONTEXT. The next examples are typeset grouped an demonstrate the use
-of classes:
+of indices:
\startbuffer
\dorecurse{20}{before #1 }
@@ -146,12 +146,12 @@ of classes:
\typebuffer[option=TEX] \start \getbuffer \par \stop
-Classes can be set for both sides:
+Indices can be set for both sides:
\startbuffer
-\dorecurse{5}{\localrightbox class #1{ \bf \darkgreen R #1}}%
+\dorecurse{5}{\localrightbox index #1{ \bf \darkgreen R #1}}%
\dorecurse{20}{before #1 }
-\dorecurse{5}{\localleftbox class #1{\bf \darkred L #1 }}%
+\dorecurse{5}{\localleftbox index #1{\bf \darkred L #1 }}%
\dorecurse{20}{after #1 }
\stopbuffer
@@ -163,9 +163,9 @@ local boxes only come into play when the lines are broken, so till
then changing them is possible.
\startbuffer
-\dorecurse{3}{\localrightbox class #1{ \bf \darkgreen R #1}}%
+\dorecurse{3}{\localrightbox index #1{ \bf \darkgreen R #1}}%
\dorecurse{20}{before #1 }
-\dorecurse{2}{\localleftbox par class #1{\bf \darkred L #1 }}%
+\dorecurse{2}{\localleftbox par index #1{\bf \darkred L #1 }}%
\dorecurse{20}{after #1 }
\stopbuffer
@@ -203,8 +203,8 @@ feature for efficiently placing marginal content.
\getbuffer[definition]
-The order of definition matters! Here the \type {x} variants have a larger class
-number. There can (currently) be at most 256 classes. The defined local boxes
+The order of definition matters! Here the \type {x} variants have a larger index
+number. There can (currently) be at most 256 indices. The defined local boxes
are triggered with \type {\localbox}:
\startbuffer[example]
@@ -371,7 +371,7 @@ here):
For the moment we have these helpers:
\starttabulate[|l|;|]
-\NC \type {\localboxclass} \NC integer \NC \NR
+\NC \type {\localboxindex} \NC integer \NC \NR
\NC \type {\localboxlinenumber} \NC integer \NC \NR
\NC
\NC \type {\localboxlinewidth} \NC dimension \NC \NR