A TeX/LaTeX validator.
texvcjs takes user input and validates it while replacing
MediaWiki-specific functions. It is a JavaScript port of texvc,
which was originally written in OCaml for the Math extension.
The texvcjs library was originally written to be used by the
mw-ocg-latexer PDF-generation backend of the mediawiki
Collection extension.
Node version 0.8 and 0.10 are tested to work.
Install the node package dependencies with:
npm install
Ensure everything works:
npm test
To test your installation:
bin/texvcjs '\sin(x)+{}{}\cos(x)^2 newcommand'which should emit:
+\sin(x)+{}{}\cos(x)^{2}newcommand
Your programs can also use the JavaScript API exported by the
texvcjs node module:
var texvcjs = require('texvcjs');
var result = texvcjs.check('\\sin(x)+{}{}\\cos(x)^2 newcommand');
console.log(result.status);
console.log(result.output || ''); // cleaned/validated outputIf the output field is not undefined, then validation was successful.
The status field is a single character:
+: Success! The result is in theoutputfield.F: A TeX function was not recognized. The function name is in thedetailsfield.S: A parsing error occurred.-: Some other problem occurred.
For status types F, S, and -, the position of the error may be found
in the line, column and offset fields of the result. More information
about the problem can be found in the details field of the result, which
is a string.
The fields ams_required, cancel_required, color_required,
euro_required, and teubner_required are set to true iff the input
string requires the use of the corresponding LaTeX packages.
The ams_required field requires the use of the amsmath and amssymb
packages.
The low level parser, abstract syntax tree (AST), and renderer are also
exported from the module. This allows you to define more interesting
queries on the input source. An example can be found in lib/astutil.js
which defines a visitor function to test for the presence of specific
TeX functions in the input.
Copyright (c) 2014 C. Scott Ananian
Licensed under GPLv2.