Nanoprogrammed Penultimate Musicianship

    texvcinfo

    0.5.7 • Public • Published

    texvcinfo

    npm version Build Status Coverage Status

    Prints the texvc tokens identified by texvcjs. Moreover, texvcinfo provides additional information on the input such as

    • listing the identifiers;
    • discovering if the expressions ends with a dot.

    This extension is used by mathoid. Some information generated by texvcinfo is available at Wikimedia REST API.

    Installation

    Node version 0.10 are tested to work.

    Install the node package dependencies with:

    npm install
    

    Ensure everything works:

    npm test
    

    Usage

      Usage: texvcinfo [options] <tex input>
    
      Options:
    
        -h, --help             output usage information
        -V, --version          output the version number
        -v, --verbose          Show verbose error information
        -D, --debug            Show stack trace on failure.
        -c, --compact          Do not pretty print output.
        -f, --flat             Flattens the tree for elements with only one child
        -o, --output [format]  Output the info in a specific format. Available options are:
        "list": prints all tokens as list
        "tree": prints the texvc AST
        "json": a json object that can be visualized using d3
        "identifier": prints TeX code for all identifiers
        "all": is a combination of list, tree and identifier
        "feedback": returns data to generate user feedback in a ui
    

    Visuals

    To see the tree structure you can output the result to (vis/data.json). If you want to see the texvc parse tree of the texvc expression $\frac12$ run

    ./bin/texvcinfo -j \\frac12 > ./vis/data.json
    

    . In the (/vis/index.html) is a 90° rotated version of the interactive Reingold–Tilford tree from http://bl.ocks.org/mbostock/4339083, that displays (vis/data.json).

    ##Error codes Status is one character:

    • "+" : success! result is in 'output'
    • "E" : Lexer exception raised
    • "F" : TeX function not recognized
    • "S" : Parsing error
    • "-" : Generic/Default failure code. Might be an invalid argument, output file already exist, a problem with an external command ...

    Implementation Details on Identifier extraction

    This section provides details on the implementation of the identifier extraction of texvcinfo.

    The identifier extraction is based on the texvc AST of the input TeX string. The main component is the extractIdentifiers visitor, which is supported by the extractSubscipts and the getModIdent visitor. Those visitors extend the functionality of the ast objects and define new methods to transform ast. Note, that parsed texvc input might be an array or a simple string rather than an ast object. Therefore, the identifier extractor differentiates between those three cases.

    License

    Copyright (c) 2015 Moritz Schubotz, C. Scott Ananian

    Licensed under GPLv2.

    Install

    npm i texvcinfo

    DownloadsWeekly Downloads

    409

    Version

    0.5.7

    License

    Apache-2.0

    Unpacked Size

    270 kB

    Total Files

    36

    Last publish

    Collaborators

    • physikerwelt
    • clarakosi
    • bpirkle