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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
use crate::{document::RefType, tests::prelude::*};
track_file!("ref/asciidoc-lang/docs/modules/sections/pages/appendix.adoc");
non_normative!(
r#"
= Appendix
The `appendix` section style can be used in books and articles, and it can have subsections.
While the AsciiDoc structure allows appendices to be placed anywhere, it's customary to place them near the end of the document.
"#
);
#[test]
fn appendix_section_syntax() {
verifies!(
r#"
== Appendix section syntax
For articles, the appendix must be defined as a level 1 section (`==`).
For example:
[source]
----
include::example$appendix.adoc[tag=appx-article]
----
The table of contents will appear as follows:
----
include::example$appendix.adoc[tag=appx-article-out]
----
"#
);
// NOTE: Removed the `:appendix-caption: Exhibit` and `:toc:` header
// attributes from the example. The `appendix-caption` attribute is now
// honored (it defaults to "`Appendix`", so the appendix sections below carry
// "Appendix A: " / "Appendix B: " captions), but `toc` rendering is still not
// supported. A custom `appendix-caption` value is exercised separately in
// `appendix_label` below.
let doc = Parser::default().parse("= Article Title\n:sectnums:\n\n== Section\n\n=== Subsection\n\n[appendix]\n== First Appendix\n\n=== First Subsection\n\n=== Second Subsection\n\n[appendix]\n== Second Appendix");
assert_eq!(
doc,
Document {
header: Header {
title_source: Some(Span {
data: "Article Title",
line: 1,
col: 3,
offset: 2,
},),
title: Some("Article Title",),
attributes: &[Attribute {
name: Span {
data: "sectnums",
line: 2,
col: 2,
offset: 17,
},
value_source: None,
value: InterpretedValue::Set,
source: Span {
data: ":sectnums:",
line: 2,
col: 1,
offset: 16,
},
},],
author_line: None,
revision_line: None,
comments: &[],
source: Span {
data: "= Article Title\n:sectnums:",
line: 1,
col: 1,
offset: 0,
},
},
blocks: &[
Block::Section(SectionBlock {
level: 1,
section_title: Content {
original: Span {
data: "Section",
line: 4,
col: 4,
offset: 31,
},
rendered: "Section",
},
blocks: &[Block::Section(SectionBlock {
level: 2,
section_title: Content {
original: Span {
data: "Subsection",
line: 6,
col: 5,
offset: 44,
},
rendered: "Subsection",
},
blocks: &[],
source: Span {
data: "=== Subsection",
line: 6,
col: 1,
offset: 40,
},
title_source: None,
title: None,
anchor: None,
anchor_reftext: None,
attrlist: None,
section_type: SectionType::Normal,
section_id: Some("_subsection",),
caption: None,
section_number: Some(SectionNumber {
section_type: SectionType::Normal,
components: &[1, 1,],
},),
},),],
source: Span {
data: "== Section\n\n=== Subsection",
line: 4,
col: 1,
offset: 28,
},
title_source: None,
title: None,
anchor: None,
anchor_reftext: None,
attrlist: None,
section_type: SectionType::Normal,
section_id: Some("_section",),
caption: None,
section_number: Some(SectionNumber {
section_type: SectionType::Normal,
components: &[1,],
},),
},),
Block::Section(SectionBlock {
level: 1,
section_title: Content {
original: Span {
data: "First Appendix",
line: 9,
col: 4,
offset: 70,
},
rendered: "First Appendix",
},
blocks: &[
Block::Section(SectionBlock {
level: 2,
section_title: Content {
original: Span {
data: "First Subsection",
line: 11,
col: 5,
offset: 90,
},
rendered: "First Subsection",
},
blocks: &[],
source: Span {
data: "=== First Subsection",
line: 11,
col: 1,
offset: 86,
},
title_source: None,
title: None,
anchor: None,
anchor_reftext: None,
attrlist: None,
section_type: SectionType::Appendix,
section_id: Some("_first_subsection",),
caption: None,
section_number: Some(SectionNumber {
section_type: SectionType::Appendix,
components: &[1, 1,],
},),
},),
Block::Section(SectionBlock {
level: 2,
section_title: Content {
original: Span {
data: "Second Subsection",
line: 13,
col: 5,
offset: 112,
},
rendered: "Second Subsection",
},
blocks: &[],
source: Span {
data: "=== Second Subsection",
line: 13,
col: 1,
offset: 108,
},
title_source: None,
title: None,
anchor: None,
anchor_reftext: None,
attrlist: None,
section_type: SectionType::Appendix,
section_id: Some("_second_subsection",),
caption: None,
section_number: Some(SectionNumber {
section_type: SectionType::Appendix,
components: &[1, 2,],
},),
},),
],
source: Span {
data: "[appendix]\n== First Appendix\n\n=== First Subsection\n\n=== Second Subsection",
line: 8,
col: 1,
offset: 56,
},
title_source: None,
title: None,
anchor: None,
anchor_reftext: None,
attrlist: Some(Attrlist {
attributes: &[ElementAttribute {
name: None,
value: "appendix",
shorthand_items: &["appendix"],
},],
anchor: None,
source: Span {
data: "appendix",
line: 8,
col: 2,
offset: 57,
},
},),
section_type: SectionType::Appendix,
section_id: Some("_first_appendix",),
caption: Some("Appendix A: ",),
section_number: Some(SectionNumber {
section_type: SectionType::Appendix,
components: &[1,],
},),
},),
Block::Section(SectionBlock {
level: 1,
section_title: Content {
original: Span {
data: "Second Appendix",
line: 16,
col: 4,
offset: 145,
},
rendered: "Second Appendix",
},
blocks: &[],
source: Span {
data: "[appendix]\n== Second Appendix",
line: 15,
col: 1,
offset: 131,
},
title_source: None,
title: None,
anchor: None,
anchor_reftext: None,
attrlist: Some(Attrlist {
attributes: &[ElementAttribute {
name: None,
value: "appendix",
shorthand_items: &["appendix"],
},],
anchor: None,
source: Span {
data: "appendix",
line: 15,
col: 2,
offset: 132,
},
},),
section_type: SectionType::Appendix,
section_id: Some("_second_appendix",),
caption: Some("Appendix B: ",),
section_number: Some(SectionNumber {
section_type: SectionType::Appendix,
components: &[2,],
},),
},),
],
source: Span {
data: "= Article Title\n:sectnums:\n\n== Section\n\n=== Subsection\n\n[appendix]\n== First Appendix\n\n=== First Subsection\n\n=== Second Subsection\n\n[appendix]\n== Second Appendix",
line: 1,
col: 1,
offset: 0,
},
warnings: &[],
source_map: SourceMap(&[]),
catalog: Catalog {
refs: HashMap::from([
(
"_first_appendix",
RefEntry {
id: "_first_appendix",
reftext: Some("First Appendix",),
ref_type: RefType::Section,
},
),
(
"_first_subsection",
RefEntry {
id: "_first_subsection",
reftext: Some("First Subsection",),
ref_type: RefType::Section,
},
),
(
"_second_appendix",
RefEntry {
id: "_second_appendix",
reftext: Some("Second Appendix",),
ref_type: RefType::Section,
},
),
(
"_second_subsection",
RefEntry {
id: "_second_subsection",
reftext: Some("Second Subsection",),
ref_type: RefType::Section,
},
),
(
"_section",
RefEntry {
id: "_section",
reftext: Some("Section",),
ref_type: RefType::Section,
},
),
(
"_subsection",
RefEntry {
id: "_subsection",
reftext: Some("Subsection",),
ref_type: RefType::Section,
},
),
]),
reftext_to_id: HashMap::from([
("First Appendix", "_first_appendix",),
("First Subsection", "_first_subsection",),
("Second Appendix", "_second_appendix",),
("Second Subsection", "_second_subsection",),
("Section", "_section",),
("Subsection", "_subsection",),
]),
},
}
);
}
// Treating this part as non-normative because we don't support `doctype`.
non_normative!(
r#"
For books, the appendix must be defined as a level 1 section (`==`) if you want the appendix to be a adjacent to the chapters.
In a multi-part book, if you want the appendix to be adjacent to other parts, the appendix must be defined as a level 0 section (`=`).
In either case, the first subsection of the appendix must be a level 2 section (`===`).
The following example shows how to define an appendix for a multi-part book.
[source]
----
include::example$appendix.adoc[tag=appx-book]
----
The table of contents will appear as follows:
----
include::example$appendix.adoc[tag=appx-book-out]
----
"#
);
#[test]
fn appendix_label() {
verifies!(
r#"
[#caption]
== Appendix label
When rendered, the titles of sections marked as `appendix` will include:
* A label, taken from the value of the `appendix-caption` attribute, which defaults to "`Appendix`"
* A letter that represents the order of the appendix within the sequence of appendices (A, B, ...)
* A colon
* The section title
For example:
Appendix A: Data Access Matrix
"#
);
// The label is exposed as the section's caption (the prefix a converter
// prepends to the section title). With the default `appendix-caption`, the
// first appendix is labeled "Appendix A: " and appendices are lettered in
// document order. This holds even without `sectnums`, because appendix
// labels are controlled by `appendix-caption`, not section numbering.
let doc = Parser::default()
.parse("= Title\n\n[appendix]\n== Data Access Matrix\n\n[appendix]\n== Error Codes");
let captions: Vec<Option<&str>> = doc.nested_blocks().map(|b| b.caption()).collect();
assert_eq!(captions, vec![Some("Appendix A: "), Some("Appendix B: ")]);
// The rendered title combines the caption (label + letter + colon) with the
// section title, e.g. "Appendix A: Data Access Matrix".
let first = doc.nested_blocks().next().unwrap();
if let crate::blocks::Block::Section(section) = first {
assert_eq!(
format!("{}{}", section.caption().unwrap(), section.section_title()),
"Appendix A: Data Access Matrix"
);
} else {
panic!("expected the first block to be a section");
}
verifies!(
r#"
The prefix can be modified by setting the `appendix-caption` attribute and overriding the default value with a custom value.
[source]
----
:appendix-caption: Exhibit
----
"#
);
let doc = Parser::default().parse(
":appendix-caption: Exhibit\n\n[appendix]\n== Data Access Matrix\n\n[appendix]\n== Error Codes",
);
let captions: Vec<Option<&str>> = doc.nested_blocks().map(|b| b.caption()).collect();
assert_eq!(captions, vec![Some("Exhibit A: "), Some("Exhibit B: ")]);
verifies!(
r#"
Unset the attribute to remove the prefix.
[source]
----
:appendix-caption!:
----
"#
);
// Unsetting `appendix-caption` removes the label, but the appendix is still
// lettered: the prefix collapses to "<letter>. " (matching Ruby Asciidoctor).
let doc = Parser::default().parse(
":appendix-caption!:\n\n[appendix]\n== Data Access Matrix\n\n[appendix]\n== Error Codes",
);
let captions: Vec<Option<&str>> = doc.nested_blocks().map(|b| b.caption()).collect();
assert_eq!(captions, vec![Some("A. "), Some("B. ")]);
}