Skip to content

Commit c5083c1

Browse files
committed
rename URI to "field name" across site
Following up on work done in #95
1 parent aba5b99 commit c5083c1

6 files changed

Lines changed: 47 additions & 50 deletions

File tree

docs/aardvark-gbl-1-crosswalk.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The following chart shows the full Aardvark schema and which GBL 1.0 fields can
77

88
## Elements without a crosswalk
99

10-
Most of the elements from GBL 1.0 can be crosswalked directly into OGM Aardvark. The values for these elements are the same - only the URI name has changed or the field has been converted to an array.
10+
Most of the elements from GBL 1.0 can be crosswalked directly into OGM Aardvark. The values for these elements are the same - only the field name has changed or the field has been converted to an array.
1111

1212
However, there are three elements in GBL 1.0 that do not directly translate into OGM Aardvark. While they have been replaced with similar fields in OGM Aardvark, the **values themselves** would need to be altered during crosswalking.
1313

@@ -24,4 +24,4 @@ However, there are three elements in GBL 1.0 that do not directly translate into
2424
**Is Part Of (`dct_isPartOf_sm`)**
2525

2626
* GBL 1.0 Description: This multi-valued GBL 1.0 plain text field is for writing out the name of a collection. Example: `dct_isPartOf_sm:"Village Maps of India"`
27-
* Similar Aardvark element: The URI is the same in Aardvark, but it is now a non-literal field. The value must be one or more IDs that reference another record within the system. Example: `dct_isPartOf_sm:"princeton-z603r079s"`
27+
* Similar Aardvark element: The field name is the same in Aardvark, but it is now a non-literal field. The value must be one or more IDs that reference another record within the system. Example: `dct_isPartOf_sm:"princeton-z603r079s"`

