Adding code usage example

This commit is contained in:
Tom MacWright 2011-02-02 17:08:05 -05:00
parent 770da9871f
commit 9c328aa99d

View File

@ -193,10 +193,35 @@ By defining multiple fonts in a `text-face-name` definition, you create [FontSet
## Usage
Using the binary
#### Using the binary
messc map_file.json
#### Using the code
Currently `mess.js` is designed to be invoked from [node.js](http://nodejs.org/).
The `Renderer` interface is the main API for developers, and it takes an MML file as a string as input.
// defined variables:
// - input (the name or identifier of the file being parsed)
// - data (a string containing the MML or an object of MML)
var mess = require('mess');
new mess.Renderer({
filename: input,
local_data_dir: path.dirname(input),
}).render(data, function(err, output) {
if (err) {
if (Array.isArray(err)) {
err.forEach(function(e) {
mess.writeError(e, options);
});
} else { throw err; }
} else {
sys.puts(output);
}
});
## Authors
* Tom MacWright (tmcw)