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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021-2023 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/
import Foundation
import Markdown
/// A chapter containing ``Tutorial``s to complete.
public final class Chapter: Semantic, AutomaticDirectiveConvertible, Abstracted, Redirected {
public static let introducedVersion = "5.5"
public let originalMarkup: BlockDirective
/// The name of the chapter.
@DirectiveArgumentWrapped
public private(set) var name: String
/// Content describing the contents of the chapter.
@ChildMarkup(numberOfParagraphs: .zeroOrMore)
public private(set) var content: MarkupContainer
/// A companion media element next to the chapter's contents.
@ChildDirective(requirements: .one)
public private(set) var image: ImageMedia? = nil
/// The list of tutorials and articles categorized under this chapter.
///
/// > Note: Topics may be referenced by multiple chapters.
@ChildDirective(requirements: .oneOrMore)
public private(set) var topicReferences: [TutorialReference]
static var keyPaths: [String : AnyKeyPath] = [
"name" : \Chapter._name,
"content" : \Chapter._content,
"image" : \Chapter._image,
"topicReferences" : \Chapter._topicReferences,
"redirects" : \Chapter._redirects,
]
override var children: [Semantic] {
return topicReferences
}
public var abstract: Paragraph? {
return content.first as? Paragraph
}
@ChildDirective
public private(set) var redirects: [Redirect]? = nil
init(originalMarkup: BlockDirective, name: String, content: MarkupContainer, image: ImageMedia?, tutorialReferences: [TutorialReference], redirects: [Redirect]?) {
self.originalMarkup = originalMarkup
super.init()
self.name = name
self.content = content
self.image = image
self.topicReferences = tutorialReferences
self.redirects = redirects
}
@available(*, deprecated, message: "Do not call directly. Required for 'AutomaticDirectiveConvertible'.")
init(originalMarkup: BlockDirective) {
self.originalMarkup = originalMarkup
}
public override func accept<V: SemanticVisitor>(_ visitor: inout V) -> V.Result {
return visitor.visitChapter(self)
}
}
|
