plugin:struct:type
This is an old revision of the document!
Table of Contents
Struct Plugin: Types
Types are used when defining schemas. Each field in the schema has to have a type. It configures what data is accepted in the field and how it will be displayed later on.
Available Types
Additional types can be defined by plugins.
Configuration
Each type has its own specific configuration options described on the type's own page linked above. In addition there are some configuration elements available to each type described here:
| Config | Format | Description |
|---|---|---|
| label | array of strings | This array contains keys for all languages available in the wiki (as defined by the translation plugin). You can use this to set translated labels for the field. These are used when showing the data or displaying the data editor. It's recommended to use short, rarely changing field names and set speaking names through this mechanism. |
| hint | array of strings | Similar to the label field but can be used to give some more detailed info about how to fill the field in question. Shown as tooltip. |
| visibility → inpage | boolean | When disabled, empty fields will not be displayed in the struct banner of the page. |
| visibility → ineditor | boolean | When disabled, the field will not be displayed when editing the page. Data can be entered only through a bureaucracy form or in aggregations. |
plugin/struct/type.1680545167.txt.gz · Last modified: 2023-04-03 20:06 by annda