summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/luatex/luatextra/README
blob: 416e28d930cd9be2100aa9f921b0b999f6ab083c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
                          The luatextra generic bundle


LuaTeXtra is a collection of three coherent packages:

luatextra provides low-level functions for LuaTeX use with LaTeX and Plain, for
instance the macro \newluaattribute. It also provides a way to use and register
new lua modules, inspired by the LaTeX packages system.

luamcallback provides a way to register several functions in a LuaTeX callback.

luaextra provides extra lua functions useful for package development.

These packages are really necessary if you want to take advantage of the new
LuaTeX functions in a safe way.

Note that this package automatically loads luaotfload.

Please see the luatextra-reference.pdf documentation for more details.

This package is developped on <http://github.com/eroux/lualatex/tree/master>.


Installation
------------

Here are the recommended installation methods (preferred first).

1. If you are using TeX Live 2008 or later, use 'tlmgr install luatextra'.
Alternatively, try your (TeX or Linux) distribution's package management system.

2. a. Grab luatextra.tds.zip on the CTAN.
   b. Unzip it at the root of one or your TDS trees.
   c. You may need to update some filename database after this, see your TeX
distribution's manual for details.

3. a. Grab the sources from CTAN or github.
   b. Run 'make install TEXMF=/path/to/texmf'.
   c. See 2c.

4. Try to figure it out by looking at the Makefile and comments in the sources.


Manifest
--------

Source files:
        luaextra.dtx
        luamcallbacks.dtx
        luatextra.dtx
        luatextra-reference.tex

Derived files:
        luatextra-reference.pdf         introduction to luatextra packages
        luaextra.pdf
        luamcallbacks.pdf
        luatextra.pdf
        luamcallbacks-test.tex
        luaextra.lua
        luamcallbacks.lua
        luatextra-latex.tex
        luatextra.lua
        luatextra.sty

License
-------

This work and the derived files are under the Creative Commons CC0 license.

See the full text at

http://creativecommons.org/publicdomain/zero/1.0/legalcode

and a FAQ at

http://wiki.creativecommons.org/CC0