| 1 | # Section Schema
|
| 2 |
|
| 3 | ```txt
|
| 4 | https://ns.adobe.com/helix/pipeline/section
|
| 5 | ```
|
| 6 |
|
| 7 | A section in a markdown document
|
| 8 |
|
| 9 |
|
| 10 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
| 11 | | :--------------------- | ---------- | ------------ | ----------------------- | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------------- |
|
| 12 | | Cannot be instantiated | Yes | Experimental | Unknown identifiability | Forbidden | Allowed | none | [section.schema.json](section.schema.json "open original schema") |
|
| 13 |
|
| 14 | ## Section Type
|
| 15 |
|
| 16 | unknown ([Section](section.md))
|
| 17 |
|
| 18 | # Section Definitions
|
| 19 |
|
| 20 | ## Definitions group section
|
| 21 |
|
| 22 | Reference this group by using
|
| 23 |
|
| 24 | ```json
|
| 25 | {"$ref":"https://ns.adobe.com/helix/pipeline/section#/definitions/section"}
|
| 26 | ```
|
| 27 |
|
| 28 | | Property | Type | Required | Nullable | Defined by |
|
| 29 | | :-------------------- | ------------- | -------- | -------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
| 30 | | [type](#type) | Not specified | Optional | cannot be null | [Section](section-definitions-section-properties-type.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/type") |
|
| 31 | | [position](#position) | `object` | Optional | cannot be null | [Section](section-definitions-section-properties-position.md "https://ns.adobe.com/helix/pipeline/position#/definitions/section/properties/position") |
|
| 32 | | [children](#children) | `array` | Optional | cannot be null | [Section](section-definitions-section-properties-children.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/children") |
|
| 33 | | [meta](#meta) | Unknown Type | Optional | can be null | [Section](meta-definitions-meta.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/meta") |
|
| 34 | | [title](#title) | `string` | Optional | cannot be null | [Section](meta-definitions-meta-properties-title.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/title") |
|
| 35 | | [intro](#intro) | `string` | Optional | cannot be null | [Section](meta-definitions-meta-properties-intro.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/intro") |
|
| 36 | | [image](#image) | `string` | Optional | cannot be null | [Section](meta-definitions-meta-properties-image.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/image") |
|
| 37 |
|
| 38 | ### type
|
| 39 |
|
| 40 | The MDAST node type. Each section can be treated as a standalone document.
|
| 41 |
|
| 42 |
|
| 43 | `type`
|
| 44 |
|
| 45 | - is optional
|
| 46 | - Type: unknown
|
| 47 | - cannot be null
|
| 48 | - defined in: [Section](section-definitions-section-properties-type.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/type")
|
| 49 |
|
| 50 | #### type Type
|
| 51 |
|
| 52 | unknown
|
| 53 |
|
| 54 | #### type Constraints
|
| 55 |
|
| 56 | **constant**: the value of this property must be equal to:
|
| 57 |
|
| 58 | ```json
|
| 59 | "root"
|
| 60 | ```
|
| 61 |
|
| 62 | ### position
|
| 63 |
|
| 64 | Marks the position of an AST node in the original text flow
|
| 65 |
|
| 66 |
|
| 67 | `position`
|
| 68 |
|
| 69 | - is optional
|
| 70 | - Type: `object` ([Position](section-definitions-section-properties-position.md))
|
| 71 | - cannot be null
|
| 72 | - defined in: [Section](section-definitions-section-properties-position.md "https://ns.adobe.com/helix/pipeline/position#/definitions/section/properties/position")
|
| 73 |
|
| 74 | #### position Type
|
| 75 |
|
| 76 | `object` ([Position](section-definitions-section-properties-position.md))
|
| 77 |
|
| 78 | ### children
|
| 79 |
|
| 80 | The AST nodes making up the section. Section dividers are not included.
|
| 81 |
|
| 82 |
|
| 83 | `children`
|
| 84 |
|
| 85 | - is optional
|
| 86 | - Type: `object[]` ([MDAST](content-properties-mdast.md))
|
| 87 | - cannot be null
|
| 88 | - defined in: [Section](section-definitions-section-properties-children.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/children")
|
| 89 |
|
| 90 | #### children Type
|
| 91 |
|
| 92 | `object[]` ([MDAST](content-properties-mdast.md))
|
| 93 |
|
| 94 | ### meta
|
| 95 |
|
| 96 |
|
| 97 |
|
| 98 |
|
| 99 | `meta`
|
| 100 |
|
| 101 | - is optional
|
| 102 | - Type: `object` ([Details](meta-definitions-meta.md))
|
| 103 | - can be null
|
| 104 | - defined in: [Section](meta-definitions-meta.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/meta")
|
| 105 |
|
| 106 | #### meta Type
|
| 107 |
|
| 108 | `object` ([Details](meta-definitions-meta.md))
|
| 109 |
|
| 110 | ### title
|
| 111 |
|
| 112 | Extracted title of the document
|
| 113 |
|
| 114 |
|
| 115 | `title`
|
| 116 |
|
| 117 | - is optional
|
| 118 | - Type: `string`
|
| 119 | - cannot be null
|
| 120 | - defined in: [Section](meta-definitions-meta-properties-title.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/title")
|
| 121 |
|
| 122 | #### title Type
|
| 123 |
|
| 124 | `string`
|
| 125 |
|
| 126 | ### intro
|
| 127 |
|
| 128 | Extracted first paragraph of the document
|
| 129 |
|
| 130 |
|
| 131 | `intro`
|
| 132 |
|
| 133 | - is optional
|
| 134 | - Type: `string`
|
| 135 | - cannot be null
|
| 136 | - defined in: [Section](meta-definitions-meta-properties-intro.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/intro")
|
| 137 |
|
| 138 | #### intro Type
|
| 139 |
|
| 140 | `string`
|
| 141 |
|
| 142 | ### image
|
| 143 |
|
| 144 | Path (can be relative) to the first image in the document
|
| 145 |
|
| 146 |
|
| 147 | `image`
|
| 148 |
|
| 149 | - is optional
|
| 150 | - Type: `string`
|
| 151 | - cannot be null
|
| 152 | - defined in: [Section](meta-definitions-meta-properties-image.md "https://ns.adobe.com/helix/pipeline/section#/definitions/section/properties/image")
|
| 153 |
|
| 154 | #### image Type
|
| 155 |
|
| 156 | `string`
|
| 157 |
|
| 158 | #### image Constraints
|
| 159 |
|
| 160 | **URI reference**: the string must be a URI reference, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification")
|