summaryrefslogtreecommitdiff
path: root/lualibs-extended.lua
diff options
context:
space:
mode:
authorPhilipp Gesang <phg42.2a@gmail.com>2013-05-04 22:24:55 +0200
committerPhilipp Gesang <phg42.2a@gmail.com>2013-05-04 22:24:55 +0200
commit92c04b971e3ee97f945b462cc1ae6a26b18196d6 (patch)
treec70b99c33f8478f4ab2ec4ffd42273eef849c9b5 /lualibs-extended.lua
parent67744bc1c59803c2645927f15cb30fbbb7365a99 (diff)
downloadlualibs-92c04b971e3ee97f945b462cc1ae6a26b18196d6.tar.gz
add some documentation to ``lualibs-basic.lua`` and ``lualibs-merged.lua``
Diffstat (limited to 'lualibs-extended.lua')
-rw-r--r--lualibs-extended.lua45
1 files changed, 33 insertions, 12 deletions
diff --git a/lualibs-extended.lua b/lualibs-extended.lua
index 293df39..db790bd 100644
--- a/lualibs-extended.lua
+++ b/lualibs-extended.lua
@@ -1,5 +1,20 @@
lualibs = lualibs or { }
+--[[doc--
+
+ Loading the \emph{extended} set requires a tad more effort, but
+ it’s well invested.
+
+ Since we only want the functionality, we have to simulate parts
+ of a running \CONTEXT environment, above all logging, that some
+ of the more involved libraries cannot be loaded without.
+ Also, one utility file cannot be packaged because it returns a
+ table which would preclude loading of later code.
+ Thus, we remove it from the natural loading chain (it is not
+ critical) and append it at the end.
+
+--doc]]--
+
local lualibs_extended_module = {
name = "lualibs-extended",
version = 2.00,
@@ -10,7 +25,6 @@ local lualibs_extended_module = {
license = "See ConTeXt's mreadme.pdf for the license",
}
-local error, warn, info = lualibs.error, lualibs.warn, lualibs.info
local stringformat = string.format
local loadmodule = lualibs.loadmodule
@@ -18,9 +32,12 @@ local texiowrite = texio.write
local texiowrite_nl = texio.write_nl
--[[doc--
-Here we define some functions that fake the elaborate logging/tracking
-mechanism Context provides.
+
+ Here we define some functions that fake the elaborate
+ logging/tracking mechanism Context provides.
+
--doc]]--
+
local error, logger, mklog
if luatexbase and luatexbase.provides_module then
--- TODO test how those work out when running tex
@@ -42,16 +59,20 @@ else
logger = mklog"INFO"
end
+local info = lualibs.info
+
--[[doc--
-We temporarily put our own global table in place and restore whatever
-we overloaded afterwards.
-
-\CONTEXT\ modules each have a custom logging mechanism that can be
-enabled for debugging.
-In order to fake the presence of this facility we need to define at
-least the function \verb|logs.reporter|.
-For now it’s sufficient to make it a reference to \verb|mklog| as
-defined above.
+
+ We temporarily put our own global table in place and restore
+ whatever we overloaded afterwards.
+
+ \CONTEXT\ modules each have a custom logging mechanism that can be
+ enabled for debugging.
+ In order to fake the presence of this facility we need to define at
+ least the function \verb|logs.reporter|.
+ For now it’s sufficient to make it a reference to \verb|mklog| as
+ defined above.
+
--doc]]--
local dummy_function = function ( ) end