Skip to content

Commit f2659d6

Browse files
rmseifriedkgjenkins
rmseifried
and
kgjenkins
authored
Standardize obligation terms across site (#75)
* Standardize obligation terms across site * capitalize obligation in alphabetical list (#78) --------- Co-authored-by: Keith Jenkins <kgjenkins@gmail.com>
1 parent 214d5b5 commit f2659d6

15 files changed

Lines changed: 48 additions & 49 deletions

‎docs/ogm-aardvark.md‎

Lines changed: 34 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -103,44 +103,43 @@ has_toc: false
103103
| Label | URI | Obligation |
104104
|:--------------------------------------------------------|:-----------------------|:------------|
105105
| **[Access Rights](ogm-aardvark/access-rights)** | `dct_accessRights_s` | <span class="text-red-300">**Required**</span> |
106-
| [Alternative Title](ogm-aardvark/alternative-title) | `dct_alternative_sm` | optional |
107-
| [Bounding Box](ogm-aardvark/bounding-box) | `dcat_bbox` | suggested |
108-
| [Centroid](ogm-aardvark/centroid) | `dcat_centroid` | optional |
109-
| [Creator](ogm-aardvark/creator) | `dct_creator_sm` | suggested |
110-
| [Date Issued](ogm-aardvark/date-issued) | `dct_issued_s` | optional |
111-
| [Date Range](ogm-aardvark/date-range) | `gbl_dateRange_drsim` | optional |
112-
| [Description](ogm-aardvark/description) | `dct_description_sm` | suggested |
113-
| [Display Note](ogm-aardvark/display-note) | `gbl_displayNote_sm` | optional |
114-
| [File Size](ogm-aardvark/file-size) | `gbl_fileSize_s` | optional |
106+
| [Alternative Title](ogm-aardvark/alternative-title) | `dct_alternative_sm` | Optional |
107+
| [Bounding Box](ogm-aardvark/bounding-box) | `dcat_bbox` | Suggested |
108+
| [Centroid](ogm-aardvark/centroid) | `dcat_centroid` | Optional |
109+
| [Creator](ogm-aardvark/creator) | `dct_creator_sm` | Suggested |
110+
| [Date Issued](ogm-aardvark/date-issued) | `dct_issued_s` | Optional |
111+
| [Date Range](ogm-aardvark/date-range) | `gbl_dateRange_drsim` | Optional |
112+
| [Description](ogm-aardvark/description) | `dct_description_sm` | Suggested |
113+
| [File Size](ogm-aardvark/file-size) | `gbl_fileSize_s` | Optional |
115114
| [Format](ogm-aardvark/format) | `dct_format_s` | Conditional |
116-
| [Geometry](ogm-aardvark/geometry) | `locn_geometry` | suggested |
117-
| [Georeferenced](ogm-aardvark/georeferenced) | `gbl_georeferenced_b` | optional |
115+
| [Geometry](ogm-aardvark/geometry) | `locn_geometry` | Suggested |
116+
| [Georeferenced](ogm-aardvark/georeferenced) | `gbl_georeferenced_b` | Optional |
118117
| **[ID](ogm-aardvark/id)** | `id` | <span class="text-red-300">**Required**</span> |
119-
| [Identifier](ogm-aardvark/identifier) | `dct_identifier_sm` | suggested |
120-
| [Index Year](ogm-aardvark/index-year) | `gbl_indexYear_im` | suggested |
121-
| [Is Part Of](ogm-aardvark/is-part-of) | `dct_isPartOf_sm` | optional |
122-
| [Is Replaced By](ogm-aardvark/is-replaced-by) | `dct_isReplacedBy_sm` | optional |
123-
| [Is Version Of](ogm-aardvark/is-version-of) | `dct_isVersionOf_sm` | optional |
124-
| [Keyword](ogm-aardvark/keyword) | `dcat_keyword_sm` | optional |
125-
| [Language](ogm-aardvark/language) | `dct_language_sm` | optional |
126-
| [License](ogm-aardvark/license) | `dct_license_sm` | optional |
127-
| [Member Of](ogm-aardvark/member-of) | `pcdm_memberOf_sm` | optional |
118+
| [Identifier](ogm-aardvark/identifier) | `dct_identifier_sm` | Suggested |
119+
| [Index Year](ogm-aardvark/index-year) | `gbl_indexYear_im` | Suggested |
120+
| [Is Part Of](ogm-aardvark/is-part-of) | `dct_isPartOf_sm` | Optional |
121+
| [Is Replaced By](ogm-aardvark/is-replaced-by) | `dct_isReplacedBy_sm` | Optional |
122+
| [Is Version Of](ogm-aardvark/is-version-of) | `dct_isVersionOf_sm` | Optional |
123+
| [Keyword](ogm-aardvark/keyword) | `dcat_keyword_sm` | Optional |
124+
| [Language](ogm-aardvark/language) | `dct_language_sm` | Optional |
125+
| [License](ogm-aardvark/license) | `dct_license_sm` | Optional |
126+
| [Member Of](ogm-aardvark/member-of) | `pcdm_memberOf_sm` | Optional |
128127
| **[Metadata Version](ogm-aardvark/metadata-version)** | `gbl_mdVersion_s` | <span class="text-red-300">**Required**</span> |
129128
| **[Modified](ogm-aardvark/modified)** | `gbl_mdModified_dt` | <span class="text-red-300">**Required**</span> |
130-
| [Provider](ogm-aardvark/provider) | `schema_provider_s` | suggested |
131-
| [Publisher](ogm-aardvark/publisher) | `dct_publisher_sm` | suggested |
132-
| [References](ogm-aardvark/references) | `dct_references_s` | suggested |
133-
| [Relation](ogm-aardvark/relation) | `dct_relation_sm` | optional |
134-
| [Replaces](ogm-aardvark/replaces) | `dct_replaces_sm` | optional |
129+
| [Provider](ogm-aardvark/provider) | `schema_provider_s` | Suggested |
130+
| [Publisher](ogm-aardvark/publisher) | `dct_publisher_sm` | Suggested |
131+
| [References](ogm-aardvark/references) | `dct_references_s` | Suggested |
132+
| [Relation](ogm-aardvark/relation) | `dct_relation_sm` | Optional |
133+
| [Replaces](ogm-aardvark/replaces) | `dct_replaces_sm` | Optional |
135134
| **[Resource Class](ogm-aardvark/resource-class)** | `gbl_resourceClass_sm` | <span class="text-red-300">**Required**</span> |
136-
| [Resource Type](ogm-aardvark/resource-type) | `gbl_resourceType_sm` | suggested |
137-
| [Rights Holder](ogm-aardvark/rights-holder) | `dct_rightsHolder_sm` | optional |
138-
| [Rights](ogm-aardvark/rights) | `dct_rights_sm` | suggested |
139-
| [Source](ogm-aardvark/source) | `dct_source_sm` | optional |
140-
| [Spatial Coverage](ogm-aardvark/spatial-coverage) | `dct_spatial_sm` | suggested |
141-
| [Subject](ogm-aardvark/subject) | `dct_subject_sm` | optional |
142-
| [Suppressed](ogm-aardvark/suppressed) | `gbl_suppressed_b` | optional |
143-
| [Temporal Coverage](ogm-aardvark/temporal-coverage) | `dct_temporal_sm` | suggested |
144-
| [Theme](ogm-aardvark/theme) | `dcat_theme_sm` | optional |
135+
| [Resource Type](ogm-aardvark/resource-type) | `gbl_resourceType_sm` | Suggested |
136+
| [Rights Holder](ogm-aardvark/rights-holder) | `dct_rightsHolder_sm` | Optional |
137+
| [Rights](ogm-aardvark/rights) | `dct_rights_sm` | Suggested |
138+
| [Source](ogm-aardvark/source) | `dct_source_sm` | Optional |
139+
| [Spatial Coverage](ogm-aardvark/spatial-coverage) | `dct_spatial_sm` | Suggested |
140+
| [Subject](ogm-aardvark/subject) | `dct_subject_sm` | Optional |
141+
| [Suppressed](ogm-aardvark/suppressed) | `gbl_suppressed_b` | Optional |
142+
| [Temporal Coverage](ogm-aardvark/temporal-coverage) | `dct_temporal_sm` | Suggested |
143+
| [Theme](ogm-aardvark/theme) | `dcat_theme_sm` | Optional |
145144
| **[Title](ogm-aardvark/title)** | `dct_title_s` | <span class="text-red-300">**Required**</span> |
146-
| [WxS Identifier](ogm-aardvark/wxs-identifier) | `gbl_wxsIdentifier_s` | conditional |
145+
| [WxS Identifier](ogm-aardvark/wxs-identifier) | `gbl_wxsIdentifier_s` | Conditional |

‎docs/ogm-aardvark/bounding-box.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav_order: 19
1010
| Label | Bounding Box |
1111
|:--------------------- |:------------ |
1212
| URI | `dcat_bbox` |
13-
| Obligation | Recommended |
13+
| Obligation | Suggested |
1414
| Multivalued | false |
1515
| Field type | string |
1616
| Purpose | To support overlap ratio boosting in spatial searches |

‎docs/ogm-aardvark/creator.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav_order: 5
1010
| Label | Creator |
1111
|:----------------------|:------------------------|
1212
| URI | `dct_creator_sm` |
13-
| Obligation | Recommended |
13+
| Obligation | Suggested |
1414
| Multivalued | true |
1515
| Field type | array of strings |
1616
| Purpose | To credit the person/organization that collected or authored the resource |

‎docs/ogm-aardvark/description.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav_order: 3
1010
| Label | Description |
1111
|:----------------------|:------------------------|
1212
| URI | `dct_description_sm` |
13-
| Obligation | Recommended |
13+
| Obligation | Suggested |
1414
| Multivalued | true |
1515
| Field type | array of strings |
1616
| Purpose | To provide the user with a summary of the resource |

‎docs/ogm-aardvark/format.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav_order: 32
1010
| Label | Format |
1111
|:----------------------|:-------|
1212
| URI | `dct_format_s` |
13-
| Obligation | Conditional |
13+
| Obligation | Conditionally Required |
1414
| Multivalued | false |
1515
| Field type | string |
1616
| Purpose | To display to the user the name of the file type as a text string in the download button |

‎docs/ogm-aardvark/geometry.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav_order: 18
1010
| Label | Geometry |
1111
|:----------------------|:---------|
1212
| URI | `locn_geometry` |
13-
| Obligation | Recommended |
13+
| Obligation | Suggested |
1414
| Multivalued | false |
1515
| Field type | string |
1616
| Purpose | To display the extent of the resource and to power the map search |

‎docs/ogm-aardvark/identifier.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav_order: 37
1010
| Label | Identifier |
1111
|:----------------------|:-----------|
1212
| URI | `dct_identifier_sm` |
13-
| Obligation | Recommended |
13+
| Obligation | Suggested |
1414
| Multivalued | true |
1515
| Field type | array of strings |
1616
| Purpose | To provide a general purpose field for identifiers |

‎docs/ogm-aardvark/index-year.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav_order: 15
1010
| Label | Index Year |
1111
|:----------------------|:-----------|
1212
| URI | `gbl_indexYear_im` |
13-
| Obligation | Recommended |
13+
| Obligation | Suggested |
1414
| Multivalued | true |
1515
| Field type | array of integers |
1616
| Purpose | To power time slider widgets that rely on integers for dates |

‎docs/ogm-aardvark/provider.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav_order: 7
1010
| Label | Provider |
1111
|:----------------------|:------------------------|
1212
| URI | `schema_provider_s` |
13-
| Obligation | Recommended |
13+
| Obligation | Suggested |
1414
| Multivalued | false |
1515
| Field type | string |
1616
| Purpose | To clarify which organization is holds the resource or acts as the custodian for the metadata record and to help users understand which resources they can access |

‎docs/ogm-aardvark/publisher.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav_order: 6
1010
| Label | Publisher |
1111
|:----------------------|:------------------------|
1212
| URI | `dct_publisher_sm` |
13-
| Obligation | Recommended |
13+
| Obligation | Suggested |
1414
| Multivalued | true |
1515
| Field type | array of strings |
1616
| Purpose | To credit the entity that first made a new version of something available |

0 commit comments

Comments
 (0)