Difference between revisions of "Modules"

From Wiki
Jump to navigation Jump to search
m (→‎ConTeXt standalone: forgot t-filter)
(→‎ConTeXt standalone: added module links)
Line 57: Line 57:
The complete list of availables modules in standalone is:
The complete list of availables modules in standalone is:
* t-urwgaramond
* [http://modules.contextgarden.net/account t-account] draw T-accounts
* t-account
* [http://modules.contextgarden.net/algorithmic t-algorithmic] like LaTeX algorithmic
* t-algorithmic
* [http://modules.contextgarden.net/animation t-animation] create animations
* t-animation
* [http://modules.contextgarden.net/annotation t-annotation] todo lists
* t-annotation
* [http://modules.contextgarden.net/t-bnf t-bnf] BNF grammar
* t-bnf
* [http://modules.contextgarden.net/chromato t-chromato] chromatograms
* t-chromato
* [http://modules.contextgarden.net/cmscbf t-cmscbf] bold small caps
* t-cmscbf
* [http://modules.contextgarden.net/cmttbf t-cmttbf] bold typewriter
* t-cmttbf
* [http://modules.contextgarden.net/t-construction-plan t-construction-plan] figures with defined scale
* t-construction-plan
* [http://modules.contextgarden.net/t-degrade t-degrade] degrading JPEG images
* t-degrade
* [http://modules.contextgarden.net/fancybreak t-fancybreak] thought breaks
* t-fancybreak
* [http://modules.contextgarden.net/filter t-filter] run external programs on inline code
* t-filter
* [http://modules.contextgarden.net/fixme t-fixme] like LaTeX fixme
* t-fixme
* [http://modules.contextgarden.net/t-french t-french]
* t-french
* [http://modules.contextgarden.net/fullpage t-fullpage]
* t-fullpage
* [http://modules.contextgarden.net/games t-games] board games
* t-games
* [http://modules.contextgarden.net/gantt t-gantt] Gantt charts
* t-gantt
* [http://modules.contextgarden.net/gnuplot t-gnuplot] include GNUplot graphics
* t-gnuplot
* [http://modules.contextgarden.net/t-layout t-layout]
* t-layout
* [http://modules.contextgarden.net/letter t-letter] formal letters
* t-letter
* [http://modules.contextgarden.net/t-lettrine t-lettrine] decorative paragraph starts (initials)
* t-lettrine
* [http://modules.contextgarden.net/t-lilypond t-lilypond] include musical scores with GNU LilyPond
* t-lilypond
* [http://modules.contextgarden.net/mathsets t-mathsets] mathematical sets, probabilities etc.
* t-mathsets
* t-pgfplots
* t-pgfplots
* t-ruby
* [http://modules.contextgarden.net/ruby t-ruby] Ruby markup (for Chinese, not programming language)
* t-simplefonts
* [http://modules.contextgarden.net/simplefonts t-simplefonts] simplified font mechanism
* t-simpleslides
* [http://modules.contextgarden.net/simpleslides t-simpleslides] presentations
* t-typearea
* [http://modules.contextgarden.net/typearea t-typearea] like LaTeX/KoMa typearea
* t-typescripts
* [http://modules.contextgarden.net/typescripts t-typescripts] collection of typescripts
* t-urwgaramond
* [http://modules.contextgarden.net/urwgaramond t-urwgaramond]
* t-urwgothic
* [http://modules.contextgarden.net/urwgothic t-urwgothic]
* t-vim
* [http://modules.contextgarden.net/vim t-vim] syntax highlighting using vim’s syntax files
(some of these are obsolete...)
===TeX Live===
===TeX Live===

Revision as of 21:56, 8 September 2011

< The ConTeXt Way

Modules are extensions to ConTeXt's core functions.

There are not as many modules for ConTeXt as packages for LaTeX, because a lot of LaTeX package features are in ConTeXt's core.



The installation of extra files in TeX (called modules in ConTeXt) can be difficult for people who are new to TeX or are not themselves interested in TeX programming.

According to the TDS (TeX directory structure) and the ConTeXt developers, user-written files reside under the path


In the private TeX directory ($TEXMF), directories can have the names

  • texmf-local
  • texmf-extra
  • texmf-project

but their existence depends on the TeX distribution; among these, texmf-local is the most common.

Installation by hand

When you want to install a new module which is available as file only create the subdirectories in the way described above and place the file there, for modules which are available as zip files with precreated subdorectories you can unzip the archive in the top-level directory (e.g. texmf-local/) and all files are on the correct place.

After the files are placed at the right place you have to update TeX's database to let it know where it can find the files, this is done for MkII with

 mktexlsr (command name depends on the TeX distribution)

and for MkIV with

 context --generate

ConTeXt standalone

Users of the ConTeXt standalone (formerly "minimals") distribution don't have to download the module files and unzip them in the local directory, because they can use the first-setup script for this.

To install for example the simpleslides modules you write

 first-setup.sh --modules="t-simpleslides"

To install more modules at the same time write

 first-setup.sh --modules="t-simpleslides,t-french"

The complete list of availables modules in standalone is:

(some of these are obsolete...)

TeX Live

NOTE: description required

The following modules are available:

  • context-account
  • context-bnf
  • context-chromato
  • context-construction-plan
  • context-degrade
  • context-french
  • context-games
  • context-gnuplot
  • context-letter
  • context-lettrine
  • context-lilypond
  • context-mathsets
  • context-simpleslides
  • context-taspresent
  • context-typearea
  • context-vim


When you load a module with \usemodule[modulename] ConTeXt looks for a file with the following names:

  • m-modulaname (core module)
  • p-modulename (private module)
  • s-modulename (ConTeXt style file)
  • x-modulename (XML module)
  • t-modulename (Third party module)
  • modulename

Once a file is found ConTeXt stops the search and loads the found file (only once).

When you have two file with the same name but different prefixes you can tell ConTeXt which file it should load with


Included modules:

Contributed modules:

For a list of contributed modules see tlcontrib and/or the modules section on contextgarden.net.

TODO: list more modules or none of them (See: To-Do List)

  • xdesc (extended description, e.g. for epigrams)
  • nath (natural math, see Math)
  • amsl (AMSmath, see Math)
  • Gnuplot: support for direct inclusion of Gnuplot graphs out of the source (the module has been removed from the main distribution and will be included into third party modules again when ready)
  • Gantt charts (drawing Gantt charts)

File names of included modules start with "m-", but third party (contributed) modules should start with "t-".

In order to install a contributed module, copy its directory into $TEXMF/tex/context/third then run luatools --generate.

Special Purpose Modules

The following modules implement special formatting requirement for journals or magazines. These modules are distributed with ConTeXt, so you need not download anything.

Modules writing guidelines

Module requirements

All modules should start with a block containing meta information about that module. There is a module template available to help setting up that header correctly.

Do not forget to specify a license as the permitted modes of distribution depend on which one you choose. The ConTeXt sources are licensed either under GPLv2 or the LPPL, so you might want to stick to these or a more permissive license. (Choose one: [1].) Including the full text of your license in your source repo is best practice.

In order to avoid conflicting macros it is essential for a module that it adhere to the namespace convention. After releasing a module its namespace[s] should be registered in the list for other module authors to know.

XML Interface file

Each module should have an associated XML specification file (as in /tex/context/interface/cont-en.xml). Its purpose is a comprehensive listing of the optional and non-optional arguments that a macro defined in the module accepts. From the interface a good deal of documentation can be auto-generated, as are for instance the ConTeXt Quick Reference and the initial input of the Command Reference, which itself started as a wikification of the now obsolete TeXShow.

When documenting your module, you can use

\usemodule[int-load] %Allow xml parsing 
\loadsetups[m-name-of-your-module.xml] % to load the file with definitions

An example:


By default, this places a frame around the setup. If you want to get gray background, as in the context documentation, add the following


Apart from the existing XML files in the ConTeXt tree there is little documentation online, so feel free to relay your questions to the mailing list.

Self-documenting source code

Source files are supposed to contain explanatory comments that document implementation details and other peculiarities the reader should be aware of. In .tex files (and other files containing primarily TeX code, e.g. .mki[iv]) any line beginning with the comment leader %D will be treated as such a docstring. Formatting is done via ordinary TeX commands. In Lua files (e.g. .cld) multi-line comments start with --[[ldx-- and end with --ldx]]--. Text inside those delimiters can be formatted using basic HTML tags. Ordinary comments are still treated as part of the source and therefore they will be typeset inside the listing.

Docstrings, though they appear to the [Lua]TeX interpreter as ordinary comments, allow for pretty printing source code when used with two dedicated modules:

Thus, in order to generate the documentation for the simplefonts module you first have to chdir to the files subdirectory of your checkout. Next you run the pretty printer on its main file

context --ctx=s-mod t-simplefonts.tex

to get a t-simplefonts.pdf which contains the – sparse – annotations in serif and the actual code as colorful listing. Likewise the processing of Lua code, e.g. font-def.lua from the main ConTeXt tree:

context --ctx=x-ldx font-def.lua

Which should generate a font-def.pdf in your current directory.

(The autogenerated documentation of all ConTeXt sources has been made available by Luigi at [2]. Go there for examples of the output.)

Legacy modules disclaimer

Prior to release 2005.05.25, ConTeXt silently truncated all file names in \usemodule commands to 8 characters long and lowercased them to "prevent cross platform problems with filenames". Thus, module files that are to be used with older versions of ConTeXt must have filenames that fit those restrictions, or they will (somewhat cryptically) not be found.