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