| 1 | # Meta Schema
|
| 2 |
|
| 3 | ```txt
|
| 4 | https://ns.adobe.com/helix/pipeline/meta
|
| 5 | ```
|
| 6 |
|
| 7 | Content and Section Metadata Properties
|
| 8 |
|
| 9 |
|
| 10 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
| 11 | | :--------------------- | ---------- | ----------- | ----------------------- | :---------------- | --------------------- | ------------------- | ----------------------------------------------------------- |
|
| 12 | | Cannot be instantiated | Yes | Stabilizing | Unknown identifiability | Forbidden | Allowed | none | [meta.schema.json](meta.schema.json "open original schema") |
|
| 13 |
|
| 14 | ## Meta Type
|
| 15 |
|
| 16 | unknown ([Meta](meta.md))
|
| 17 |
|
| 18 | # Meta Definitions
|
| 19 |
|
| 20 | ## Definitions group meta
|
| 21 |
|
| 22 | Reference this group by using
|
| 23 |
|
| 24 | ```json
|
| 25 | {"$ref":"https://ns.adobe.com/helix/pipeline/meta#/definitions/meta"}
|
| 26 | ```
|
| 27 |
|
| 28 | | Property | Type | Required | Nullable | Defined by |
|
| 29 | | :------------------ | -------- | -------- | -------------- | :--------------------------------------------------------------------------------------------------------------------------------------- |
|
| 30 | | [class](#class) | `string` | Optional | cannot be null | [Meta](meta-definitions-meta-properties-class.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/class") |
|
| 31 | | [tagname](#tagname) | `string` | Optional | cannot be null | [Meta](meta-definitions-meta-properties-tagname.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/tagname") |
|
| 32 | | [types](#types) | `array` | Optional | cannot be null | [Meta](meta-definitions-meta-properties-types.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/types") |
|
| 33 | | [title](#title) | `string` | Optional | cannot be null | [Meta](meta-definitions-meta-properties-title.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/title") |
|
| 34 | | [intro](#intro) | `string` | Optional | cannot be null | [Meta](meta-definitions-meta-properties-intro.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/intro") |
|
| 35 | | [image](#image) | `string` | Optional | cannot be null | [Meta](meta-definitions-meta-properties-image.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/image") |
|
| 36 |
|
| 37 | ### class
|
| 38 |
|
| 39 | The CSS class to use for the section instead of the default `hlx-section` one
|
| 40 |
|
| 41 |
|
| 42 | `class`
|
| 43 |
|
| 44 | - is optional
|
| 45 | - Type: `string`
|
| 46 | - cannot be null
|
| 47 | - defined in: [Meta](meta-definitions-meta-properties-class.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/class")
|
| 48 |
|
| 49 | #### class Type
|
| 50 |
|
| 51 | `string`
|
| 52 |
|
| 53 | ### tagname
|
| 54 |
|
| 55 | The element tag name to use for the section instead of the default `div` one (i.e. `section`, `main`, `aside`)
|
| 56 |
|
| 57 |
|
| 58 | `tagname`
|
| 59 |
|
| 60 | - is optional
|
| 61 | - Type: `string`
|
| 62 | - cannot be null
|
| 63 | - defined in: [Meta](meta-definitions-meta-properties-tagname.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/tagname")
|
| 64 |
|
| 65 | #### tagname Type
|
| 66 |
|
| 67 | `string`
|
| 68 |
|
| 69 | ### types
|
| 70 |
|
| 71 | The inferred class names for the section
|
| 72 |
|
| 73 |
|
| 74 | `types`
|
| 75 |
|
| 76 | - is optional
|
| 77 | - Type: `string[]`
|
| 78 | - cannot be null
|
| 79 | - defined in: [Meta](meta-definitions-meta-properties-types.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/types")
|
| 80 |
|
| 81 | #### types Type
|
| 82 |
|
| 83 | `string[]`
|
| 84 |
|
| 85 | ### title
|
| 86 |
|
| 87 | Extracted title of the document
|
| 88 |
|
| 89 |
|
| 90 | `title`
|
| 91 |
|
| 92 | - is optional
|
| 93 | - Type: `string`
|
| 94 | - cannot be null
|
| 95 | - defined in: [Meta](meta-definitions-meta-properties-title.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/title")
|
| 96 |
|
| 97 | #### title Type
|
| 98 |
|
| 99 | `string`
|
| 100 |
|
| 101 | ### intro
|
| 102 |
|
| 103 | Extracted first paragraph of the document
|
| 104 |
|
| 105 |
|
| 106 | `intro`
|
| 107 |
|
| 108 | - is optional
|
| 109 | - Type: `string`
|
| 110 | - cannot be null
|
| 111 | - defined in: [Meta](meta-definitions-meta-properties-intro.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/intro")
|
| 112 |
|
| 113 | #### intro Type
|
| 114 |
|
| 115 | `string`
|
| 116 |
|
| 117 | ### image
|
| 118 |
|
| 119 | Path (can be relative) to the first image in the document
|
| 120 |
|
| 121 |
|
| 122 | `image`
|
| 123 |
|
| 124 | - is optional
|
| 125 | - Type: `string`
|
| 126 | - cannot be null
|
| 127 | - defined in: [Meta](meta-definitions-meta-properties-image.md "https://ns.adobe.com/helix/pipeline/meta#/definitions/meta/properties/image")
|
| 128 |
|
| 129 | #### image Type
|
| 130 |
|
| 131 | `string`
|
| 132 |
|
| 133 | #### image Constraints
|
| 134 |
|
| 135 | **URI reference**: the string must be a URI reference, according to [RFC 3986](https://tools.ietf.org/html/rfc4291 "check the specification")
|