Field definition

Field Id
Render type
Field label
Type URI
Help

Type URI

Type URI or CURIE. (If not specified, the URL of the type definition is used; a URI specified here ensures consistency of type information across Annalist instances.)

Property URI
annal:uri
Position/size
████████████ (0/12)
Superproperty URIs
(None specified)
Value type
annal:Identifier
Value mode
Entity type
annal:Type
Refer to type
(No 'Refer to type' selected)
Refer to field
 
Default value
 
Placeholder
(Type URI or CURIE)
Tooltip
Type URI or CURIE. (If not specified, the local URL of the type definition is used.)
Subfields
(None specified)
Add value label
Add
Remove value label
Remove
Value restriction
 
 
Choose view

Field definition view

Defines a field that may be used in a View, List or another Field definition.

Used to view Instances of record type View field (annal:Field).

Field definitions are a key element of Annalist mechanisms for presenting and editing data records. There are many fields, many of which used only in support of particular presentation options, and are otherwise ignored.

Common fields (applicable to all field render types)

Id:

Field identifier: used internally to identify a particular field definition, and also to name value fields on HTML forms used to present the data.

Field render type:

indicates a renderer that is used for presentation of this fields. The value selected here controls both the format of the stored data, and how it is presented on the form for editing and viewing. A list of available field render types can viewed at /annalist/c/Photo_collection/d/_enum_render_type/?scope=all

Label:

a short label used to describe this field.

Help:

a longer text description of this field. Intended to be used to generate online help messages to assist user data entry and field selection when designing entity views.

Property:

a URI or CURIE that is used as a key for the corresponding value in saved JSON data, and also as an property URI for data exported as RDF.

Position/Size:

indicates field placement on a displayed page. A number of options are presented, annoted with "(pos/wid)", "(pos/wid right)" or "(pos/wid column)". The placement is based on a 12-column grid, where pos is the start column for the field, and wid is the number of columns occupied on a medium or larger display. On small displays, all fields occupy the entire display width unless the placement includes the "columns" annotation. The "right" annotation is intended for right justification of columns that appear at the end of a row, but has been rarely used in practice.

Field value type:

A URI or CURIE for type of value displayed by this field.

For repeating value fields (render types Field group sequence, Field group sequence as table, Field group set or Field group set as table) and multifield reference fields (render type Fields of referenced entity), the value type specified is used to select applicable subfield options (i.e. subfields applicable to the specified entity type), and may be the same as the entity type of the containing field.

While currently used for selecting subfield options, this is also intended to provide additional information about the intended field values, and possibly to provide data type URIs for literals in JSON-LD/RDF data generated by Annalist.

Value mode:

indicates how the displayed value is accessed. One of Direct value, Entity reference, Field reference, Import from web, File upload. If in doubt, use Direct value.

Entity type:

Type (URI or CURIE) of entity type (or supertype) for which the field is applicable. Used to determine entities for which the field type is offered as an option. Leave blank if the field is to be available for all entity types.

Default:

Default value for this field. Leave blank if there is no default value.

Text entry fields

Placeholder:

String value used as a placeholder for text entry fields. Use this to proviode a prompt or example of input that may be entered. (The Annalist site data follows a convention of putting parentheses around placeholder text, but this is not a requirement.)

Entity reference fields

Some fields contain a cross-reference to another entity. The following apply to descriptions of such fields.

Refer to type:

Identifies a type in the current collection to whose instances the field value refers. Instances of this type are offered in a dropdown list for selection. (If subsequent deletion or renaming of a selected type means it no longer exists, the originally selected value is shown as _type/type_id.)

Refer to field:

The URI or CURIE of a property URI that keys a field of a referenced record. Ther indicated field is displayed when viewing an entity, but an entity selection dropdown is provided. (Not currently used - use of the Fields of referenced entity renderer is generally prefered.)

Value restriction:

a selection filter to restrict enumerated values (per 'annal:field_ref_type') that are candidate values for inclusion in the selction drop-down. This is a textual expression that defines selection criteria.

Example:

  entity[annal:view_entity_type] subtype [annal:field_entity_type]

The filter operates by comparing fields from a entity under consideration with a field from the containing entity, or from the view that is used to display it.

Selector formats:

  ALL (or blank)              match any entity
  <val1> == <val2>            values are the same.
  <val1> in <val2>            second value is list containing 1st value, or values are same, 
                              or <val1> is None.
  <val1> subtype <val2>       first value is a subtype of, or same type as, the second value.

<val1> and <val2> may be:

  [<field-id>]                tests a field of the entity under consideration for inclusion.
  entity[<field-id>]          refers to a field of containing entity.
  view[<field-id>]            refers to a field of the view definition currently displayed.
  field[<field-id>]           refers to the field definition for the current field.
  group[<field-id]            for subfields contained within a repeating field group, 
                              refers to a field of the repeating field group definition.
  "<string>"                  literal string value.  Quotes within are escaped.

values are URIs or CURIEs, using URI characters (per RFC3986), except that '[' and ']' are not allowed.

Repeating value fields

Subfields:

a list of sub-fields that are repeated within the containing field. Each field is described by a Subfield Id, and optional Subfield URI and Subfield Pos/size fields. If the optional values are not specified, corresponding values from the referenced subfield definition are used.

(The list of fields was previously defined via a reference to a field group, but that made defining certain form structures rather complex; this field includes referenced sub-fields directly in a field definition.)

Add fields label: a text label for the button used to add new repeating value entries.

Delete fields label: a text label for the button used to remove an existing entry.

Multi-field references

Subfields:

a list of sub-fields that are displayed from a referenced entity within the containing field. Each field is described by a Subfield Id, and optional Subfield URI and Subfield Pos/size fields. If the optional values are not specified, corresponding values from the referenced subfield definition are used.