mediawiki_parser 0.3.6

A strict parser for MediaWiki markdown.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

# mediawiki-peg-rust
This project aims to develop a parser for mediawiki markdown on the basis of Parsing Expression Grammars. 
It currently features a generated parser and test generation from a specification document. A simple binary to read from a file and write yaml to stdout is provided.

Although compatibility with the online MediaWiki markup is desirable and worked towards, this parser will focus on a useful subset of the markup language for now. Instead, providing useful error messages and encouraging semantic markup will be a priority.

## Currently supported MediaWiki:

* Text formatting: `''italic'', '''bold''', <math>\LaTex</math>, <code></code>, ...`
* Paragraphs
* Heading hierarchies
* Lists
* Internal references (files) `[[File.ext|option|caption]]`
* External references `[https://example.com/ example]`
* Tables
* Generic templates `{{name|anon_arg|arg=value}}`
* Galleries
* Generic html tags and comments `<thing>content</thing>`

## Example

Parsing will result in either a syntax tree with position information (mostly omitted here for conciseness):

Input:
``` markdown
this is some ''formatted'' [https://example.com example] text.
```
Output (as pseudo-YAML):
``` yaml
---
type: document
position: ...
content:
  - type: paragraph
    position: ...
    content:
      - type: text
        position: ...
        text: "this is some "
      - type: formatted
        position: ...
        markup: italic
        content:
          - type: text
            position:
              start:
                offset: 15
                line: 1
                col: 16
              end:
                offset: 24
                line: 1
                col: 25
            text: formatted
      - type: text
        position: ...
        text: " "
      - type: externalreference
        position: ...
        target: "https://example.com"
        caption:
          - type: text
            position: ...
            text: example
      - type: text
        position: ...
        text: " text."
```

Or a syntax error (here is a pretty representation):
```
ERROR in line 1 at column 57: Could not continue to parse, expected one of: ''', [, <!--, '', [[, EOF, "\n", {{, [ 	], opening html tag, <, normal text
1 | this is some ''formatted'' [https://example.com example]] text.
2 |
``` 

## API

The library provides a straight forward `parse()` function:

```rust
let input = "Hello World";
let result = mediawiki_parser::parse(&input)
    .expect(\"Parsing of the input for {} failed!\");
println!(\"{{}}\", &serde_yaml::to_string(&result).unwrap());
```

The result is a custom abstract syntax tree (AST). See the documentation for details.