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
133
134
135

use crate::{document::TocMode, tests::prelude::*};

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

// This page is a per-converter (backend) reference table for the `toc` family
// of attributes. This crate is a parser with no converter backends, so the
// backend-specific rows are non-normative here, but the documented default
// values are verified below.

non_normative!(
    r#"
= TOC Attributes Reference
:endash: –

//[cols="1,1,2,2,1"]
[%autowidth]
|===
|Attribute |Values |Example Syntax |Notes |Backends

.4+|`toc`
|`auto`, `left`, `right`, `macro`, `preamble`
|`:toc: left`
"#
);

#[test]
fn toc_default() {
    verifies!(
        r#"
|Not set by default.
Defaults to `auto` if value is unspecified.
"#
    );

    // Not set by default: with no `toc` attribute, no table of contents is
    // generated.
    let unset = Parser::default().parse("= Title\n\n== Section\n\nhi");
    assert_eq!(unset.toc_mode(), TocMode::Disabled);
    assert_css(&unset, ".toc", 0);

    // Defaults to `auto` if the value is unspecified.
    let empty = Parser::default().parse("= Title\n:toc:\n\n== Section\n\nhi");
    assert_eq!(empty.toc_mode(), TocMode::Auto);
}

non_normative!(
    r#"
|html

|`auto`, `macro`, `preamble`
|`:toc: macro`
|Not set by default.
Defaults to `auto` if value is unspecified.
|html (embeddable)

|`auto`
|`:toc:`
|Not set by default.
When the title page is enabled in PDF output, the table of contents is placed directly after the title page.
|pdf

|`auto`
|`:toc:`
|Not set by default.
The placement and styling of the table of contents is determined by the DocBook toolchain configuration.
|docbook

|`toclevels`
|0{endash}5
|`:toclevels: 4`
"#
);

#[test]
fn toclevels_default() {
    verifies!(
        r#"
|Default value is `2`.
"#
    );

    let doc = Parser::default().parse("= Title\n:toc:\n\n== Section\n\nhi");
    assert_eq!(doc.toc_levels(), 2);
}

non_normative!(
    r#"
|html, pdf

|`toc-title`
|user-defined
|`:toc-title: Contents`
"#
);

#[test]
fn toc_title_default() {
    verifies!(
        r#"
|Default value is _Table of Contents_.
"#
    );

    let doc = Parser::default().parse("= Title\n:toc:\n\n== Section\n\nhi");
    assert_eq!(doc.toc_title(), "Table of Contents");
}

non_normative!(
    r#"
|html, pdf

|`toc-class`
|valid CSS class name
|`:toc-class: floating-toc`
"#
);

#[test]
fn toc_class_default() {
    verifies!(
        r#"
|Default value is _toc_.
"#
    );

    let doc = Parser::default().parse("= Title\n:toc:\n\n== Section\n\nhi");
    assert_eq!(doc.toc_class(), "toc");
}

non_normative!(
    r#"
|html
|===
"#
);