Adding documentation
This commit is contained in:
1
book/.gitignore
vendored
Normal file
1
book/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
||||
book
|
||||
6
book/book.toml
Normal file
6
book/book.toml
Normal file
@@ -0,0 +1,6 @@
|
||||
[book]
|
||||
authors = ["Lionel Sambuc"]
|
||||
language = "en"
|
||||
multilingual = false
|
||||
src = "src"
|
||||
title = "Mercator Parser"
|
||||
5
book/src/SUMMARY.md
Normal file
5
book/src/SUMMARY.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# Summary
|
||||
|
||||
[Introduction](./introduction.md)
|
||||
- [Filter Grammar](./filters.md)
|
||||
- [Query Grammar](./queries.md)
|
||||
10
book/src/filters.md
Normal file
10
book/src/filters.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# Filter Grammar
|
||||
|
||||
You will find below the definition of this SDL, for filtering data
|
||||
from the index.
|
||||
|
||||
## filters.g4
|
||||
|
||||
```antlr
|
||||
{{#include ../../Grammars/filters.g4}}
|
||||
```
|
||||
7
book/src/introduction.md
Normal file
7
book/src/introduction.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Introduction
|
||||
|
||||
To support volumetric queries for Mercator, a new domain-specific language (DSL) was created.
|
||||
|
||||
ANTLR was used to write and test the SDL, to check it stays simple
|
||||
to parse and and fast to execute. The actual [parser](https://epfl-dias.github.io/mercator_parser/) and interpreter is
|
||||
defined in rust, using [LALRPOP](https://docs.rs/lalrpop/0.18.1/lalrpop/).
|
||||
9
book/src/queries.md
Normal file
9
book/src/queries.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Query Grammar
|
||||
|
||||
You will find below the definition of this SDL, for queries. This builds on top of the [filters](filters.html) grammar.
|
||||
|
||||
## queries.g4
|
||||
|
||||
```antlr
|
||||
{{#include ../../Grammars/queries.g4}}
|
||||
```
|
||||
Reference in New Issue
Block a user