-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: add system metadata plugins release info
- Loading branch information
1 parent
f7bd32c
commit ace941a
Showing
9 changed files
with
298 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
43 changes: 43 additions & 0 deletions
43
content/reference/document/metadata/plugins/li-system-boolean.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| --- | ||
| title: li-system-boolean | ||
| type: metadata-plugins | ||
| menus: | ||
| reference: | ||
| parent: Metadata Plugins List | ||
| summary: A simple Boolean value store as system metadata, represented in the UI with a checkbox which you can toggle on/off. | ||
| support: | ||
| document: true | ||
| media: false | ||
| include: false | ||
| creationFlow: false | ||
| pushMessage: false | ||
| tableDashboard: true | ||
| displayFilter: false | ||
| searchIndexing: true | ||
| systemMetadata: true | ||
| planningSystem: false | ||
| webhookConditions: true | ||
| description: | | ||
| A simple Boolean value store, almost identical to `li-boolean`, but as system metadata (does not indicate a draft content change). | ||
| {{< added-in "release-2025-01" >}}. | ||
| Represented in the UI with a checkbox which you can toggle on/off. | ||
| If you want to have the value set to `true` during document creation, you can do that via [defaultMetadata]({{< ref "/reference/project-config/content-types#default-metadata" >}}) in your project config. | ||
| defaultUI: Checkbox | ||
| storageFormat: <Boolean> | ||
| contentTypeConfig: |2 | ||
| handle: 'myHandle' | ||
| type: 'li-system-boolean', | ||
| config: { | ||
| // common | ||
| hideFromForm: false, // optional, default: false | ||
| index: true // optional, default: false | ||
| } | ||
| ui: { | ||
| label: 'foo', // optional, default: start case of handle | ||
| config: { | ||
| readOnly: true // optional, default: false | ||
| } | ||
| } | ||
| --- |
39 changes: 39 additions & 0 deletions
39
content/reference/document/metadata/plugins/li-system-date.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| --- | ||
| title: li-system-date | ||
| type: metadata-plugins | ||
| menus: | ||
| reference: | ||
| parent: Metadata Plugins List | ||
| summary: | ||
| support: | ||
| document: true | ||
| media: false | ||
| include: false | ||
| creationFlow: false | ||
| pushMessage: false | ||
| tableDashboard: false | ||
| displayFilter: false | ||
| searchIndexing: true | ||
| systemMetadata: true | ||
| planningSystem: false | ||
| webhookConditions: true | ||
| defaultUI: Date input field as system metadata | ||
| storageFormat: <ISO8601 String> | ||
| contentTypeConfig: |2 | ||
| handle: 'myHandle', | ||
| type: 'li-system-date', | ||
| config: { | ||
| // common | ||
| hideFromForm: false, // optional, default: false | ||
| required: true, // optional, default: false | ||
| requiredErrorMessage: 'Provide a value', // optional | ||
| translatable: false, // optional, default: false | ||
| index: true // optional, default: false | ||
| }, | ||
| ui: { | ||
| label: 'foo', // optional, takes camelized name otherwise | ||
| config: { | ||
| readOnly: true // optional, default: false | ||
| } | ||
| } | ||
| --- |
38 changes: 38 additions & 0 deletions
38
content/reference/document/metadata/plugins/li-system-datetime.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| title: li-system-datetime | ||
| type: metadata-plugins | ||
| menus: | ||
| reference: | ||
| parent: Metadata Plugins List | ||
| summary: | ||
| support: | ||
| document: true | ||
| media: true | ||
| include: true | ||
| creationFlow: true | ||
| pushMessage: true | ||
| tableDashboard: false | ||
| displayFilter: false | ||
| searchIndexing: true | ||
| systemMetadata: true | ||
| planningSystem: false | ||
| webhookConditions: true | ||
| defaultUI: A datetime input as system metadata | ||
| storageFormat: <ISO8601 String> | ||
| contentTypeConfig: |2 | ||
| handle: 'myHandle' | ||
| type: 'li-system-datetime', | ||
| config: { | ||
| // common | ||
| hideFromForm: false, // optional, default: false | ||
| required: true, // optional, default: false | ||
| requiredErrorMessage: 'Provide a value', // optional | ||
| index: true // optional, default: false | ||
| }, | ||
| ui: { | ||
| label: 'foo', // optional, takes camelized name otherwise | ||
| config: { | ||
| readOnly: true // optional, default: false | ||
| } | ||
| } | ||
| --- |
55 changes: 55 additions & 0 deletions
55
content/reference/document/metadata/plugins/li-system-enum.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| --- | ||
| title: li-system-enum | ||
| type: metadata-plugins | ||
| menus: | ||
| reference: | ||
| parent: Metadata Plugins List | ||
| summary: A select form based on a statically defined list. | ||
| support: | ||
| document: true | ||
| media: false | ||
| include: false | ||
| creationFlow: false | ||
| pushMessage: false | ||
| tableDashboard: false | ||
| displayFilter: true | ||
| searchIndexing: true | ||
| systemMetadata: true | ||
| planningSystem: false | ||
| webhookConditions: true | ||
| description: | | ||
| A `li-system-enum` metadata field shows a select form based on a statically defined list. On publish the selected value gets validated against the defined static list. With that you can assure that only specific values gets published. | ||
| [Display Filters]({{< ref "/customising/advanced/editor-configuration/display-filter#metadata-filters" >}}) support {{< added-in "release-2023-09" >}} | ||
| defaultUI: | | ||
| Select input | ||
|  | ||
| storageFormat: <String> | ||
| contentTypeConfig: |2 | ||
| handle: 'myHandle' | ||
| type: 'li-system-enum', | ||
| config: { | ||
| // common | ||
| hideFromForm: false, // optional, default: false | ||
| required: true, // optional, default: false | ||
| requiredErrorMessage: 'Provide a value', // optional | ||
| index: true, // optional, default: false | ||
| // specific | ||
| dataProvider: { // required | ||
| type: 'labelValuePair', // required | ||
| items: [ | ||
| {label: 'Tag A', value: 'a'}, | ||
| {label: 'Tag B', value: 'b', isDefault: true}, // isDefault sets the value if document opened the first time | ||
| {label: 'Tag C', value: 'c'} | ||
| ] | ||
| } | ||
| }, | ||
| ui: { | ||
| label: 'foo', // optional, takes camelized name otherwise | ||
| config: { | ||
| readOnly: true, // optional, default: false | ||
| placeholder: 'foo' // optional, takes camelized name otherwise | ||
| } | ||
| } | ||
| --- |
56 changes: 56 additions & 0 deletions
56
content/reference/document/metadata/plugins/li-system-integer.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| --- | ||
| title: li-system-integer | ||
| type: metadata-plugins | ||
| menus: | ||
| reference: | ||
| parent: Metadata Plugins List | ||
| support: | ||
| document: true | ||
| media: true | ||
| include: true | ||
| creationFlow: true | ||
| pushMessage: true | ||
| tableDashboard: true | ||
| displayFilter: true | ||
| searchIndexing: true | ||
| systemMetadata: true | ||
| planningSystem: false | ||
| webhookConditions: true | ||
| defaultUI: | | ||
| * Renders a number input. | ||
| * No UI is rendered if the `handle` is `lastProofreadRevision`. | ||
| * {{< added-in "release-2023-03" >}}: Renders a select element if a `dataProvider` is configured | ||
| storageFormat: <Integer> | ||
| contentTypeConfig: |2 | ||
| handle: 'myHandle' | ||
| type: 'li-system-integer', | ||
| config: { | ||
| // common | ||
| hideFromForm: false, // optional, default: false | ||
| required: true, // optional, default: false | ||
| requiredErrorMessage: 'Provide a value', // optional | ||
| index: true, // optional, default: false | ||
| // specific | ||
| minValue: 1, // optional | ||
| maxValue: 50, // optional | ||
| translatable: true, // optional, default: false, translations are only supported for data-record and mediaLibrary | ||
| dataProvider: { // optional. {{< added-in "release-2023-03" >}} | ||
| // Option 1 - list of items | ||
| type: 'labelValuePair', | ||
| items: [ | ||
| {label: 'A', value: 1}, | ||
| {label: 'B', value: 2, isDefault: true}, // isDefault sets the value if document opened the first time | ||
| {label: 'C', value: 3} | ||
| ] | ||
| // Option 2 - DataSource | ||
| dataSource: 'labelValuePairDataSource' | ||
| } | ||
| }, | ||
| ui: { | ||
| label: 'foo', // optional, takes camelized name otherwise | ||
| config: { | ||
| placeholder: 'bar', // optional, takes camelized name otherwise | ||
| readOnly: true // optional, default: false | ||
| } | ||
| } | ||
| --- |
52 changes: 52 additions & 0 deletions
52
content/reference/document/metadata/plugins/li-system-target-length.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| --- | ||
| title: li-system-target-length | ||
| type: metadata-plugins | ||
| menus: | ||
| reference: | ||
| parent: Metadata Plugins List | ||
| summary: Provide a suggested total character count for the text in the document. | ||
| support: | ||
| document: true | ||
| media: false | ||
| include: false | ||
| creationFlow: false | ||
| pushMessage: false | ||
| tableDashboard: false | ||
| displayFilter: false | ||
| searchIndexing: false | ||
| systemMetadata: true | ||
| planningSystem: false | ||
| description: | | ||
| This plugin is used to provide a suggested total character count for the text in the document. | ||
| defaultUI: | | ||
| **Input**: Number input, or slider if `steps` are defined. | ||
| **Editor**: Difference, Total Characters, Target Range, Characters in Focussed Component | ||
| {{< img src="../images/li-target-length.png" alt="Target Length Indicator" >}} | ||
| storageFormat: | | ||
| { | ||
| characters: <Integer> | ||
| } | ||
| contentTypeConfig: |2 | ||
| handle: 'myHandle' | ||
| type: 'li-system-target-length', | ||
| ui: { | ||
| config: { | ||
| acceptedCharacterDifference: 20, // Range above and below `value` considered accepted | ||
| // optional, allows picking a step instead of entering an exact number | ||
| steps: [ | ||
| { | ||
| label: 'S', // use a short one, e.g. "S" "M" "L" | ||
| value: 100 // number of characters | ||
| }, | ||
| { | ||
| label: 'M', | ||
| value: 200 | ||
| } | ||
| ], | ||
| // optional, allows the input of an exact number besides picking a step | ||
| allowAnyNumber: true | ||
| } | ||
| } | ||
| --- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters