Math/texvccheck at a25078ff9d62ba75ff9ba78eb149a03586154556 - Math

History

C. Scott Ananian a25078ff9d Remove unused empty production for `litsq_zq` in texvccheck It is impossible to take the empty alternative for this production, since any input which matches `litsq_aq` would instead match `lit_aq` if the empty alternative is used. In addition, there is no action clause for the empty alternative, so it wouldn't typecheck if the empty alternative was possible. This has no effect on the generated parser, but clarifies the grammar (and makes ports easier!). Change-Id: I32c85d2c74ab047b4b52401248d5dc7fc3201705		2014-07-23 16:06:13 +00:00
..
.gitignore	Breakdown of texvc	2013-12-14 18:34:15 +00:00
Makefile	Breakdown of texvc	2013-12-14 18:34:15 +00:00
README	Breakdown of texvc	2013-12-14 18:34:15 +00:00
lexer.mll	Breakdown of texvc	2013-12-14 18:34:15 +00:00
parser.mly	Remove unused empty production for `litsq_zq` in texvccheck	2014-07-23 16:06:13 +00:00
test.pl	Breakdown of texvc	2013-12-14 18:34:15 +00:00
tex.mli	Breakdown of texvc	2013-12-14 18:34:15 +00:00
texutil.ml	Breakdown of texvc	2013-12-14 18:34:15 +00:00
texvccheck.ml	Fix comment in texvccheck.ml	2014-07-23 15:55:32 +00:00
util.ml	Breakdown of texvc	2013-12-14 18:34:15 +00:00

README

== About texvccheck ==

texvc takes the user input validates it and replaces MediaWiki specific functions.
Input data is parsed and scrutinized for safety.

texvc was written by Tomasz Wegrzanowski for use with MediaWiki; it's
included as part of the MediaWiki package (http://www.mediawiki.org) and is
under the GPL license.

texvc-lite, was extracted from the original texvc program in 2013 by
Moritz Schubotz and uses only the sanitizing and customization part.

The list of all commands can be viewed by browsing the source files.
Most commands are listed at
http://sdrv.ms/15w2gVw
there is also a tool for convenient whitelisting of special commands
that are used in local wikis.

Please report bugs at: https://bugzilla.wikimedia.org/
with "MediaWiki extensions" as product and "Math" as component.

== Setup ==

=== Requirements ===

OCaml 3.06 or later is required to compile texvc; this can be acquired from
http://caml.inria.fr/ if your system doesn't have it available.

The makefile requires GNU make.

In Ubuntu Precise, all dependencies can be installed using:

  $ sudo apt-get install ocaml

=== Installation ===

Run 'make' (or 'gmake' if GNU make is not your default make). This should
produce the texvccheck executable.

By default,
MediaWiki will search in this directory for texvc, if you moved it elsewhere,
you'll have to modify $wgTexvc and set it to the path of the texvc executable.

== Usage ==

Normally texvc is called from MediaWiki's Math modules and everything
Just Works. It can be run manually for testing or for use in another app.

=== Command-line parameters ===

    texvccheck '\TeX input string'

Be sure to properly quote the TeX code!

Example:

    texvc "y=x+2"

=== Output format ===

The output is the sanitized and customized tex string.

texvc output format is like this:
    +%s		ok
    S		syntax error
    E		lexing error
    F%s		unknown function %s
    -		other error

== Hacking ==

Before you start hacking on the math package its good to know the workflow,
which is basically:

1. texvc gets called by Math/Math.body.php (check out the line begining with "$cmd")
2. texvc does its magic, which is basically to check for invalid latex code.
3. texvc takes the user input validates it and replaces MediaWiki specific functions