cdoc-base 0.10.0-alpha.1

Base type definitions for the Courses ecosystem.
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

name: base
version: 0.1

dependencies:
  extra: "*"

nodes:
  - type_id: HEADING
    has_children: false
    attributes:
      - name: level
        optional: false
        data_type: !Int
      - name: inner
        optional: false
        data_type: !Node
    children:
      - type_id: inner
        optional: false

  - type_id: PARAGRAPH
    has_children: true
    children:
      - kind: ANY
        repeat: "*"

  - type_id: SOFT_BREAK
    has_children: false

collections:
  - name: inline
    type: !OneOf[TEXT, STYLED, SOFT_BREAK, HARD_BREAK, CODE, MATH_INLINE, COMMAND]
  - name: block
    type: !OneOf[PARAGRAPH, HEADING, CODE_BLOCK, LIST]

nodest:
  - type_id: HEADING
    has_children: false
    attributes:
      - name: level
        optional: false
        data_type: !Int
      - name: inner
        optional: false
        data_type: !Node
    children:
      - type_id: inner
        optional: false

  - type_id: LIST
    attributes:
      - name: type
        type: enum
        values: [unordered, numeric, alphabetic, roman]
      - name: start
        type: int
        optional: yes
    children:
      - type: !Is[LIST_ITEM]
        count: one

  - type_id: CODE_BLOCK
    attributes:
      - name: label
        type: string
        optional: true
      - name: language
        type: string
        optional: true
      - name: is_cell
        type: flag
    has_value: true

  - type_id: MATH
    attributes:
      - name: label
        type: string
        optional: true
      - name: display_block
        type: flag
        optional: true
    has_value: true

  - type_id: STYLED
    attributes:
      - name: style
        type: Enum[emphasis, strong, strikethrough, underline]
    children:
      - type: !Collection inline
        count: one_or_many


  - type_id: PARAGRAPH
    children:
      - kind: !Collection[block]
        count: one_or_many

  - type_id: SOFT_BREAK
  - type_id: HARD_BREAK
  - type_id: HORIZONTAL_RULE


  # Example command
  - type_id: TASK
    attributes:
      - name: level
        type: Enum[easy, medium, hard]
    children:
      - type: !Is task:parameter_caption
        count: zero_or_one
      - type: !Any
        count: zero_or_many

  - type_id: task:parameter_caption
    children:
      - type: !Collection inline
        count: one_or_many