Metadata

File

Configures which metadata fields from the file that can be added or edited in the user interface.

Consists of an array of objects. Each object corresponds to a single metadata field from the file.

If both exif and iptc are specified, iptc will be used if a value exist in the file, otherwise it will fall back to the exif value.

If neither exif or iptc is specified, an empty field will be rendered. This is useful for adding custom metadata that is not present in the file.

Allowed exif-tags

Allowed iptc-tags

Key

Type

Description

labelName

string

The label shown in the user interface

exif

string

The name of this metadata in the exif data of the file

iptc

string

The name of this metadata in the iptc data of the file

rows

number

The height of the edit field shown in the user interface

mapToMetadataName

string

The name of the field that will be used to save this metadata in OC

required

boolean

Should entering a value be required in the user interface

Example:

[
    {
        "labelName": "Photographer",
        "exif": "Artist",
        "iptc": "Byline",
        "rows": 1,
        "mapToMetadataName": "photographer",
        "required": false
    },
    {
        "labelName": "Photo credit",
        "iptc": "Credit",
        "rows": 1,
        "mapToMetadataName": "credit",
        "required": false
    },
    {
        "labelName": "Instructions",
        "iptc": "SpecialInstructions",
        "rows": 2,
        "mapToMetadataName": "instructions",
        "required": false
    },
    {
        "labelName": "Source",
        "iptc": "Source",
        "rows": 2,
        "mapToMetadataName": "source",
        "required": false
    },
    {
        "labelName": "Description",
        "exif": "ImageDescription",
        "iptc": "Caption",
        "rows": 10,
        "mapToMetadataName": "text",
        "required": false
    },
    {
        "labelName": "Alt text",
        "rows": 3,
        "mapToMetadataName": "altText",
        "required": false
    }
]

Concepts

Configures which concept types that can be added or edited in the user interface.

Consists of an array of objects.

Key

Type

Description

label

string

The label shown in the user interface

title

string

The text used in the concept search input. "Search {title}"

rel

string

The relation type

filters

array of objects

An object has a single key, "ConceptImTypeFull" with the concept type.

Example:

[
    {
        "label": "Author",
        "title": "author",
        "rel": "author",
        "filters": [
            {
                "ConceptImTypeFull": "x-im/author"
            }
        ]
    },
    {
        "label": "Tags",
        "title": "tags",
        "rel": "subject",
        "filters": [
            {
                "ConceptImTypeFull": "x-im/person"
            },
            {
                "ConceptImTypeFull": "x-im/organisation"
            },
            {
                "ConceptImTypeFull": "x-im/topic"
            }
        ]
    }
]

Last updated