Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cscott/texvcjs
A LaTeX validator/translator for TeX strings embedded in wikitext
https://github.com/cscott/texvcjs
Last synced: 2 months ago
JSON representation
A LaTeX validator/translator for TeX strings embedded in wikitext
- Host: GitHub
- URL: https://github.com/cscott/texvcjs
- Owner: cscott
- Created: 2014-07-22T19:53:51.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-06-12T06:11:30.000Z (7 months ago)
- Last Synced: 2024-10-03T18:46:04.979Z (3 months ago)
- Language: JavaScript
- Size: 22.5 MB
- Stars: 3
- Watchers: 2
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# texvcjs
[![NPM][NPM1]][NPM2]
[![Build Status][1]][2] [![dependency status][3]][4] [![dev dependency status][5]][6]
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].
## Installation
Node version 0.8 and 0.10 are tested to work.
Install the node package dependencies with:
```
npm install
```
Ensure everything works:
```
npm test
```
## Running
To test your installation:
```sh
bin/texvcjs '\sin(x)+{}{}\cos(x)^2 newcommand'
```
which should emit:
```
+\sin(x)+{}{}\cos(x)^{2}newcommand
```
## API
Your programs can also use the JavaScript API exported by the
`texvcjs` node module:
```js
var texvcjs = require('texvcjs');
var result = texvcjs.check('\\sin(x)+{}{}\\cos(x)^2 newcommand');
console.log(result.status);
console.log(result.output || ''); // cleaned/validated output
```
If the `output` field is not `undefined`, then validation was successful.
The `status` field is a single character:
* `+`: Success! The result is in the `output` field.
* `F`: A TeX function was not recognized. The function name is in the
`details` field.
* `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.
### Low-level API
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.
## License
Copyright (c) 2014 C. Scott Ananian
Licensed under GPLv2.
[mw-ocg-latexer]: https://github.com/wikimedia/mediawiki-extensions-Collection-OfflineContentGenerator-latex_renderer
[texvc]: https://git.wikimedia.org/blob/mediawiki%2Fextensions%2FMath/REL1_23/texvccheck%2FREADME
[Math extension]: https://www.mediawiki.org/wiki/Extension:Math
[Collection extension]: https://www.mediawiki.org/wiki/Extension:Collection
[OCaml]: https://ocaml.org/
[LaTeX packages]: http://www.ctan.org/
[NPM1]: https://nodei.co/npm/texvcjs.svg
[NPM2]: https://nodei.co/npm/texvcjs/
[1]: https://travis-ci.org/cscott/texvcjs.svg
[2]: https://travis-ci.org/cscott/texvcjs
[3]: https://david-dm.org/cscott/texvcjs.svg
[4]: https://david-dm.org/cscott/texvcjs
[5]: https://david-dm.org/cscott/texvcjs/dev-status.svg
[6]: https://david-dm.org/cscott/texvcjs#info=devDependencies