From 2ed4d98b8bd2764d725131e7b73daceb496b68dd Mon Sep 17 00:00:00 2001 From: Elie Roux Date: Mon, 6 May 2013 09:54:48 +0200 Subject: Updating doc --- Changes | 3 +++ TODO | 3 ++- luatexbase-modutils.dtx | 25 +++++++------------------ 3 files changed, 12 insertions(+), 19 deletions(-) diff --git a/Changes b/Changes index 8e7fc21..cb40459 100644 --- a/Changes +++ b/Changes @@ -1,6 +1,8 @@ Changes in the luatexbase package/bundle 2013/05/04 v0.6 + all + - move away from the module() function (deprecated in Lua 5.2) attr - hack to make luatexbase and luatex.sty compatible for attribute allocation (same thing should be done for catcodetables) @@ -8,6 +10,7 @@ modutils - adding functions to check the availability and version of a module - fixing small error in module date requirement + - update documentation to reflect the move from module() loader - do not output included file paths when called by texlua mcb diff --git a/TODO b/TODO index 65e80cc..1f36826 100644 --- a/TODO +++ b/TODO @@ -29,6 +29,7 @@ cctb ---- - support for unicode-letters? +- make the functions compatible with luatex.sty mcb --- @@ -38,7 +39,7 @@ mcb - provide a list()? - allow temporary disabling of callbacks - do something with open_read_file etc -- make callback.register = luatexbase_add_to_callback +- make callback.register = luatexbase_add_to_callback? - check if there are functions in the callbacks before luatexbase is loaded and import them diff --git a/luatexbase-modutils.dtx b/luatexbase-modutils.dtx index 1a50f24..d4dbef0 100644 --- a/luatexbase-modutils.dtx +++ b/luatexbase-modutils.dtx @@ -144,17 +144,10 @@ See the aforementioned source file(s) for copyright and licensing information. % % \medskip % -% It is important to notice that Lua's standard function |module()| is -% completely orthogonal with the present package. It has nothing to do with -% identification and deals only with namespaces: more precisely, it -% modifies the current environment. So, you should continue to -% use it normally regardless of whether you chose to use this package's -% features for identification. -% -% It is recommended to always use |module()| or any other method that ensure -% the global name space remains clean. For example, you may heavily use the -% |local| keyword and explicitly qualify the name of every non-local symbol. -% Chapter 15 of \href{http://www.lua.org/pil/}{Programming in Lua, 1st ed.} +% It is important to note that Lua's unction |module()| is deprecated in +% Lua 5.2 and should be avoided. For examples of good practices for creating +% modules, see section~\ref{template}. Chapter 15 +% of \href{http://www.lua.org/pil/15.html}{Programming in Lua, 3rd ed.} % discusses various methods for managing packages. % % \subsection{\tex macros} @@ -232,18 +225,14 @@ See the aforementioned source file(s) for copyright and licensing information. % \begin{qcode} % local module_info = luatexbase.get_module_info(\meta{name}) % local version = luatexbase.get_module_version(\meta{name}) +% local date = luatexbase.get_module_date(\meta{name}) +% local date_int = luatexbase.get_module_date_int(\meta{name}) % local is_loaded = luatexbase.is_module_loaded(\meta{name}) % \end{qcode} % These functions check for the availability or version of a module, and can % even return a copy of the |module_info| table. % -% \subsection{Templates} -% -% Let me emphasize again that, while |luatexbase.require_module()| is meant to -% be used as a replacement for |require()|, the function -% |luatexbase.provides_module()| \emph{is not} a replacement for |module()|: -% they just don't do the same thing (declaring information vs changing the -% current name space). +% \subsection{Templates}\label{template} % % Now, here is a module header template showing all the recommended elements: % \begin{verbatim} -- cgit v1.2.3 From 7f9bf62ef86bf036c1e9a60bc01e64ad4f9a080d Mon Sep 17 00:00:00 2001 From: Elie Roux Date: Mon, 6 May 2013 09:55:02 +0200 Subject: Changes -> NEWS --- Changes | 157 ---------------------------------------------------------------- NEWS | 157 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 157 insertions(+), 157 deletions(-) delete mode 100644 Changes create mode 100644 NEWS diff --git a/Changes b/Changes deleted file mode 100644 index cb40459..0000000 --- a/Changes +++ /dev/null @@ -1,157 +0,0 @@ - Changes in the luatexbase package/bundle - -2013/05/04 v0.6 - all - - move away from the module() function (deprecated in Lua 5.2) - attr - - hack to make luatexbase and luatex.sty compatible for attribute - allocation (same thing should be done for catcodetables) - - adding whatsit nodes allocation functions (see doc) - modutils - - adding functions to check the availability and version of a module - - fixing small error in module date requirement - - update documentation to reflect the move from module() - loader - - do not output included file paths when called by texlua - mcb - - passing most of the term output to the log - -2013/04/13 v0.5 - all - - input luatex.sty before doing anything, as luatex.sty - breaks if loaded after luatexbase - mcb and loader - - compatibility with Lua 5.2 (LuaTeX >= 0.74) - loader - - fix an important bug making the kpse lua loader never used, - it should make package searching a bit faster. - - dropping support for LuaTeX < 0.45. - - small improvement to make x.y.lua look for x/y.lua, not - x/y/lua. - modutils - - fixing a bug printing "luatexbase-attr" in all documents - in plain TeX - -2011/00/24 v0.4 - cctb - - implement catcode table stacks à la luatex.sty - - fix \CatcodeTableLaTeX(Package): 10 (newline aka ^^J) was catcoded - 15 instead of 12 - - rename \setcatcoderange to \SetCatcodeRange (the old name remains - for compatibility but will be removed in the next version) - luatex 0.5 - - new package replacing luatex.sty from the oberdiek bundle - (see luatex.pdf for details) - -2011/05/21 v0.31 - attr - - Bugfix: \unsetluatexattribute didn't work (reported by Dohyun Kim) - -2010/10/10 v0.3 - [BI] marks backward-incompatible changes - all not using LuaTeX results in an error (formerly a warning) - modutils - - [BI] \luatexUseModule and \luatexRequireModule replaced by - \RequireLuaModule with a unified syntax. - - [BI] luatexbase.use_module removed (use luatexbase.require_module with - a single argument instead). - - [BI] luatexbase.module_term removed. - - [BI] removed support for version check using a floating point - number, only date is supported now. - - module_{error,warning,info,log} now apply string.format - automatically - - date, version and description are now optional. - - improved formatting of messages. - - luatexbase.require_module now returns curstom err/war/inf functions. - mcb - - [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) - -2010/10/04 - - various documentation updates/fixes uploaded to CTAN - - luatexbase.sty used to be broken on CTAN (bad docstrip) - -2010/05/27 v0.2a - attr - - allocate from 1 to avoid problems with some external code - - provide a Lua interface: new_attribute() and unset_attribute(). - modutils - - fix bug with module require_module()-ed many times. - luatexbase - - new, loads: compat,loader,regs,attr,cctb. - -[BI] Summary of backwards-incompatible interface changes between 0.1 and 0.2: - - Lua objects are now in table luatexbase, not luatextra. - - Lua tables tex.attributenumber and tex.catcodetablenumber are not - created any more, use their couterparts in luatexbase. - - \luatexsetcatcoderange has been renamed to \setcatcoderange. - - luamcallbacks has been renamed; Lua objects are now in luatexbase, - no more in callback.* or luamcallbacks.* - - module error/warning etc now apply string.format to the arguments. - -2010/05/12 v0.2 - all - - use luatexbase as the Lua module name - - change the filename of the lua module (suppress luatexbase.) - - load luatexbase-compat - luatexbase-compat - - new - luatexbase-attr - - don't create tex.attributenumber - - load luatexbase-compat - luatexbase-cctb - - don't create tex.catcodetablenumber - - rename \luatexsetcatcoderange to \setcatcoderange - - load lua-compat - luamcallbacks -> luatexbase-mcb - - rename package, new version numbering starting at 0.2 - - functions are now in luatexbase rather than luamcallbacks, they - are no more copied to callbacks either - - lua objects are now local (except for the public interface) - - test file now for plain and latex - luatexbase-loader - - require"foo.bar" now looks for foo/bar then foo.bar, see doc for - details - - better cooperation with the original package loader - - works with luatex 0.25.4 - luatexbase-modutils - - module error/warning etc now apply string.format to the arguments. - - use error() instead of \errmessage. - -2010/03/28 - luatexbase-* - - add catcode defenses - -2010/03/27 - luatexbase-loader 0.1 - - add very minimal test files for luatex and lualatex - luatexbase-modutils 0.1 - - add minimal test files for luatex and lualatex - - use require() (with luatexbase-loader) for loading - luatexbase-attr, luatexbase-cctb, luamcallbacks (test file) - - use luatexbase-loader - -2010/03/26 - luatexbase-cctb 0.1 - - add minimal test files for luatex and lualatex - - fix allocation range (1->65535) - - make sure newly allocated tables are initialised - - fix sensitivity to the current value of \escapechar - - new macro \setluatexcatcodetable - -2010/03/11 - luatexbase-attrs 0.1 - - add minimal test files for luatex and lualatex - - make sure newly allocated attributes are unset - - fix sensitivity to the current value of \escapechar - -2010/01/21 - luatexbase-regs 0.1 - - add test files for luatex and lualatex - - extend registers with Plain-based format too - - fix \box and \marks allocation (\mathchardef -> \chardef) - - fix \*blk macros (\mathchardef -> \chardef) - -Version 0 of the bundle is part of the 2010/01/12 version of luatextra. diff --git a/NEWS b/NEWS new file mode 100644 index 0000000..cb40459 --- /dev/null +++ b/NEWS @@ -0,0 +1,157 @@ + Changes in the luatexbase package/bundle + +2013/05/04 v0.6 + all + - move away from the module() function (deprecated in Lua 5.2) + attr + - hack to make luatexbase and luatex.sty compatible for attribute + allocation (same thing should be done for catcodetables) + - adding whatsit nodes allocation functions (see doc) + modutils + - adding functions to check the availability and version of a module + - fixing small error in module date requirement + - update documentation to reflect the move from module() + loader + - do not output included file paths when called by texlua + mcb + - passing most of the term output to the log + +2013/04/13 v0.5 + all + - input luatex.sty before doing anything, as luatex.sty + breaks if loaded after luatexbase + mcb and loader + - compatibility with Lua 5.2 (LuaTeX >= 0.74) + loader + - fix an important bug making the kpse lua loader never used, + it should make package searching a bit faster. + - dropping support for LuaTeX < 0.45. + - small improvement to make x.y.lua look for x/y.lua, not + x/y/lua. + modutils + - fixing a bug printing "luatexbase-attr" in all documents + in plain TeX + +2011/00/24 v0.4 + cctb + - implement catcode table stacks à la luatex.sty + - fix \CatcodeTableLaTeX(Package): 10 (newline aka ^^J) was catcoded + 15 instead of 12 + - rename \setcatcoderange to \SetCatcodeRange (the old name remains + for compatibility but will be removed in the next version) + luatex 0.5 + - new package replacing luatex.sty from the oberdiek bundle + (see luatex.pdf for details) + +2011/05/21 v0.31 + attr + - Bugfix: \unsetluatexattribute didn't work (reported by Dohyun Kim) + +2010/10/10 v0.3 + [BI] marks backward-incompatible changes + all not using LuaTeX results in an error (formerly a warning) + modutils + - [BI] \luatexUseModule and \luatexRequireModule replaced by + \RequireLuaModule with a unified syntax. + - [BI] luatexbase.use_module removed (use luatexbase.require_module with + a single argument instead). + - [BI] luatexbase.module_term removed. + - [BI] removed support for version check using a floating point + number, only date is supported now. + - module_{error,warning,info,log} now apply string.format + automatically + - date, version and description are now optional. + - improved formatting of messages. + - luatexbase.require_module now returns curstom err/war/inf functions. + mcb + - [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) + +2010/10/04 + - various documentation updates/fixes uploaded to CTAN + - luatexbase.sty used to be broken on CTAN (bad docstrip) + +2010/05/27 v0.2a + attr + - allocate from 1 to avoid problems with some external code + - provide a Lua interface: new_attribute() and unset_attribute(). + modutils + - fix bug with module require_module()-ed many times. + luatexbase + - new, loads: compat,loader,regs,attr,cctb. + +[BI] Summary of backwards-incompatible interface changes between 0.1 and 0.2: + - Lua objects are now in table luatexbase, not luatextra. + - Lua tables tex.attributenumber and tex.catcodetablenumber are not + created any more, use their couterparts in luatexbase. + - \luatexsetcatcoderange has been renamed to \setcatcoderange. + - luamcallbacks has been renamed; Lua objects are now in luatexbase, + no more in callback.* or luamcallbacks.* + - module error/warning etc now apply string.format to the arguments. + +2010/05/12 v0.2 + all + - use luatexbase as the Lua module name + - change the filename of the lua module (suppress luatexbase.) + - load luatexbase-compat + luatexbase-compat + - new + luatexbase-attr + - don't create tex.attributenumber + - load luatexbase-compat + luatexbase-cctb + - don't create tex.catcodetablenumber + - rename \luatexsetcatcoderange to \setcatcoderange + - load lua-compat + luamcallbacks -> luatexbase-mcb + - rename package, new version numbering starting at 0.2 + - functions are now in luatexbase rather than luamcallbacks, they + are no more copied to callbacks either + - lua objects are now local (except for the public interface) + - test file now for plain and latex + luatexbase-loader + - require"foo.bar" now looks for foo/bar then foo.bar, see doc for + details + - better cooperation with the original package loader + - works with luatex 0.25.4 + luatexbase-modutils + - module error/warning etc now apply string.format to the arguments. + - use error() instead of \errmessage. + +2010/03/28 + luatexbase-* + - add catcode defenses + +2010/03/27 + luatexbase-loader 0.1 + - add very minimal test files for luatex and lualatex + luatexbase-modutils 0.1 + - add minimal test files for luatex and lualatex + - use require() (with luatexbase-loader) for loading + luatexbase-attr, luatexbase-cctb, luamcallbacks (test file) + - use luatexbase-loader + +2010/03/26 + luatexbase-cctb 0.1 + - add minimal test files for luatex and lualatex + - fix allocation range (1->65535) + - make sure newly allocated tables are initialised + - fix sensitivity to the current value of \escapechar + - new macro \setluatexcatcodetable + +2010/03/11 + luatexbase-attrs 0.1 + - add minimal test files for luatex and lualatex + - make sure newly allocated attributes are unset + - fix sensitivity to the current value of \escapechar + +2010/01/21 + luatexbase-regs 0.1 + - add test files for luatex and lualatex + - extend registers with Plain-based format too + - fix \box and \marks allocation (\mathchardef -> \chardef) + - fix \*blk macros (\mathchardef -> \chardef) + +Version 0 of the bundle is part of the 2010/01/12 version of luatextra. -- cgit v1.2.3