summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorManuel Pégourié-Gonnard <mpg@elzevir.fr>2010-11-10 22:43:57 +0100
committerManuel Pégourié-Gonnard <mpg@elzevir.fr>2010-11-11 15:53:12 +0100
commit2dc94fe1386b7bd1ede75570c7ae8f32e0ed8861 (patch)
tree9d7211f7a07f769f94ad5020cd64363bc12fc416
parent708b9f4b9ddfc0a1bb2d0e2df616059a4092700d (diff)
downloadluatexbase-2dc94fe1386b7bd1ede75570c7ae8f32e0ed8861.tar.gz
Update readme, changes and overview doc.
-rw-r--r--Changes6
-rw-r--r--README10
-rw-r--r--luatexbase.dtx19
3 files changed, 16 insertions, 19 deletions
diff --git a/Changes b/Changes
index 2534078..24ca861 100644
--- a/Changes
+++ b/Changes
@@ -4,7 +4,7 @@ The [BI] tag signals backward-incompatible changes.
Starting with v0.3, the only possible source of such changes is the upcoming
merge with luatex.sty. Afterwards, no other BI change is to be expected.
-(current changes) v0.3
+2010/10/10 v0.3
all not using LuaTeX results in an error (formerly a warning)
modutils
- [BI] \luatexUseModule and \luatexRequireModule replaced by
@@ -18,8 +18,8 @@ merge with luatex.sty. Afterwards, no other BI change is to be expected.
- improved formatting of messages.
- luatexbase.require_module now returns curstom err/war/inf functions.
mcb
- - [BI] rationalise "list" type handling. The new calling convention
- differs from the old one only in edge cases.
+ - [BI] rationalise "list"-type callbacks handling. The new calling
+ convention differs from the old one only in edge cases.
- add user documentation
- misc code tuning (more locals, etc)
diff --git a/README b/README
index 1b7a4a7..4424910 100644
--- a/README
+++ b/README
@@ -1,8 +1,9 @@
- The luatexbase generic bundle
+ The luatexbase generic package for LuaTeX
-The bundle provides basic facilities for LuaTeX macro programmers, mostly
-resource allocation and convenience packages. Provided are:
+This package provides resource management for the LuaTeX macro programmer.
+It is composed of the following sub-packages, which can be used independantly
+if desired:
– luatexbase-compat: compatibility helpers;
– luatexbase-loader: Lua module loading;
@@ -12,9 +13,6 @@ resource allocation and convenience packages. Provided are:
– luatexbase-modutils: Lua module declaration; and
- luatexbase-mcb: callbacks extensions.
-Additionally, a `luatexbase' package loads all of the above in one step (and
-does nothing else) for your convenience.
-
Installation
------------
diff --git a/luatexbase.dtx b/luatexbase.dtx
index 1d609aa..405e720 100644
--- a/luatexbase.dtx
+++ b/luatexbase.dtx
@@ -101,15 +101,15 @@ See source file '\inFileName' for details.
% \maketitle
%
% \begin{abstract}
-% This convenience package loads all of the packages in the \pk{luatexbase}
-% bundle.
+% This package provides resource management for the LuaTeX macro programmer.
+% It is divided in sub-packages which can be used independantly if desired.
% \end{abstract}
%
% \tableofcontents
%
% \section{Documentation}
%
-% The \pk{luatexbase} package loads the following packages:
+% The \pk{luatexbase} package consists of the following sub-packages:
% \begin{description}
% \subpk{compat} compatibility helpers for \verb+\directlua+, primitive
% names and version information from Lua.
@@ -125,15 +125,14 @@ See source file '\inFileName' for details.
% \subpk{modutils} Lua module declaration, including version checks.
% \end{description}
%
-% These packages are almost stable: it is unlikely that backward-incompatible
+% The package is mostly stable: it is unlikely that backward-incompatible
% changes will be made in the future, other than necessary for merging with
-% \pk{luatex.sty}, which strongly overlaps with the first five. If they happen,
-% such changes will be announced on \email{lualatex-dev@tug.org} before they
-% are pushed to the master branch and then CTAN.
+% \pk{luatex.sty}, with which a few sub-packages strongly overlap. If they do
+% happen, such changes will be announced on the development list, and clearly
+% identified in the \file{Changes} file.
%
-% All packages in this bundle are tested with \luatex 0.25.4 to 0.60.x, with
-% formats based on \plaintex or \latex, as included in \texlive 2008, 2009,
-% and 2010.
+% All sub-packages are tested with \luatex 0.25.4 to 0.60.x and formats based
+% on \plaintex or \latex, as included in \texlive 2008, 2009, and 2010.
%
% \section{Implementation}
%