docs/about-ogm-aardvark.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Details about the OpenGeoMetadata metadata schema, OGM Aardvark
1515
* **GBL 1.0**: The legacy metadata schema designed for GeoBlacklight versions 2.0-3.7. [The schema is documented on this Legacy page.](gbl-1.0.md)
1616
* **OGM Aardvark**: The new metadata schema that is compatible with GeoBlacklight version 4.0.
1717
* **GeoBlacklight**: When spelled out, GeoBlacklight refers to [the application itself](https://geoblacklight.org), not its namesake legacy metadata schema, GBL 1.0.
18-
* **URI**: This is the name we give to the metadata element itself. For example, the URI for the Subject field is `dct_subject_sm`.
19-
* **Namespace**: This is how we signify which family of standards or schemas an element belongs to. For the GeoBlacklight schema, this takes the form of the URI’s prefix. For the URI `dct_subject_sm`, `dct_` is the prefix and signifies that this element is from Dublin Core.
20-
* **Solr field type**: This is the suffix appended to the URI and indicates what kind of Solr field should be indexed. For `dct_subject_sm`, the `_sm` stands for String Multiple. It indicates that the field type is a string and that it can have multiple values.
18+
* **Field name**: This is the name we give to the metadata element itself. For example, the field name for the Subject field is `dct_subject_sm`.
19+
* **Namespace**: This is how we signify which family of standards or schemas an element belongs to. For the GeoBlacklight schema, this takes the form of the field name's prefix. For `dct_subject_sm`, `dct_` is the prefix and signifies that this element is from Dublin Core.
20+
* **Solr field type**: This is the suffix appended to the field name and indicates what kind of Solr field should be indexed. For `dct_subject_sm`, the `_sm` stands for String Multiple. It indicates that the field type is a string and that it can have multiple values.
2121
* **Value**: This is the information that is entered in a field. It may be free text (literal value) or a URI/code (nonliteral value).
2222

2323
OGM Aardvark is a discovery metadata schema for geospatial resources. It was intentionally developed with cross-application in mind and can be used to describe geospatial assets of all kinds.
@@ -56,7 +56,7 @@ The minimal nature of the original GeoBlacklight schema combined with the growin
5656

5757
The new set of rights elements are:
5858

59-
| Label | URI | Description and Entry Guidelines |
59+
| Label | Field Name | Description and Entry Guidelines |
6060
|:-------------------|:------------------------|:---------------------------------|
6161
| Access Rights | `dct_accessRights_s` | One of two possible values, "Public" or "Restricted"; controls whether a user can preview or download an item. This element replaces `dc_rights_s`. |
6262
| Rights | `dct_rights_sm` | Free-text field for generic, catch-all access and usage rights. Can include clickable links. |
@@ -73,7 +73,7 @@ GeoBlacklight version 3.4 and earlier has an Item Relations widget that displays
7373

7474
The new set of relationship elements are:
7575

76-
| Label | URI | Description and Entry Guidelines |
76+
| Label | Field Name | Description and Entry Guidelines |
7777
|:-------------------|:------------------------|:---------------------------------|
7878
| Source | `dct_source_sm` | For items that have been derived from another item (e.g. a digitized shapefile from a historical map). |
7979
| Is Part Of | `dct_isPartOf_sm` | For items that are a subset of another item (e.g. a page in a book). This value type is changing from free-text in Version 1.0 to an ID (slug) in the new schema. |
@@ -84,7 +84,7 @@ The new set of relationship elements are:
8484
| Relation | `dct_relation_sm` | For a general purpose relation. |
8585

8686

87-
#### Consistent namespaces for all metadata element URIs
87+
#### Consistent namespaces for all metadata element field names
8888

8989
OGM Aardvark gives preference to elements found in established schemas over custom fields.
9090

@@ -96,7 +96,7 @@ OGM Aardvark gives preference to elements found in established schemas over cust
9696

9797
#### Multivalued elements whenever possible
9898

99-
The original schema features several descriptive metadata fields that only accept one value. The new schema expands many of these to multiple. This changes the URI suffix from `_s` to` _sm`. Although it will not affect the GeoBlacklight functionality, this practice may conflict with indexing, as Solr will treat `dct_publisher_s` as a different field than `dct_publisher_sm`.
99+
The original schema features several descriptive metadata fields that only accept one value. The new schema expands many of these to multiple. This changes the field name suffix from `_s` to` _sm`. Although it will not affect the GeoBlacklight functionality, this practice may conflict with indexing, as Solr will treat `dct_publisher_s` as a different field than `dct_publisher_sm`.
100100

101101
#### More intuitive name for unique key
102102

@@ -158,6 +158,3 @@ Refinements to OpenGeoMetadata have continued through the work of the ongoing Me
158158
* Lena Denis (Johns Hopkins University)
159159
* Marc McGee (Harvard University)
160160
* Rebecca Seifried (UMass Amherst)
161-
162-
163-

docs/gbl-1.0.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ hide:
99
---
1010

1111

12-
| Label | URL | Required | Recommended |
12+
| Label | Field Name | Required | Recommended |
1313
|:----------------------------------|:-----------------------|:--------:|:-----------:|
1414
| [Identifier](#identifier) | `dc_identifier_s` | X | |
1515
| [Rights](#rights) | `dc_rights_s` | X | |
@@ -43,7 +43,7 @@ hide:
4343

4444
| Label | Identifier|
4545
|:----------------------|:-----------|
46-
| uri | `dc_identifier_s`|
46+
| Field Name | `dc_identifier_s`|
4747
| Required | yes|
4848
| Type | string|
4949
| Description | Unique identifier for layer as a URI. It should be globally unique across all institutions, assumed not to be end-user visible|
@@ -58,7 +58,7 @@ hide:
5858

5959
| Label | Rights|
6060
|:----------------------|:-----------|
61-
| uri | `dc_rights_s`|
61+
| Field Name | `dc_rights_s`|
6262
| Required | yes|
6363
| Type | string|
6464
| Description | Signals access in the geoportal and is indicated by a padlock icon. Users need to sign in to download restricted items|
@@ -72,7 +72,7 @@ hide:
7272

7373
| Label | Title|
7474
|:----------------------|:-----------|
75-
| uri | `dc_title_s`|
75+
| Field Name | `dc_title_s`|
7676
| Required | yes|
7777
| Type | string|
7878
| Description | The name of the resource|
@@ -86,7 +86,7 @@ hide:
8686

8787
| Label | Provenance|
8888
|:----------------------|:-----------|
89-
| uri | `dct_provenance_s`|
89+
| Field Name | `dct_provenance_s`|
9090
| Required | yes|
9191
| Type | string|
9292
| Description | The name of the institution that holds the resource or acts as the custodian for the metadata record|
@@ -100,7 +100,7 @@ hide:
100100

101101
| Label | Schema Version|
102102
|:----------------------|:-----------|
103-
| uri | `geoblacklight_version` |
103+
| Field Name | `geoblacklight_version` |
104104
| Required | yes|
105105
| Type | string|
106106
| Description | Indicates which version of the GeoBlacklight schema is in use|
@@ -114,7 +114,7 @@ hide:
114114

115115
| Label | Slug|
116116
|:----------------------|:-----------|
117-
| uri | `layer_slug_s`|
117+
| Field Name | `layer_slug_s`|
118118
| Required | yes|
119119
| Type | string|
120120
| Description | This is a string appended to the base URL of a GeoBlacklight installation to create a unique landing page for each resource. It is visible to the user and serves the purpose of forming a persistent URL for each catalog item.|
@@ -128,7 +128,7 @@ hide:
128128

129129
| Label | Bounding Box|
130130
|:----------------------|:-----------|
131-
| uri | `solr_geom`|
131+
| Field Name | `solr_geom`|
132132
| Required | yes|
133133
| Type | string|
134134
| Description | The rectangular extents of the resource. Note that this field is indexed as a Solr spatial (RPT) field|
@@ -142,7 +142,7 @@ hide:
142142

143143
| Label | Solr Year|
144144
|:----------------------|:-----------|
145-
| uri | `solr_year_i`|
145+
| Field Name | `solr_year_i`|
146146
| Required | no|
147147
| Type | integer|
148148
| Description | A four digit integer representing a year of temporal coverage or date issued for the resource. This field is used to populate the Year facet and the optional [Blacklight Range Limit gem](https://github.com/projectblacklight/blacklight_range_limit)|
@@ -156,7 +156,7 @@ hide:
156156

157157
| Label | Creator|
158158
|:----------------------|:-----------|
159-
| uri | `dc_creator_sm`|
159+
| Field Name | `dc_creator_sm`|
160160
| Required | no|
161161
| Type | array|
162162
| Description | The person(s) or organization that created the resource|
@@ -170,7 +170,7 @@ hide:
170170

171171
| Label| Description|
172172
|:----------------------|:-----------|
173-
| uri | `dc_description_s`|
173+
| Field Name | `dc_description_s`|
174174
| Required | no|
175175
| Type | string|
176176
| Description | At minimum, this is a reiteration of the title in sentence format. Other relevant information, such as data creation methods, data sources, and special licenses, may also be included.|
@@ -184,7 +184,7 @@ hide:
184184

185185
| Label | Format|
186186
|:----------------------|:-----------|
187-
| uri | `dc_format_s`|
187+
| Field Name | `dc_format_s`|
188188
| Required | yes, if download link is included AND if download URL is configured as a single key:value pair|
189189
| Type | string|
190190
| Description | This indicates the file format of the data. If a download link is included, this value displays on the item page in the button under the download widget|
@@ -198,7 +198,7 @@ hide:
198198

199199
| Label | Language|
200200
|:----------------------|:-----------|
201-
| uri | `dc_language_sm`|
201+
| Field Name | `dc_language_sm`|
202202
| Required | no|
203203
| Type | array|
204204
| Description | Indicates the language of the data or map|
@@ -212,7 +212,7 @@ hide:
212212

213213
| Label | Publisher|
214214
|:----------------------|:-----------|
215-
| uri | `dc_publisher_s`|
215+
| Field Name | `dc_publisher_s`|
216216
| Required | no|
217217
| Type | array|
218218
| Description | The organization that made the original resource available|
@@ -226,7 +226,7 @@ hide:
226226

227227
| Label | Source|
228228
|:----------------------|:-----------|
229-
| uri | `dc_source_sm`|
229+
| Field Name | `dc_source_sm`|
230230
| Required | no|
231231
| Type | array|
232232
| Description | This is used to indicate parent/child relationships between data layers and activates the Data Relations widget in GeoBlacklight|
@@ -240,7 +240,7 @@ hide:
240240

241241
| Label | Subject|
242242
|:----------------------|:-----------|
243-
| uri | `dc_subject_sm`|
243+
| Field Name | `dc_subject_sm`|
244244
| Required | no|
245245
| Type | array|
246246
| Description | These are theme or topic keywords|
@@ -254,7 +254,7 @@ hide:
254254

255255
| Label | Type|
256256
|:----------------------|:-----------|
257-
| uri | `dc_type_s`|
257+
| Field Name | `dc_type_s`|
258258
| Required | no|
259259
| Type | string|
260260
| Description | This is a general element to indicate the larger genre of the resource|
@@ -268,7 +268,7 @@ hide:
268268

269269
| Label | Is Part Of|
270270
|:----------------------|:-----------|
271-
| uri | `dct_isPartOf_sm`|
271+
| Field Name | `dct_isPartOf_sm`|
272272
| Required | no|
273273
| Type | array|
274274
| Description | Holding entity for the layer, such as the title of a collection|
@@ -282,7 +282,7 @@ hide:
282282

283283
| Label | Date Issued|
284284
|:----------------------|:-----------|
285-
| uri | `dct_issued_s`|
285+
| Field Name | `dct_issued_s`|
286286
| Required | no|
287287
| Type | string|
288288
| Description | This is the publication date for the resource|
@@ -296,7 +296,7 @@ hide:
296296

297297
| Label | References|
298298
|:----------------------|:-----------|
299-
| uri | `dct_references_s`|
299+
| Field Name | `dct_references_s`|
300300
| Required | no|
301301
| Type | string|
302302
| Description | This element is a hash of key/value pairs for different types of external links. It integrates external services and references using the CatInterOp approach|
@@ -310,7 +310,7 @@ hide:
310310

311311
| Label | Spatial Coverage|
312312
|:----------------------|:-----------|
313-
| uri | `dct_spatial_sm`|
313+
| Field Name | `dct_spatial_sm`|
314314
| Required | no|
315315
| Type | array|
316316
| Description | This field is for place name keywords|
@@ -324,7 +324,7 @@ hide:
324324

325325
| Label | Temporal Coverage|
326326
|:----------------------|:-----------|
327-
| uri | `dct_temporal_sm`|
327+
| Field Name | `dct_temporal_sm`|
328328
| Required | no|
329329
| Type | array|
330330
| Description | This represents the "Ground Condition" of the resource, meaning the time period data was collected or is intended to represent. Displays on the item page in the Year value|
@@ -338,7 +338,7 @@ hide:
338338

339339
| Label | Geometry Type|
340340
|:----------------------|:-----------|
341-
| uri | `layer_geom_type_s`|
341+
| Field Name | `layer_geom_type_s`|
342342
| Required | no|
343343
| Type | string|
344344
| Description | This element shows up as Data type in GeoBlacklight, and each value has an associated icon|
@@ -352,7 +352,7 @@ hide:
352352

353353
| Label | Layer ID|
354354
|:----------------------|:-----------|
355-
| uri | `layer_id_s`|
355+
| Field Name | `layer_id_s`|
356356
| Required | no|
357357
| Type | string|
358358
| Description | Indicates the layer id for any WMS or WFS web services listed in the `dct_references_s` field|
@@ -366,7 +366,7 @@ hide:
366366

367367
| Label | Modified Date|
368368
|:----------------------|:-----------|
369-
| uri | `layer_modified_dt`|
369+
| Field Name | `layer_modified_dt`|
370370
| Required | no|
371371
| Type | date-time|
372372
| Description | Last modification date for the metadata record|
@@ -380,7 +380,7 @@ hide:
380380

381381
| Label | Suppressed|
382382
|:----------------------|:-----------|
383-
| uri | `suppressed_b`|
383+
| Field Name | `suppressed_b`|
384384
| Required | no|
385385
| Type | boolean|
386386
| Description | If set to True, the record will not appear in search results. If is still accessible from the Data Relations widget and via direct URL.|

docs/tables/ogm-aardvark-fields.csv

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Label,URI,Obligation
1+
Label,Field Name,Obligation
22
==**[Access Rights](ogm-aardvark/access-rights.md)**==,`dct_accessRights_s`,==**Required**==
33
[Alternative Title](ogm-aardvark/alternative-title.md),`dct_alternative_sm`,Optional
44
[Bounding Box](ogm-aardvark/bounding-box.md),`dcat_bbox`,Suggested
@@ -40,4 +40,4 @@ Label,URI,Obligation
4040
[Temporal Coverage](ogm-aardvark/temporal-coverage.md),`dct_temporal_sm`,Suggested
4141
[Theme](ogm-aardvark/theme.md),`dcat_theme_sm`,Optional
4242
==**[Title](ogm-aardvark/title.md)**==,`dct_title_s`,==**Required**==
43-
[WxS Identifier](ogm-aardvark/wxs-identifier.md),`gbl_wxsIdentifier_s`,Conditional
43+
[WxS Identifier](ogm-aardvark/wxs-identifier.md),`gbl_wxsIdentifier_s`,Conditional

docs/tables/ogm-accessRights.csv

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Label,Access Rights
2-
URI,dct_accessRights_s
2+
Field Name,dct_accessRights_s
33
Obligation,Required
44
Multivalued,false
55
Field type,string
@@ -9,4 +9,4 @@ Commentary,"This field can be set to ""Public"", which allows users to view and
99
Controlled Vocabulary,yes - strict
1010
Example value,"""Public"""
1111
Element Set,DCMI
12-
Group,Rights
12+
Group,Rights

docs/tables/ogm-gbl1.csv

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Aardvark Label,OGM Aardvark,GBL 1.0,Note
2-
Access Rights,`dct_accessRights_s`,`dc_rights_s`,new URI name
2+
Access Rights,`dct_accessRights_s`,`dc_rights_s`,new field name
33
Alternative Title,`dct_alternative_sm`,-,new field
44
Bounding Box,`dcat_bbox`,`solr_geom`,new field
55
Centroid,`dcat_centroid`,-,new field
@@ -11,18 +11,18 @@ File Size,`gbl_fileSize_s`,-,new field
1111
Format,`dct_format_s`,`dc_format_s`,new namespace
1212
Geometry,`locn_geometry`,`solr_geom`,new field
1313
Georeferenced,`gbl_georeferenced_b`,-,new field
14-
ID,`id`,`layer_slug_s`,new URI name
14+
ID,`id`,`layer_slug_s`,new field name
1515
Identifier,`dct_identifier_sm`,`dc_identifier_s`,new namespace; single to multi-valued
16-
Index Year,`gbl_indexYear_im`,`solr_year_i`,new URI name; single to multi-valued
16+
Index Year,`gbl_indexYear_im`,`solr_year_i`,new field name; single to multi-valued
1717
Is Part Of,`dct_isPartOf_sm`,-,new value type (see Elements without a crosswalk)
1818
Is Replaced By,`dct_isReplacedBy_sm`,-,new field
1919
Keyword,`dcat_keyword_sm`,-,new field
2020
Language,`dct_language_sm`,`dc_language_s or _sm`,new namespace; single to multi-valued
2121
License,`dct_license_sm`,-,new field
2222
Member Of,`pcdm_memberOf_sm`,-,new field
23-
Metadata Version,`gbl_mdVersion_s`,`geoblacklight_version`,new URI name
24-
Modified,`gbl_mdModified_dt`,`layer_modified_dt`,new URI name
25-
Provider,`schema_provider_s`,`dct_provenance_s`,new URI name
23+
Metadata Version,`gbl_mdVersion_s`,`geoblacklight_version`,new field name
24+
Modified,`gbl_mdModified_dt`,`layer_modified_dt`,new field name
25+
Provider,`schema_provider_s`,`dct_provenance_s`,new field name
2626
Publisher,`dct_publisher_sm`,`dc_publisher_s`,new namespace; single to multi-valued
2727
References,`dct_references_s`,`dct_references_s`,no change
2828
Relation,`dct_relation_sm`,-,new field
@@ -39,7 +39,7 @@ Temporal Coverage,`dct_temporal_sm`,`dct_temporal_sm`,no change
3939
Theme,`dcat_theme_sm`,-,new field
4040
Title,`dct_title_s`,`dc_title_s`,new namespace
4141
Version,`dct_isVersionOf_sm`,-,new field
42-
WxS Identifier,`gbl_wxsIdentifier_s`,`layer_id_s`,new URI name
42+
WxS Identifier,`gbl_wxsIdentifier_s`,`layer_id_s`,new field name
4343
-,-,`dc_type_s`,deprecated field
4444
-,-,`layer_geom_type_s`,deprecated field
45-
-,-,`dc_isPartOf_sm`,"deprecated literal field, replaced by nonliteral dct_isPartOf_sm,, which takes an ID"
45+
-,-,`dc_isPartOf_sm`,"deprecated literal field, replaced by nonliteral dct_isPartOf_sm,, which takes an ID"

0 commit comments

Comments
 (0)