-
Notifications
You must be signed in to change notification settings - Fork 3
/
m3.yml
210 lines (197 loc) · 8.4 KB
/
m3.yml
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
205
206
207
208
209
210
#-------------------
# M3 Metadata Model
#-------------------
#---------------------------------------------------------
# Profile Information
#---------------------------------------------------------
# Administrative information about the profile or model defined in the file.
#
# profile:
# responsibility: uri for the organization or individual responsible for maintaining the profile
# responsibility_statement: statement of the organization or individual responsible for maintaining the profile
# date_modified: the date the profile was last altered
# type: type of thing does the profile describe
# version: version of the profile
m3_version: "1.0.beta2"
profile:
responsibility: https://wiki.duraspace.org/display/samvera/Samvera+Metadata+Interest+Group
responsibility_statement: Samvera Metadata Interest Group
date_modified: "2019-07-03"
type: metadata models
version: 0.8
#---------------------------------------------------------
# Mapping Definitions
#---------------------------------------------------------
# Definition of the mappings to different services or target schemas referenced in the profile.
#
# mappings:
# prefix: the abbreviation used to indicate the mapping target
# name: a fuller name of the mapping
mappings:
dpla:
name: Digital Public Library of America
datacite:
name: DataCite
dc:
name: Dublin Core
#---------------------------------------------------------
# Class Definitions
#---------------------------------------------------------
# Definition of the classes used in the profile.
#
# classes:
# class_name: Stable generic local name for the class.
# display_label: Human-readable label for the class.
# schema_uri: URI for the class, from a local or shared ontology.
classes:
genericWork:
display_label: "Generic Work"
contexts: ["department_y"]
collection:
display_label: "Collection"
agent:
display_label: "Agent"
schema_uri: http://id.loc.gov/ontologies/bibframe/Agent
contexts:
project_x:
display_label: "Project X"
department_y:
display_label: "Department Y"
#---------------------------------------------------------
# Property Definitions
#---------------------------------------------------------
# Definition of the properties used in the model.
#
# properties:
# property_name: Stable generic local name for the property.
# display_label: Human-readable label for the property. Context specific display_labels provided as a list using the class and value.
# default: Default display label.
# MyCustomWorkType: Context dependent display label.
# definition: The definition for the metadata property being described.
# default: Default definition.
# MyCustomWorkType: Context dependent definition.
# usage_guidelines: Description of how the defined property should be used (helper text, hints, deposit text, etc.)
# default: Default usage guidelines.
# MyCustomWorkType: Context dependent usage guidelines.
# requirement: Whether the property is required, optional, recommended, etc. from a best practices standpoint.
# controlled_values:
# format: Controlled vocabulary constraint on the property's value.
# sources: Link to a controlled vocabulary source list or file path to a config file listing accepted values.
# - value 1
# - value 2
# sample_value: Example value(s) for the property.
# property_uri: URI for the property, from a local or shared ontology.
# available_on: The objects and/or work types is this property available on (defined in "class definitions" section.)
# - collection
# - MyCustomWorkType
# range: Class constraint on the property's value. If there is no value provided, the assumed default range is http://www.w3.org/2000/01/rdf-schema#Literal
# data_type: Type constraint on the property's value. If there is no value provided, the assumed default data_type is http://www.w3.org/2001/XMLSchema#string. If multiple data types are possible, general best practice is to use the most specific type that applies to all values. If multiple types are listed, the lowest common denominator will be used for validation.
# syntax: Syntax standard constraint on the property's value (e.g. edtf.)
# cardinality: System cardinality and obligation.
# minimum: Minimum number of values the property must have. If there is no value provided, the assumed default minimum is 0.
# maximum: Maximum number of values the property may have. If there is no value provided, the assumed default maximum is unlimited.
# index_documentation: Free text documentation field about whether a property should be faceted, searchable, displayable, treated as text, etc.
# indexing: a list of dynamic field names, taken from a controlled list;
# Choose a value from this list.
# displayable - store as string, multi-valued
# facetable - index as a string, multi-valued
# searchable - index the specific data type, multi-valued
# sortable - index the specific data type
# stored_searchable - index and store the specific data type, multi-valued
# stored_sortable - index and store as string
# symbol - index and store as string, multi-valued
# fulltext_searchable - index as text, multi-valued with termVectors if enabled
# The consuming application is expected to use this information in conjunction with data types to determine the precise indexing strategy.
# validations:
# match_regex: Regular Expression pattern each value must match to be valid.
# mapping: A pair value defining the target property for a mapping (defined in "mapping definitions" section.)
# dpla : URI for target property
# datacite : URI for target property
# The following are example property definitions:
properties:
creator:
display_label:
default: "Creator(s)"
definition:
default: "A person or organization responsible for creating the resource."
usage_guidelines:
default: "Record in lastname, firstname order."
requirement: "recommended, if applicable"
# controlled_value:
# format: http://www.w3.org/2001/XMLSchema#anyURI
# sources:
# - "/qa/terms/local/roles/"
sample_value:
- Smith, John
property_uri: http://purl.org/dc/elements/1.1/creator
available_on:
class:
- collection
- genericWork
context:
- department_y
range: http://www.w3.org/2000/01/rdf-schema#Literal
data_type: http://www.w3.org/2001/XMLSchema#string
cardinality:
minimum: 0
maximum: 100
index_documentation: "searchable, displayable, creator facet"
indexing:
- "stored_searchable"
- "facetable"
- "displayable"
mapping:
dpla: http://purl.org/dc/elements/1.1/creator
date_created:
display_label:
default: "Date Created"
definition:
default: "The date on which the work was created."
usage_guidelines:
default: "Enter in yyyy-mm-dd format."
requirement: recommended
sample_value:
- "2019-04-11"
property_uri: http://purl.org/dc/terms/created
available_on:
class:
- genericWork
range: http://www.w3.org/2000/01/rdf-schema#Literal
data_type: http://www.w3.org/2001/XMLSchema#date
syntax: edtf
cardinality:
minimum: 0
index_documentation: "Date created should be indexed as a searchable, displayable, and facetable field."
indexing:
- "stored_searchable"
- "facetable"
- "displayable"
validations:
match_regex: "[\\d]{4}"
mapping:
dpla: "http://purl.org/dc/elements/1.1/date"
title:
display_label:
default: "Title"
definition:
default: "A name to aid in identifying a work or collection."
collection: "A name to aid in identifying the Administrative Set and to distinguish it from other Administrative Sets in the repository."
requirement: required
sample_value:
- "On the Road"
property_uri: http://purl.org/dc/terms/title
available_on:
class:
- genericWork
- collection
range: http://www.w3.org/2000/01/rdf-schema#Literal
data_type: http://www.w3.org/2001/XMLSchema#string
cardinality:
minimum: 1
maximum: 1
index_documentation: "Title should be indexed as searchable and displayable."
indexing:
- "stored_searchable"
- "displayable"
mapping:
dpla: "http://purl.org/dc/terms/title"