[ Home | Main Table Of Contents | Table Of Contents | Keyword Index ]

NAME

mustache_development - Mustache - The Developer's Guide

Table Of Contents
Description
Development Tools
Demonstration/Example Applications
Directory structure
Extended Build Actions
Architecture & Concepts
Related Documents
Bugs, Ideas, Feedback
Keywords
Copyright

DESCRIPTION

Welcome to the Mustache project for Tcl, written by Andreas Kupries.

It provides a set of five related Tcl packages for the parsing and rendering of mustache-style logic-less templates, plus an application for easy command-line access to the functionality.

For availability please read Mustache - How To Get The Sources.

The audience of this document are anyone wishing to modify Mustache in any way, shape, or form. This can be a maintainer fixing bugs, a developer adding functionality, or patching it to accommodate local circumstances, etc.

Please read

first, if that was not done already. Here we assume that the sources are already available in a directory of your choice, that it is known how to build and install the project, and that all the necessary requisites are available.

Development Tools

Mustache requires the following tools going beyond those needed for build and installation.

dia

Processor for diagram-based figures. See package tklib.
dtplite

Processor for doctools-based documentation files, i.e. the ".man" files under "doc/". See package tcllib.

This requirement is optional. If a Tcllib providing the package dtplite is installed then kettle will use the package in favor of the external application.

Demonstration/Example Applications

Mustache (currently) does not have demonstrations, nor examples.

Directory structure

The directory structure of the sources is as explained below:

"build.tcl"

The main file of the kettle-based build-system.
"doc/"

Main directory for all documentation.

Based on the doctools package and tools provided by Tcllib.
"doc/figures/"

Main directory for all diagrams and figures used by the documentation.

Based on the diagram package and tools provided by Tklib.
"embedded/"

Compiled documentation (manpages and markdown). Part of the repository for
1. easy access from the repository's web interface (embedded documentation), and
2. quicker installation (no need to compile during the installation process itself).
"tests/"

Main directory for the test-suite.

Based on the tcltest package distributed with the Tcl core.
"lib/"

Main directory for the provided packages.
"bin/"

Main directory for the provided applications.

Based on the tcltest package distributed with the Tcl core.
"lib/mustache.tcl"

Package mustache.
"lib/context.tcl"

Package mustache::context.
"lib/frame.tcl"

Package mustache::frame.
"lib/parse.tcl"

Package mustache::parse.
"lib/render.tcl"

Package mustache::render.

Extended Build Actions

Our build-system is based on kettle, as already explained in the Mustache - The Installer's Guide. Beyond the targets useful for installation it also provides targets aiding developers and maintainers. These are:

Validation of the documentation

% /path/to/mustache/build.tcl validate-doc

Regeneration of the embedded documentation
```
% /path/to/mustache/build.tcl doc
```
Regeneration of the figures for the documentation
```
% /path/to/mustache/build.tcl figures
```
Execution of the test-suite

The most basic execution of the test-suite is done with
```
% /path/to/mustache/build.tcl test
```
When the test-suite reports issues with the framework use of the more extended form below is indicated, with a of your choice. This will generate a number of files whose name starts with the prefix ".". These will contain extended test logs, details about errors and failures, etc.
```
% /path/to/mustache/build.tcl test --log <stem>
```

Architecture & Concepts

All packages belong to one of two layers, as shown below:

Note that:

Packages marked with a dashed border are private.
Packages marked with an unbroken blue border are fully public.

The dependencies between the packages are very straight-forward:

Bugs, Ideas, Feedback

Both the package(s) and this documentation will undoubtedly contain bugs and other problems. Please report such at Mustache Tracker.

Please also report any ideas you may have for enhancements of either package(s) and/or documentation.

KEYWORDS

logic-less templates, mustache, templating

Mustache