Skip to content

Commit 07793f4

Browse files
karenmajewiczkarenmajewicz
authored
Merge pull request #98 from OpenGeoMetadata/aardvark-copyedits
Update ogm-aardvark page
2 parents 0fd0786 + 4fc67b7 commit 07793f4

46 files changed

Lines changed: 382 additions & 379 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/ogm-aardvark.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# OpenGeoMetadata (OGM) Aardvark Schema
22

3+
!!! tip
4+
To read more about certain metadata categories (like "Spatial"), click the hyperlinked headings in the table below.
5+
36
<div style="float:left; margin-right:5em; line-height:1.1" markdown="1">
47

58
#### Descriptive
@@ -61,7 +64,7 @@
6164

6265
#### Links
6366
- [References](#references) (S)
64-
- [WxS Identifier](#wxs-identifier)
67+
- [WxS Identifier](#wxs-identifier) (C)
6568

6669
#### Identifiers
6770
- ==[ID](#id) (R)==
@@ -142,7 +145,6 @@
142145
* LAS
143146
* LAZ
144147
* Mixed
145-
* Mixed
146148
* MrSID
147149
* PDF
148150
* PNG
@@ -257,7 +259,7 @@ The following table lists terms from the OpenGeoMetadata community. They are mos
257259
## Source
258260
{{ read_csv('ogm-aardvark/source.csv') }}
259261

260-
## Spatial coverage
262+
## Spatial Coverage
261263
{{ read_csv('ogm-aardvark/spatial-coverage.csv') }}
262264

263265
## Subject

‎docs/ogm-aardvark/access-rights.csv‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Label,Access Rights
22
URI,https://opengeometadata.org/ogm-aardvark/#access-rights
3-
Field name,dct_accessRights_s
4-
Field type,string
3+
Field Name,dct_accessRights_s
4+
Field Type,String
55
Obligation,Required
6-
Multivalued,false
7-
Purpose,To clarify to the user if the resource is public (any user can access) or restricted (a user will need to log in to some kind of authentication protocol) and if the application should provide a web service preview and/or a download function
6+
Multivalued,False
7+
Purpose,To clarify to the user if the resource is public (any user can access) or restricted (a user will need to log in to some kind of authentication protocol) and if the application should provide a web service preview and/or a download function.
88
Entry Guidelines,Only one of two values are allowed: Public or Restricted.
99
Commentary,"This field can be set to ""Public"", which allows users to view and download an item, or ""Restricted"", which requires a user to log in to an authentication service."
10-
Controlled Vocabulary,yes - strict
11-
Example value,"""Public"""
10+
Controlled Vocabulary,Yes - strict
11+
Example Value,"""Public"""
1212
Element Set,DCMI
13-
Group,Rights
13+
Group,"[Rights](../ogm-aardvark/#rights)"

‎docs/ogm-aardvark/alternative-title.csv‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Label,Alternative Title
22
URI,https://opengeometadata.org/ogm-aardvark/#alternative-title
3-
Field name,dct_alternative_sm
4-
Field type,array of strings
3+
Field Name,dct_alternative_sm
4+
Field Type,Array of strings
55
Obligation,Optional
6-
Multivalued,true
7-
Purpose,To provide the user with the another title if needed
6+
Multivalued,True
7+
Purpose,To provide the user with the another title if needed.
88
Entry Guidelines,This could be for a secondary or original title or subtitle.
99
Commentary,"For discoverability, improving titles for data is encouraged. This field could be a place to keep the original title. It could also be useful for scanned maps. Some have long titles that include MARC subtitle fields, such as 245$b. Whether or not this field should appear in your GeoBlacklight item view pages can be customized in the application."
10-
Controlled Vocabulary,no
11-
Example value,"[""NEZ H Districts""]"
10+
Controlled Vocabulary,No
11+
Example Value,"[""NEZ H Districts""]"
1212
Element Set,DCMI
13-
Group,Bibliographic - general
13+
Group,"[Descriptive](../ogm-aardvark/#descriptive)"

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Label,Bounding Box
22
URI,https://opengeometadata.org/ogm-aardvark/#bounding-box
3-
Field name,dcat_bbox
4-
Field type,string
3+
Field Name,dcat_bbox
4+
Field Type,String
55
Obligation,Suggested
6-
Multivalued,false
7-
Purpose,To support overlap ratio boosting in spatial searches
8-
Entry Guidelines,"This should be a bounding box in this format: ENVELOPE(w,e,n,s)."
9-
Commentary,"If the locn_geometry field uses the ENVELOPE syntax, then these fields will be identical."
10-
Controlled Vocabulary,no
11-
Example value,"""ENVELOPE(-111.1, -104.0, 45.0, 40.9)"""
6+
Multivalued,False
7+
Purpose,To support overlap ratio boosting in spatial searches.
8+
Entry Guidelines,"This should be a bounding box in this format: ENVELOPE(W,E,N,S)."
9+
Commentary,"If the [Geometry](../ogm-aardvark/#geometry) field uses the ENVELOPE syntax, then these fields will be identical."
10+
Controlled Vocabulary,No
11+
Example Value,"""ENVELOPE(-111.1, -104.0, 45.0, 40.9)"""
1212
Element Set,DCAT
13-
Group,Spatial
13+
Group,"[Spatial](../ogm-aardvark/#spatial)"

‎docs/ogm-aardvark/centroid.csv‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Label,Centroid
22
URI,https://opengeometadata.org/ogm-aardvark/#centroid
3-
Field name,dcat_centroid
4-
Field type,string
3+
Field Name,dcat_centroid
4+
Field Type,String
55
Obligation,Optional
6-
Multivalued,false
7-
Purpose,To display the center point of a resource
8-
Entry Guidelines,"Enter two decimal degree coordinates separated by a comma in this order: latitude,longitude."
6+
Multivalued,False
7+
Purpose,To display the centerpoint of a resource.
8+
Entry Guidelines,"Enter two decimal degree coordinates separated by a comma in this order: latitude, longitude."
99
Commentary,This field is currently only supported by customizations to the GeoBlacklight application.
10-
Controlled Vocabulary,no
11-
Example value,"""46.4218,-94.087"""
10+
Controlled Vocabulary,No
11+
Example Value,"""46.4218,-94.087"""
1212
Element Set,DCAT
13-
Group,Spatial
13+
Group,"[Spatial](../ogm-aardvark/#spatial)"

‎docs/ogm-aardvark/creator.csv‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Label,Creator
22
URI,https://opengeometadata.org/ogm-aardvark/#creator
3-
Field name,dct_creator_sm
4-
Field type,array of strings
3+
Field Name,dct_creator_sm
4+
Field Type,Array of strings
55
Obligation,Suggested
6-
Multivalued,true
7-
Purpose,To credit the person/organization that collected or authored the resource
8-
Entry Guidelines,The suggested controlled vocabulary is the Library of Congress Name Authority File.
9-
Commentary,"This field is best reserved for instances in which an individual person has collected, produced, or generated analyses of data (as opposed to an agency releasing a data product or resource). It can be a person or an organization."
10-
Controlled Vocabulary,no
11-
Example value,"[""Geological Survey (U.S.)""]"
6+
Multivalued,True
7+
Purpose,To credit the person/organization that collected or authored the resource.
8+
Entry Guidelines,The suggested controlled vocabulary is the [Library of Congress Name Authority File](https://id.loc.gov/authorities/names.html).
9+
Commentary,"The distinction between Creator and [Publisher](../ogm-aardvark/#publisher) is often vague. This field is best reserved for instances in which an individual person has collected, produced, or generated analyses of data (as opposed to an agency releasing a data product or resource). It can be a person or an organization."
10+
Controlled Vocabulary,No
11+
Example Value,"[""Geological Survey (U.S.)""]"
1212
Element Set,DCMI
13-
Group,Bibliographic - entity
13+
Group,"[Credits](../ogm-aardvark/#credits)"

‎docs/ogm-aardvark/date-issued.csv‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Label,Date Issued
22
URI,https://opengeometadata.org/ogm-aardvark/#date-issued
3-
Field name,dct_issued_s
4-
Field type,string
3+
Field Name,dct_issued_s
4+
Field Type,String
55
Obligation,Optional
6-
Multivalued,false
7-
Purpose,"To provide the user with the date when an item was published, and for administrators to determine the age of the resource"
6+
Multivalued,False
7+
Purpose,"To provide the user with the date when an item was published, and to allow administrators to determine the age of the resource."
88
Entry Guidelines,"A single year is the preferred format. For more precise dates, use the ISO format without the time value: YYYY-MM-DD or YYYY-MM."
9-
Commentary,"Although the field is optional, it is often useful when a clear Temporal Coverage value is not present. For example, one may want to preserve a dataset with an uncertain lineage, but there is an indicator on a data portal on the date of last update. In most cases, the 4-digit year is sufficient."
10-
Controlled Vocabulary,no
11-
Example value,"""1999"""
9+
Commentary,"Although the field is optional, it is often useful when a clear [Temporal Coverage](../ogm-aardvark/#temporal-coverage) value is not present. For example, one may want to preserve a dataset with an uncertain lineage, but there is an indicator on a data portal on the date of last update. In most cases, the 4-digit year is sufficient."
10+
Controlled Vocabulary,No
11+
Example Value,"""1999"""
1212
Element Set,DCMI
13-
Group,Temporal
13+
Group,"[Temporal](../ogm-aardvark/#temporal)"

‎docs/ogm-aardvark/date-range.csv‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Label,Date Range
22
URI,https://opengeometadata.org/ogm-aardvark/#date-range
3-
Field name,gbl_dateRange_drsim
4-
Field type,string
3+
Field Name,gbl_dateRange_drsim
4+
Field Type,String
55
Obligation,Optional
6-
Multivalued,true
7-
Purpose,To power other time widgets that use a date range
8-
Entry Guidelines,"Enter a start date and end date in the Solr date range field convention. In JSON, the value should be formatted as a string that includes the brackets, rather than as an array or list containing a string. Incorrect: [""YYYY TO YYYY""] - Correct: ""[YYYY TO YYYY]"""
6+
Multivalued,True
7+
Purpose,To power other time widgets that use a date range.
8+
Entry Guidelines,"Enter a start date and end date in the Solr date range field convention. In JSON, the value should be formatted as a string that includes the brackets, rather than as an array or list containing a string. Incorrect: [""YYYY TO YYYY""]. Correct: ""[YYYY TO YYYY]""."
99
Commentary,"This field is not yet supported by GeoBlacklight, but the application can be customized to use it."
10-
Controlled Vocabulary,no
11-
Example value,"""[1980 TO 1995]"""
10+
Controlled Vocabulary,No
11+
Example Value,"""[1980 TO 1995]"""
1212
Element Set,GBL
13-
Group,Temporal
13+
Group,"[Temporal](../ogm-aardvark/#temporal)"

‎docs/ogm-aardvark/description.csv‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Label,Description
22
URI,https://opengeometadata.org/ogm-aardvark/#description
3-
Field name,dct_description_sm
4-
Field type,array of strings
3+
Field Name,dct_description_sm
4+
Field Type,Array of strings
55
Obligation,Suggested
6-
Multivalued,true
7-
Purpose,To provide the user with a summary of the resource
8-
Entry Guidelines,"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. Description is a plain text field by default."
9-
Commentary,"This field is the second-most prominent value (after Title) that users see when search or browsing for items. Although not required, it is strongly recommended. If the description is minimal or lacking, it can be improved by concatenating available metadata fields, such as title, date, format, and place. This is a plain text field, so html code is not supported here unless the application is customized."
10-
Controlled Vocabulary,no
11-
Example value,"""This polygon shapefile represents boundaries of election districts in New York City. It was harvested from the NYC Open Data Portal."""
6+
Multivalued,True
7+
Purpose,To provide the user with a summary of the resource.
8+
Entry Guidelines,"At a 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."
9+
Commentary,"This field is the second-most prominent value (after [Title](../ogm-aardvark/#title)) that users see when search or browsing for items. Although not required, it is strongly recommended. If the description is minimal or lacking, it can be improved by concatenating available metadata fields, such as title, date, format, and place. This is a plain text field by default, but it can include clickable links if the GeoBlacklight software is customized; see the [GeoBlacklight documentation](https://geoblacklight.org/docs/customization/rendering_html_from_description/) on how to render HTML from a text field."
10+
Controlled Vocabulary,No
11+
Example Value,"""This polygon shapefile represents boundaries of election districts in New York City. It was harvested from the NYC Open Data Portal."""
1212
Element Set,DCMI
13-
Group,Bibliographic - general
13+
Group,"[Descriptive](../ogm-aardvark/#descriptive)"

‎docs/ogm-aardvark/display-note.csv‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Label,Display Note
22
URI,https://opengeometadata.org/ogm-aardvark/#display-note
3-
Field name,gbl_displayNote_sm
4-
Field type,array of strings
3+
Field Name,gbl_displayNote_sm
4+
Field Type,Array of strings
55
Obligation,Optional
6-
Multivalued,true
6+
Multivalued,True
77
Purpose,"To highlight additional information about a resource, such as warnings or tips for using the data."
8-
Entry Guidelines,"Prefix the string with ""Warning:"", ""Info:"", or ""Tip:"" to specify the type of note. Future versions of GeoBlacklight will use such prefixes to control the style of the displayed note. Styles and additional prefixes (for example, in other languages) can be added in the GeoBlacklight config."
9-
Commentary,"This field is currently only supported by customizations to the GeoBlacklight application. On the item page, text in this field will be prominently displayed in a shaded box just after the title."
10-
Controlled Vocabulary,no
11-
Example value,"[""Warning: This text (starting with 'This text') will be displayed in a red box"",""Info: This text (starting with 'This text') will be displayed in a blue box"",""Tip: This text (starting with 'This text') will be displayed in a green box"",""This is text without a tag and it will be assigned the default 'note' style""]"
8+
Entry Guidelines,"Prefix the string with ""Danger:"", ""Info:"", ""Tip:"", or ""Warning:"" to specify the type of note."
9+
Commentary,"Starting in GeoBlacklight version 4.1, text in this field is prominently displayed in a shaded box just after the title, with the prefixes controlling the style of the displayed note. Styles and additional prefixes (for example, in other languages) can be added by customizing the GeoBlacklight software; see the [v4.1.0 release notes](https://github.com/geoblacklight/geoblacklight/releases/tag/v4.1.0)."
10+
Controlled Vocabulary,No
11+
Example Value,"[""Danger: This text will be displayed in a red box"",""Info: This text will be displayed in a blue box"",""Tip: This text will be displayed in a green box"",""Warning: This text will be displayed in a yellow box"",""This is text without a tag and it will be assigned the default 'note' style""]"
1212
Element Set,DCMI
13-
Group,Bibliographic - general
13+
Group,"[Descriptive](../ogm-aardvark/#descriptive)"

0 commit comments

Comments
 (0)