JavaScript APG Parsing Library

Deprecated Use the updated version apg-js instead.

Description

The JavaScript APG Parsing Library contains the basic core support code needed to run both apg, the parser generator, and the parsers that it generates.

git clone https://github.com/ldthomas/apg-js2-lib.git /path/to/my-copy-of-apg-lib
mkdir my-project
cd my-project
npm init
npm install /path/to/my-copy-of-apg-lib --save

mkdir my-project
cd my-project
npm init
npm install apg-lib --save

In your application code you can now access the apg library with require("apg-lib") (see examples)

Web page use

git clone https://github.com/ldthomas/apg-js2-lib.git apg-dir

In the header of your web page now include the resources:

<link rel="stylesheet" href="./apg-dir/apglib.css">
<script src="./apg-dir/apglib.js" charset="utf-8"></script>
or
<link rel="stylesheet" href="./apg-dir/apglib-min.css">
<script src="./apg-dir/apglib-min.js" charset="utf-8"></script>

Note that some apg-lib functions return results as HTML strings. apglib.css is required to properly style the HTML elements. In your web page JavaSript code you can now access the apg-lib modules through the apglib object. For example, to create a parser

var my-parser = new apglib.parser();

See the browser example, for specifics. See, also, this CodePen.

Examples

See apg-js2-examples for examples of running JavaScript APG and the parsers it generates.

Documentation

The full documentation is in the code in docco format. To generate the documentation, from the package directory:

npm install -g docco
./docco-gen

View docs/index.html in any web browser to get started. Or view it on the APG website

Copyright

Copyright © 2017 Lowell D. Thomas, all rights reserved

License

Released under the BSD-3-Clause license.