asciidoc-parser 0.19.0

Parser for AsciiDoc format
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

use crate::tests::prelude::*;

track_file!("ref/asciidoc-lang/docs/modules/sections/pages/glossary.adoc");

non_normative!(
    r#"
= Glossary

"#
);

#[test]
fn intro() {
    verifies!(
        r#"
You can include a glossary in an article, book, and book part by setting the `glossary` style on a section.

"#
    );

    // A section assigned the `glossary` style carries that style.
    let doc = Parser::default().parse("[glossary]\n== Terminology\n");
    let section = doc.nested_blocks().next().unwrap();
    assert_eq!(section.declared_style(), Some("glossary"));
}

#[test]
fn glossary_section_syntax() {
    verifies!(
        r#"
== Glossary section syntax

"#
    );

    // The `glossary` style is recognized on a level 1 section.
    let doc = Parser::default().parse("[glossary]\n== Terminology\n");
    let section = doc.nested_blocks().next().unwrap();
    assert_eq!(section.declared_style(), Some("glossary"));
    assert_eq!(section.raw_context().as_ref(), "section");

    // The `doctype` and book-part conditions that select level 1 are
    // non-normative for this crate, which models a single article-style
    // document. The `glossary` style is still recognized on the section.
    non_normative!(
        r#"
The glossary section is defined as a level 1 section (`==`) when:

* the doctype is `article`
* the doctype is `book` and the book doesn't contain any parts
* the glossary is for a book part

"#
    );

    verifies!(
        r#"
[source]
----
[glossary]
== Terminology
----

"#
    );

    // The `glossary` section style is recognized as a level 1 section.
    let doc = Parser::default().parse("[glossary]\n== Terminology\n");
    let section = doc.nested_blocks().next().unwrap();
    assert_eq!(section.declared_style(), Some("glossary"));
    assert_eq!(section.raw_context().as_ref(), "section");

    // The level 0 (`=`) form applies only to a multi-part book, which this
    // crate does not model: a level 0 heading is reserved for the document
    // title. The remaining guidance is therefore non-normative here.
    non_normative!(
        r#"
If the book has parts, and the glossary is for the whole book, the section is defined as a level 0 section (`=`).

[source]
----
[glossary]
= Glossary
----

"#
    );
}

#[test]
fn glossary_description_list_style_syntax() {
    verifies!(
        r#"
== Glossary description list style syntax

In addition to setting `glossary` on the section, the block style `glossary` must be set on the description list in the section.

"#
    );

    verifies!(
        r#"
[source]
----
[glossary]
== Glossary

[glossary]
mud:: wet, cold dirt
rain::
	water falling from the sky
----
"#
    );

    // Setting `glossary` on both the section and the description list within it:
    // the section carries the `glossary` style, and the description list renders
    // with the `glossary` style class. Per the spec, the section style is not
    // implicitly propagated to the list; the list must declare it explicitly.
    let doc = Parser::default().parse(
        "[glossary]\n== Glossary\n\n[glossary]\nmud:: wet, cold dirt\nrain::\n\twater falling from the sky\n",
    );

    let section = doc.nested_blocks().next().unwrap();
    assert_eq!(section.declared_style(), Some("glossary"));

    let dlist = section.nested_blocks().next().unwrap();
    assert_eq!(dlist.declared_style(), Some("glossary"));

    assert_css(&doc, ".dlist.glossary", 1);
    assert_css(&doc, ".dlist dt:not([class])", 2);
}