Adobe 65007312 Programming Guide - Page 70

Metadata field entries, image's ID at an on-line service that is the export destination, or other

Get Adobe 65007312 - Photoshop Lightroom - Mac PDF manuals and user guides
UPC - 883919154398
View all Adobe 65007312 manuals
Add to My Manuals
Save this manual to your list of manuals

Page 70 highlights

CHAPTER 4: Working with Metadata Adding custom metadata 70 Metadata field entries Each of the entries in the metadataFieldsForPhotos array is a table that describes one metadata field; each metadata field describes a photo in the catalog. Each field can have only one value per photo. The following entries are recognized within each table: id version title dataType string Required. A unique identifier that allows a plug-in to access this field. The name must conform to the same naming conventions as Lua variables; that is, it must start with a letter, followed by letters or numbers, case is significant. number Optional. If present, defines a version number specifically for this field, distinct from the version number defined by schemaVersion in the outer metadata definition script. If you make a change to a field definition that is incompatible with the previous definition (for example, changing the value of searchable), you must bump the field's version number. A migration script can search for photos that contain the old version of the field and manually migrate values. string Optional. If this field is displayed in the Metadata panel, this is the localizable display name. This name should be relatively short, since space in the Metadata panel is at a premium. A name longer than about 100 pixels is likely to be truncated on display; however, the full text is shown in the tooltip when the cursor hovers over the name. If this item is omitted, the field does not appear in the Metadata panel. This can be useful for storing private, per-image plug-in information, such as the image's ID at an on-line service that is the export destination, or other cross-reference information. string Optional. If this field is present, Lightroom disallows any other data type from being stored in this field. Nil is always permitted. You cannot require that a field have a value. The value is one of these strings: string - The field value must have a string value. enum - The field value must have one of the allowed values specified in the values entry. In the Metadata panel, allowed values are shown as a pop-up menu for the field. url - The field value must have a string value. In the Metadata panel, the text field is acccompanied by a button that treats the text value as a URL, opening it in the user's preferred web browser.

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
C
HAPTER
4: Working with Metadata
Adding custom metadata
70
Metadata field entries
Each of the entries in the
metadataFieldsForPhotos
array is a table that describes one metadata field;
each metadata field describes a photo in the catalog. Each field can have only one value per photo. The
following entries are recognized within each table:
id
string
Required. A unique identifier that allows a plug-in to access this field. The
name must conform to the same naming conventions as Lua variables; that is,
it must start with a letter, followed by letters or numbers, case is significant.
version
number
Optional. If present, defines a version number specifically for this field, distinct
from the version number defined by
schemaVersion
in the outer metadata
definition script.
If you make a change to a field definition that is incompatible with the
previous definition (for example, changing the value of
searchable
), you
must bump the field's version number. A migration script can search for
photos that contain the old version of the field and manually migrate values.
title
string
Optional. If this field is displayed in the Metadata panel, this is the localizable
display name. This name should be relatively short, since space in the
Metadata panel is at a premium. A name longer than about 100 pixels is likely
to be truncated on display; however, the full text is shown in the tooltip when
the cursor hovers over the name.
If this item is omitted, the field does not appear in the Metadata panel. This
can be useful for storing private, per-image plug-in information, such as the
image’s ID at an on-line service that is the export destination, or other
cross-reference information.
dataType
string
Optional. If this field is present, Lightroom disallows any other data type from
being stored in this field. Nil is always permitted. You cannot require that a
field have a value.
The value is one of these strings:
string
— The field value must have a string value.
enum
— The field value must have one of the allowed values specified in
the
values
entry. In the Metadata panel, allowed values are shown as a
pop-up menu for the field.
url
— The field value must have a string value. In the Metadata panel, the
text field is acccompanied by a button that treats the text value as a URL,
opening it in the user’s preferred web browser.