| 1 |
|
| 2 |
Field Configuration Spec |
| 3 |
======================== |
| 4 |
|
| 5 |
The following are system reserved field metadata keys: |
| 6 |
|
| 7 |
- type |
| 8 |
- name (optional) |
| 9 |
- idname (auto-generated based on name) |
| 10 |
- default (optional) |
| 11 |
- label (optional) |
| 12 |
- desc (optional) |
| 13 |
- form (internal) |
| 14 |
- cleanup (optional) |
| 15 |
- checks (optional) |
| 16 |
- rendering (optional) |
| 17 |
|
| 18 |
Field detection |
| 19 |
--------------- |
| 20 |
|
| 21 |
If an array inside the dedicated fields configuration block has the "type" |
| 22 |
key it is considered to be a field configuration regardless of where it is |
| 23 |
inside the configuration (since fields may have other fields as children |
| 24 |
that themselves have other fields, etc). |
| 25 |
|
| 26 |
Field name |
| 27 |
---------- |
| 28 |
|
| 29 |
The key pointing to a field configuration is considered the name of the |
| 30 |
field unless a the optional key "name" is provided. If neither is available |
| 31 |
or the name key is empty the field is considered esthetic and while it will |
| 32 |
be processed by the rendering routines it won't be processed by the data |
| 33 |
handling routines (since it's not a named entity). |
| 34 |
|
