Merge pull request #117 from OpenGeoMetadata/62-reformat-aardvark-table

Update OGM Aardvark schema page

Author: karenmajewicz

docs/ogm-aardvark.md

@@ -1,96 +1,16 @@
 # OpenGeoMetadata (OGM) Aardvark Schema
 
-!!! tip
-	To read more about certain metadata categories (like "Spatial"), click the hyperlinked headings in the table below. 
-
-<div style="float:left; margin-right:5em; line-height:1.1" markdown="1">
-
-#### Descriptive
-- ==[Title](#title) (R)==
-- [Alternative Title](#alternative-title)
-- [Description](#description) (S)
-- [Language](#language) (v)
-- [Display Note](#display-note)
-
-#### Credits
-- [Creator](#creator) (S)
-- [Publisher](#publisher) (S)
-- [Provider](#provider) (S)
-
-#### Categories
-- ==[Resource Class](#resource-class) (R)== (v)
-- [Resource Type](#resource-type) (S) (v)
-- [Subject](#subject)
-- [Theme](#theme) (v)
-- [Keyword](#keyword)
-
-#### [Temporal :material-link:](../temporal-fields)
-- [Temporal Coverage](#temporal-coverage) (S)
-- [Date Issued](#date-issued)
-- [Index Year](#index-year) (S)
-- [Date Range](#date-range)
-
-</div>
-<div style="float:left; margin-right:5em; line-height:1.1" markdown="1">
-
-#### [Spatial :material-link:](../spatial-fields)
-- [Spatial Coverage](#spatial-coverage) (S)
-- [Geometry](#geometry) (S)
-- [Bounding Box](#bounding-box) (S)
-- [Centroid](#centroid)
-- [Georeferenced](#georeferenced)
-
-#### [Relations :material-link:](../relations-fields)
-- [Relation](#relation)
-- [Member Of](#member-of)
-- [Is Part Of](#is-part-of)
-- [Source](#source)
-- [Is Version Of](#is-version-of)
-- [Replaces](#replaces)
-- [Is Replaced By](#is-replaced-by)
-
-#### Rights
-- [Rights](#rights_1) (S)
-- [Rights Holder](#rights-holder)
-- [License](#license)
-- ==[Access Rights](#access-rights) (R)==
-
-</div>
-<div style="float:left; line-height:1.1" markdown="1">
-
-#### Object
-- [Format](#format) (C) (v)
-- [File Size](#file-size)
-
-#### Links
-- [References](#references) (S)
-- [WxS Identifier](#wxs-identifier) (C)
-
-#### Identifiers
-- ==[ID](#id) (R)==
-- [Identifier](#identifier) (S)
-
-#### Admin
-- ==[Modified](#modified) (R)==
-- ==[Metadata Version](#metadata-version) (R)== (v)
-- [Suppressed](#suppressed)
+!!! info "Definitions"
 
-----
-
-!!! info "Key"
-
-	==(R)  = Required==
-
-	(C) = Conditionally Required
+	**Mandatory** = meets the minimum community standard for high-quality metadata
 
-	(S) = Suggested  
+	**Suggested** = improves searching and/or citation generation
+	
+	To check which fields are required for current GeoBlacklight functionality, see the [GeoBlacklight documentation](https://geoblacklight.org/docs/metadata/)
 
-	(v) = Controlled Values
-
-</div>
-
-<br style="clear:left">
+{{ read_csv('ogm-aardvark/ogm-aardvark.csv') }}
 
+----
 
 ## Access Rights
 {{ read_csv('ogm-aardvark/access-rights.csv') }}

docs/ogm-aardvark/access-rights.csv

@@ -2,12 +2,12 @@ Label,Access Rights
 URI,https://opengeometadata.org/ogm-aardvark/#access-rights
 Field Name,dct_accessRights_s
 Field Type,String
-Obligation,Required
+Obligation,Mandatory - used to restrict patron access; critical for GeoBlacklight functioning
 Multivalued,False
 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.
 Entry Guidelines,Only one of two values are allowed: Public or Restricted.
 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."
 Controlled Vocabulary,Yes - strict
 Example Value,"""Public"""
 Element Set,DCMI
-Group,"[Rights](../ogm-aardvark/#rights)"
+Group,Rights

docs/ogm-aardvark/alternative-title.csv

@@ -10,4 +10,4 @@ Commentary,"For discoverability, improving titles for data is encouraged. This f
 Controlled Vocabulary,No
 Example Value,"[""NEZ H Districts""]"
 Element Set,DCMI
-Group,"[Descriptive](../ogm-aardvark/#descriptive)"
+Group,Descriptive

docs/ogm-aardvark/bounding-box.csv

@@ -2,12 +2,12 @@ Label,Bounding Box
 URI,https://opengeometadata.org/ogm-aardvark/#bounding-box
 Field Name,dcat_bbox
 Field Type,String
-Obligation,Suggested
+Obligation,Mandatory - used to provide more relevant search results in GeoBlacklight
 Multivalued,False
 Purpose,To support overlap ratio boosting in spatial searches.
 Entry Guidelines,"This should be a bounding box in this format: ENVELOPE(W,E,N,S)."
 Commentary,"If the [Geometry](../ogm-aardvark/#geometry) field uses the ENVELOPE syntax, then these fields will be identical."
 Controlled Vocabulary,No
 Example Value,"""ENVELOPE(-111.1, -104.0, 45.0, 40.9)"""
 Element Set,DCAT
-Group,"[Spatial](../ogm-aardvark/#spatial)"
+Group,[Spatial](../spatial-fields)

docs/ogm-aardvark/centroid.csv

@@ -10,4 +10,4 @@ Commentary,This field is currently only supported by customizations to the GeoBl
 Controlled Vocabulary,No
 Example Value,"""46.4218,-94.087"""
 Element Set,DCAT
-Group,"[Spatial](../ogm-aardvark/#spatial)"
+Group,[Spatial](../spatial-fields)

docs/ogm-aardvark/creator.csv

@@ -2,12 +2,12 @@ Label,Creator
 URI,https://opengeometadata.org/ogm-aardvark/#creator
 Field Name,dct_creator_sm
 Field Type,Array of strings
-Obligation,Suggested
+Obligation,Suggested - helpful for generating citations
 Multivalued,True
 Purpose,To credit the person/organization that collected or authored the resource.
 Entry Guidelines,The suggested controlled vocabulary is the [Library of Congress Name Authority File](https://id.loc.gov/authorities/names.html).
 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."
 Controlled Vocabulary,No
 Example Value,"[""Geological Survey (U.S.)""]"
 Element Set,DCMI
-Group,"[Credits](../ogm-aardvark/#credits)"
+Group,Credits

docs/ogm-aardvark/date-issued.csv

@@ -2,12 +2,12 @@ Label,Date Issued
 URI,https://opengeometadata.org/ogm-aardvark/#date-issued
 Field Name,dct_issued_s
 Field Type,String
-Obligation,Optional
+Obligation,Suggested - used to generate citations
 Multivalued,False
 Purpose,"To provide the user with the date when an item was published, and to allow administrators to determine the age of the resource."
 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."
 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."
 Controlled Vocabulary,No
 Example Value,"""1999"""
 Element Set,DCMI
-Group,"[Temporal](../ogm-aardvark/#temporal)"
+Group,[Temporal](../temporal-fields)

docs/ogm-aardvark/date-range.csv

@@ -10,4 +10,4 @@ Commentary,"This field is not yet supported by GeoBlacklight, but the applicatio
 Controlled Vocabulary,No
 Example Value,"""[1980 TO 1995]"""
 Element Set,GBL
-Group,"[Temporal](../ogm-aardvark/#temporal)"
+Group,[Temporal](../temporal-fields)

docs/ogm-aardvark/description.csv

@@ -2,12 +2,12 @@ Label,Description
 URI,https://opengeometadata.org/ogm-aardvark/#description
 Field Name,dct_description_sm
 Field Type,Array of strings
-Obligation,Suggested
+Obligation,Mandatory - used in search engine indexing
 Multivalued,True
 Purpose,To provide the user with a summary of the resource.
 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."
 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/rendering_html_from_description/) on how to render HTML from a text field."
 Controlled Vocabulary,No
 Example Value,"""This polygon shapefile represents boundaries of election districts in New York City. It was harvested from the NYC Open Data Portal."""
 Element Set,DCMI
-Group,"[Descriptive](../ogm-aardvark/#descriptive)"
+Group,Descriptive

docs/ogm-aardvark/display-note.csv

@@ -10,4 +10,4 @@ Commentary,"Starting in GeoBlacklight version 4.1, text in this field is promine
 Controlled Vocabulary,No
 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""]"
 Element Set,GBL
-Group,"[Descriptive](../ogm-aardvark/#descriptive)"
+Group,Descriptive