-
Notifications
You must be signed in to change notification settings - Fork 42
/
Admonition.yaml
114 lines (114 loc) · 2.8 KB
/
Admonition.yaml
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
title: Admonition
'@id': stencila:Admonition
extends: Entity
category: prose
description: A admonition within a document.
html:
elem: aside
jats:
elem: boxed-text
markdown:
derive: false
proptest: {}
required:
- admonitionType
- content
core:
- title
- isFolded
- authors
- provenance
properties:
admonitionType:
'@id': stencila:admonitionType
description: The type of admonition.
$ref: AdmonitionType
patch:
formats: [md]
jats:
attr: content-type
proptest:
min:
description: Fixed admonition type.
value: AdmonitionType::Info
low:
description: Generate an arbitrary admonition type.
strategy: AdmonitionType::arbitrary()
title:
'@id': schema:headline
description: The title of the admonition.
type: array
items:
$ref: Inline
patch:
formats: [md]
dom:
elem: p
jats:
elem: caption
proptest:
min:
description: No title.
value: None
low:
description: Generate up to two arbitrary, non-recursive, inline nodes.
strategy: option::of(vec_inlines_non_recursive(2))
high:
description: Generate up to four arbitrary, non-recursive, inline nodes.
strategy: option::of(vec_inlines_non_recursive(4))
isFolded:
'@id': stencila:isFolded
description: Whether the admonition is folded.
$comment: |
When an admonition is folded, its `content` is hidden by default, but
can be toggled to be visible or hidden.
type: boolean
patch:
formats: [md]
jats:
attr: is-folded
proptest:
min:
description: Not foldable.
value: None
low:
description: Arbitrarily, un-foldable, folded, or unfolded.
strategy: option::of(bool::arbitrary())
content:
'@id': stencila:content
description: The content within the section.
type: array
items:
$ref: Block
dom:
elem: aside
proptest:
min:
description: A single, simple paragraph.
value: vec![p([t("Admonition content")])]
low:
description: Generate up to two arbitrary, non-recursive, block nodes.
strategy: vec_blocks_non_recursive(2)
high:
description: Generate up to four arbitrary, non-recursive, block nodes.
strategy: vec_blocks_non_recursive(4)
authors:
'@id': schema:author
description: The authors of the admonition.
type: array
items:
$ref: Author
strip: [authors]
serde:
deserializeWith: option_one_or_many_string_or_object
dom:
elem: div
provenance:
'@id': stencila:provenance
description: A summary of the provenance of the content within the admonition.
type: array
items:
$ref: ProvenanceCount
strip: [provenance]
dom:
elem: div