Parsanol specifications

This document is available in its rendered forms here:

• Parsanol specifications

Introduction

This repository contains the official specifications for the Parsanol framework: a high-performance PEG (parsing expression grammar) parsing stack with one grammar source language, one compiled artifact format, and language runtimes for Ruby, Rust, WebAssembly, and — through lutaml-model — schema-driven information models.

Documents

PN 1

PG — The Parsanol grammar language

PN 2

The PG artifact format

PN 3

PG foreign-grammar import (ABNF, ISO EBNF, pest)

PN 4

PG integration with lutaml-model

PN 5

PG testing and rule documentation

Document structure

sources/

source files for the Parsanol specifications, in Metanorma format.

1.adoc

PG — The Parsanol grammar language

2.adoc

The PG artifact format

3.adoc

Foreign-grammar import

4.adoc

lutaml-model integration

5.adoc

PG testing and rule documentation

_site/

generated documentation in multiple formats (HTML, PDF, XML).

Related repositories

• parsanol-rs — the Rust engine (walker, bytecode VM, wasm) and PG artifact consumer

• parsanol-ruby — the Ruby gem: the PG compiler, artifact tooling, and native bindings over parsanol-rs

• pubid-grammar — the reference application of PG: language-independent grammars, artifacts, corpora and binding specs

Building the documentation

This repository uses Metanorma to build standardized documentation.

Installing build tools

See the Metanorma installation guide.

Building locally

bundle install
metanorma site generate --agree-to-terms

Contributing

Issues and pull requests are welcome. Specification changes follow the same review discipline as engine changes: the normative statements in these documents are the contract that parsanol-rs, parsanol-ruby, and the PG tooling are tested against.