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
|
# ``docc/Chapter``
Organizes related tutorial pages into a chapter on a table of contents page.
@Metadata {
@DocumentationExtension(mergeBehavior: override)
}
- Parameters:
- name: The name of the chapter. **(required)**
## Overview
Chapters appear on a table of contents page and help provide a sense of context and accomplishment as readers move through your tutorial content.
Use `Chapter` directives to organize related tutorial pages into groupings. For each chapter, use the `name` parameter to specify a chapter name, and provide some descriptive text. Then, insert ``TutorialReference`` directives for the tutorial pages each chapter contains. Optionally, use ``Image`` directives to show images that illustrate the chapters' content.
```
@Tutorials(name: "SlothCreator") {
...
@Chapter(name: "SlothCreator Essentials") {
@Image(source: "chapter1-slothcreatorEssentials.png", alt: "A wireframe of an app interface that has an outline of a sloth and four buttons below the sloth. The buttons display the following symbols, from left to right: snowflake, fire, wind, and lightning.")
Create custom sloths and edit their attributes and powers using SlothCreator.
@TutorialReference(tutorial: "doc:Creating-Custom-Sloths")
}
...
}
````
### Group Related Chapters
If you need a second level of organization on a table of contents page, use ``Volume`` directives to organize related chapters into volume groupings.
```
@Tutorials(name: "SlothCreator") {
@Intro(title: "Meet SlothCreator") {
...
}
@Volume(name: "Getting Started") {
Building sloths, caring for them, and interacting with them.
@Chapter(name: "SlothCreator Essentials") {
...
}
@Chapter(name: "Basic Sloth Care") {
...
}
@Chapter(name: "Basic Sloth Interaction") {
...
}
}
@Volume(name: "Climbing Higher") {
Taking your sloths to the next level.
@Chapter(name: "Powering Up") {
...
}
...
}
...
}
````
### Contained Elements
A chapter can contain the following items:
- term ``Image``: An image that represents the chapter's content. **(optional)**
- term ``TutorialReference``: A reference to a tutorial page. A chapter must contain at least one tutorial page reference. **(optional)**
### Containing Elements
The following items can contain chapters:
* ``Tutorials``
* ``Volume``
## Topics
### Referencing Tutorials
- ``TutorialReference``
### Displaying an Image
- ``Image``
<!-- Copyright (c) 2021 Apple Inc and the Swift Project authors. All Rights Reserved. -->
|
