summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorManuel Pégourié-Gonnard <mpg@elzevir.fr>2010-03-28 17:51:58 +0200
committerManuel Pégourié-Gonnard <mpg@elzevir.fr>2010-03-28 17:51:58 +0200
commitac711f548b737f64e710fc392691a3cdfb802879 (patch)
tree0f8afd6464a6b4fa632eefeabf154a54d20a6e68
parentb15ce057e0f76715604c6760cd9475bcaaf34ca5 (diff)
downloadluatexbase-ac711f548b737f64e710fc392691a3cdfb802879.tar.gz
Adjust documentation toc (attr, cctb, regs).
-rw-r--r--lltxb-dtxstyle.tex5
-rw-r--r--luatexbase-attr.dtx8
-rw-r--r--luatexbase-cctb.dtx10
-rw-r--r--luatexbase-regs.dtx12
4 files changed, 26 insertions, 9 deletions
diff --git a/lltxb-dtxstyle.tex b/lltxb-dtxstyle.tex
index f3bafb4..50eb0da 100644
--- a/lltxb-dtxstyle.tex
+++ b/lltxb-dtxstyle.tex
@@ -32,5 +32,10 @@
\newcommand\pk{\textsf}
\newcommand\cmdname{\texttt}
+% for hyperref
+\pdfstringdefDisableCommands{%
+ \def\cs#1{\@backslashchar #1}%
+ }
+
% easy verbatim
\MakeShortVerb\|
diff --git a/luatexbase-attr.dtx b/luatexbase-attr.dtx
index 1580168..f095f05 100644
--- a/luatexbase-attr.dtx
+++ b/luatexbase-attr.dtx
@@ -127,6 +127,8 @@ See source file '\inFileName' for details.
% just like Plain TeX and LaTeX do for other registers.
% \end{abstract}
%
+% \tableofcontents
+%
% \section{Documentation}
%
% The main macro defined here is |\newluatexattribute|. It behaves in the same
@@ -248,9 +250,7 @@ See source file '\inFileName' for details.
\fi
% \end{macrocode}
%
-% \subsubsection{Main content}
-%
-% Load the supporting Lua module.
+% \subsubsection{Load supporting Lua module}
%
% \begin{macrocode}
\begingroup\expandafter\expandafter\expandafter\endgroup
@@ -262,6 +262,8 @@ See source file '\inFileName' for details.
\directlua{require('luatexbase.attr.lua')}
% \end{macrocode}
%
+% \subsection{User macros}
+%
% The allocaton macro.
%
% \begin{macrocode}
diff --git a/luatexbase-cctb.dtx b/luatexbase-cctb.dtx
index 3565fd0..2122eb7 100644
--- a/luatexbase-cctb.dtx
+++ b/luatexbase-cctb.dtx
@@ -127,6 +127,8 @@ See source file '\inFileName' for details.
% allocation just like Plain TeX and LaTeX do for other registers.
% \end{abstract}
%
+% \tableofcontents
+%
% \section{Documentation}
%
% The main macro defined here is |\newluatexcatcodetable|. It behaves the same
@@ -271,9 +273,7 @@ See source file '\inFileName' for details.
\fi
% \end{macrocode}
%
-% \subsubsection{Main content}
-%
-% Load the supporting Lua module.
+% \subsubsection{Load supporting Lua module}
%
% \begin{macrocode}
\begingroup\expandafter\expandafter\expandafter\endgroup
@@ -285,6 +285,8 @@ See source file '\inFileName' for details.
\directlua{require('luatexbase.cctb.lua')}
% \end{macrocode}
%
+% \subsubsection{User macros}
+%
% The allocation macro. Allocate tables starting with 1, since table 0 is
% reserved for IniTeX catcodes by LuaTeX.
%
@@ -346,6 +348,8 @@ See source file '\inFileName' for details.
\endgroup}
% \end{macrocode}
%
+% \subsubsection{Predefined tables}
+%
% The |IniTeX| catcode table needs no extra initialisation.
%
% \begin{macrocode}
diff --git a/luatexbase-regs.dtx b/luatexbase-regs.dtx
index 89c2313..3f043b1 100644
--- a/luatexbase-regs.dtx
+++ b/luatexbase-regs.dtx
@@ -117,6 +117,8 @@ See source file '\inFileName' for details.
% \luatex.
% \end{abstract}
%
+% \tableofcontents
+%
% \section{Documentation}
%
% Since the \plaintex and \latex formats are both frozen, they fail to take
@@ -147,8 +149,6 @@ See source file '\inFileName' for details.
% degraded performance due to implementation details, but with \luatex the
% performance is uniform, so we just do it.
%
-% \clearpage
-%
% \section{Implementation}
%
% \begin{macrocode}
@@ -238,7 +238,7 @@ See source file '\inFileName' for details.
\fi
% \end{macrocode}
%
-% \subsection{Main content}
+% \subsection{Ensure etex.sty is loaded}
%
% If running \latex, load \file{etex.sty}. If not, either
% \file{etex.src} was loaded at format generation time, or we cannot do
@@ -272,6 +272,8 @@ See source file '\inFileName' for details.
\else
% \end{macrocode}
%
+% \subsection{Adapt range}
+%
% First, increase the upper bound for all kinds of registers. Copy code to
% avoid defining a macro.
%
@@ -286,6 +288,8 @@ See source file '\inFileName' for details.
\ifnum\count276=32768 \count276=65536 \fi
% \end{macrocode}
%
+% \subsection{Patch macros that used \cs{mathchardef}}
+%
% |\box| registers and |\mark|s were previously defined
% using |\mathchardef| since it had the biggest range under \etex
% (15-bit number). However, this is not enough for \luatex's extended
@@ -394,6 +398,8 @@ See source file '\inFileName' for details.
\the\toks0
% \end{macrocode}
%
+% \subsection{Make room for inserts}
+%
% Finally, make allocation of |\count|, |\dimen|, |skip| and
% |\box| start with numbers $>255$, in order to free the lower numbers
% for insertions. Be careful with |\new...| macros which are