Difference between revisions of "CLD"

From ConTeXt wiki
m (moved cld to CLD: acronyms go in uppercase)
m (Basic reading: update source link)
 
Line 7: Line 7:
 
== Basic reading ==
 
== Basic reading ==
 
* [http://www.pragma-ade.com/general/manuals/cld-mkiv.pdf The CLD manual] by Hans Hagen.
 
* [http://www.pragma-ade.com/general/manuals/cld-mkiv.pdf The CLD manual] by Hans Hagen.
* [[source:mult-cld.lua| The source code.]]
+
* {{src|cldf-ini.lua}}: the entry point for the '''cldf-*''' files that contain the CLD implementation.
  
 
== An Example ==
 
== An Example ==

Latest revision as of 20:46, 20 June 2013

CLD (ConTeXt Lua Documents) are way to access TeX from inside Lua scripts; they provide means to typeset documents using little to no TeX code at all. This makes them especially helpful for automated content generation and scripting. Internally, the Lua commands are mapped onto their ConTeXt and TeX counterparts. Knowledge of the latter is, therefore, a prerequisite to writing CLDs. If you ever dreamed of proper typesetting without backslashes galore, here is where to start at.

Basic reading

An Example

Writing CLDs is straightforward although there are some pitfalls. Suppose we want to typeset the following minimal example:

\starttext
\placefigure {none} {%                                                                                                     
  \framed [frame=on, align=middle] {%
    \input knuth
  }%
}%
\stoptext

As CLD this will require more verbosity because nesting -- in the present example a framed inside a placefigure -- has to be expressed through functions. Optional and key-value style arguments are expressed as arrays and dictionaries respectively, which is a transparent representation of their ConTeXt ancestors. Mandatory (grouped) arguments are given either as strings or as functions.

Nesting 1: Functions

The following example shows two ways of rewriting the above TeX code: the first one closely resembles its structure while the second calls the function test from inside the placefigure macro.

context.placefigure(
    "none",
    function()
        context.framed( {
            frame="on",
            align="middle"
        },  
            function() context.input("knuth") end 
        )   
    end 
)

context.par()

function text ()
    context.framed( {
            frame="on",
            align="middle"
        },  
        function() context.input("knuth") end 
    )   
end

context.placefigure(
    "none",
    function () text() end                                                                                                 
)

Nesting 2: Delayed

An alternative to the function encapsulation is provided by the context.delayed.f() method. This way execution of the \input command is prevented until \placefigure is passed to TeX, the obvious advantage being that the source code follows the original TeX code and that it eliminates the need to create a separate function.

context.placefigure(
    "none",
    function()
        context.framed( {
            frame="on",
            align="middle"
        },  
            context.delayed.input("knuth")
        )
    end 
)