diff options
| author | Jed Barber <jjbarber@y7mail.com> | 2021-01-19 02:25:44 +1100 |
|---|---|---|
| committer | Jed Barber <jjbarber@y7mail.com> | 2021-01-19 02:25:44 +1100 |
| commit | da389927ddf9240bbba10b819eb782e80a5d6bf7 (patch) | |
| tree | 88b167b892de8c419151ca9a02c16f8d4ed96bec /doc/quickstart.html | |
| parent | 901c7e61278f16dc5c08cbebf74c2a816cd4b4b6 (diff) | |
Basic HTML documentation added
Diffstat (limited to 'doc/quickstart.html')
| -rw-r--r-- | doc/quickstart.html | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/quickstart.html b/doc/quickstart.html new file mode 100644 index 0000000..b525f8f --- /dev/null +++ b/doc/quickstart.html @@ -0,0 +1,65 @@ + +<!DOCTYPE html> + +<html lang="en"> + <head> + <meta charset="utf-8"> + <title>Quickstart Guide - Packrat Docs</title> + <link href="default.css" rel="stylesheet"> + </head> + + <body> + + + <h2>Quickstart Guide</h2> + + <a href="index.html">Return to Contents</a> + + + <h4>Lexing and Parsing</h4> + + <p>The package that you will need is <em>Packrat.Standard</em>. If you are parsing + ordinary strings then <em>Packrat.Utilities</em> may also be useful.<br> + <br> + Define enumeration types for all the lexer token labels and parse graph node labels + you need, then use them to instantiate <em>Packrat.Standard</em>.<br> + <br> + Instantiate subprograms from the nested <em>Lexers</em> package to create your lexer, + and subprograms from the nested <em>Parsers</em> package to create your parser.<br> + <br> + Take special care when using any redirects from <em>Parsers</em>. They are used to + allow for self-referential instantiation of parser combinators and must be set properly + before using any parsers built with them. Otherwise an exception will be raised.<br> + <br> + Feed your input through the lexer, then the results of that through the parser to + obtain a parse graph.<br> + <br> + Use subprograms from the nested <em>Parse_Graphs</em> package to inspect and manipulate + the resulting graph. + </p> + + + <h4>Parsing Only</h4> + + <p>The package that you will need is <em>Packrat.No_Lex</em>. If you are parsing + ordinary strings then <em>Packrat.Utilities</em> may also be useful.<br> + <br> + Define an enumeration type for all the parse graph node labels you need, then use it + to instantiate <em>Packrat.No_Lex</em>.<br> + <br> + Instantiate subprograms from the nested <em>Parsers</em> package to create your parser.<br> + <br> + Take special care when using any redirects. They are used to allow for self-referential + instantiation of parser combinators and must be set properly before using any parsers + built with them. Otherwise an exception will be raised.<br> + <br> + Feed your input through the parser to obtain a parse graph.<br> + <br> + Use subprograms from the nested <em>Parse_Graphs</em> package to inspect and manipulate + the resulting graph. + </p> + + + </body> +</html> + |