edits from LSP in preparation for publication (#232)

wmo-im · Oct 23, 2024 · d7e4145 · d7e4145
1 parent 0a79316
commit d7e4145
Show file tree

Hide file tree

Showing 16 changed files with 73 additions and 71 deletions.
diff --git a/standard/recommendations/core/PER_contacts.adoc b/standard/recommendations/core/PER_contacts.adoc
@@ -2,6 +2,6 @@
 [width="90%",cols="2,6a"]
 |===
 ^|*Permission {counter:per-id}* |*/per/core/contacts*
-^|A |The `+properties.contacts+` property MAY provide more than one contact via multiple objects or a single contact object with multiple roles.
+^|A |The `+properties.contacts+` property MAY provide more than one contact via multiple objects, or a single contact object with multiple roles.
 |===
 //per5
diff --git a/standard/recommendations/core/PER_data_policy.adoc b/standard/recommendations/core/PER_data_policy.adoc
@@ -3,8 +3,8 @@
 |===
 ^|*Permission {counter:per-id}* |*/per/core/data_policy*
 ^|A|For core data (when `+properties.wmo:dataPolicy+` property is `+core+`), attribution licensing MAY be provided as needed.
-^|B|For core data (when `+properties.wmo:dataPolicy+` is `+core+`) or recommended data (when `+properties.wmo:dataPolicy+` is `+recommended+`, and the data is compatible with free and unrestricted principles), a license or public domain statement that is compatible with free and unrestricted principles (such as, link:https://creativecommons.org/publicdomain/zero/1.0/[Creative Commons CC0]) MAY be expressed as a link object with the `license` link relation.
-^|C|For core data (when `+properties.wmo:dataPolicy+` is `+core+`) or recommended data (when `+properties.wmo:dataPolicy+` is `+recommended+`), a copyright statement MAY be expressed in `+properties.rights+`
+^|B|For core data (when `+properties.wmo:dataPolicy+` is `+core+`) or recommended data (when `+properties.wmo:dataPolicy+` is `+recommended+`, and the data is compatible with free and unrestricted principles), a license or public domain statement that is compatible with free and unrestricted principles (such as link:https://creativecommons.org/publicdomain/zero/1.0/[Creative Commons CC0]) MAY be expressed as a link object with the `license` link relation.
+^|C|For core data (when `+properties.wmo:dataPolicy+` is `+core+`) or recommended data (when `+properties.wmo:dataPolicy+` is `+recommended+`), a copyright statement MAY be expressed in `+properties.rights+`.
 ^|D|For core data (when `+properties.wmo:dataPolicy+` is `+core+`) or recommended data (when `+properties.wmo:dataPolicy+` is `+recommended+`), a link object MAY be expressed with `+rel=copyright+`.
 |===
 //per8
diff --git a/standard/recommendations/core/PER_pids.adoc b/standard/recommendations/core/PER_pids.adoc
@@ -2,7 +2,7 @@
 [width="90%",cols="2,6a"]
 |===
 ^|*Permission {counter:per-id}* |*/per/core/pids*
-^|A |A WCMP record MAY provide a persistent identifier to cite research or resource identification using a persistent identifier scheme/framework.
+^|A |A WCMP record MAY provide a persistent identifier to cite research or for resource identification, using a persistent identifier scheme/framework.
 ^|B |A WCMP record MAY provide a persistent identifier as a link object with `+rel=cite-as+` if there is an online citation or reference.
 |===
 //per7
diff --git a/standard/recommendations/core/REC_data_policy.adoc b/standard/recommendations/core/REC_data_policy.adoc
@@ -6,7 +6,7 @@
 ^|B|To express any conditions on use of a given dataset, the `+properties.rights+` property SHOULD be used.
 ^|C|For core data or recommended data compatible with free and unrestricted principles, `+properties.rights+` SHOULD be declared with exactly the following statement:
 
-  Users are granted free and unrestricted access to this data, without charge and with no conditions on use. Users are requested to attribute the producer of this data. WMO Unified Data Policy (Resolution 1 (Cg-Ext 2021))
+  Users are granted free and unrestricted access to this data, without charge and with no conditions on use. Users are requested to attribute the producer of this data. WMO Unified Data Policy (Resolution 1 (Cg-Ext 2021)).
 ^|D|For core or recommended data not in the public domain, a copyright statement SHOULD be expressed as either a `+properties.rights+` statement or a link object with `+rel=copyright+`.
 |===
 //rec12
diff --git a/standard/recommendations/core/REC_distribution.adoc b/standard/recommendations/core/REC_distribution.adoc
@@ -5,11 +5,11 @@
 ^|A |A WCMP record SHOULD describe additional distribution information with the `+links.distribution+` property to qualify a given service link. This information SHOULD be used to build the discovery information and allow the user to find and choose the appropriate service for accessing the data.
 ^|B |The `+links.distribution.availableFormats+` property SHOULD describe the different formats that can be retrieved using the service link.
 ^|C |The `+links.distribution.availableFormats.name+` property SHOULD describe the available format short name.
-^|D |The `+links.distribution.availableFormats.description+` SHOULD describe the associated format.
-^|E |The `+links.distribution.availableFormats.typicalFilename+` SHOULD describe the filenames that are available from the service link.
-^|F |The `+links.distribution.availableFormats.typicalFilesize+` SHOULD describe the typical filesize available from the service link.
-^|G |The `+links.distribution.availableFormats.numberOfFiles+` SHOULD describe the typical number of files received during a given period (day, month, ...) when using the service link. It SHOULD follow the pattern X per day, X per month.
-^|H |The `+links.distribution.availableFormats.documentation+` SHOULD be a `+link+` for accessing the documentation associated with the format.
-^|I |The `+links.distribution.availableFormats.samples+` SHOULD be an array of direct links to representative samples of the data.
+^|D |The `+links.distribution.availableFormats.description+` property SHOULD describe the associated format.
+^|E |The `+links.distribution.availableFormats.typicalFilename+` property SHOULD describe the filenames that are available from the service link.
+^|F |The `+links.distribution.availableFormats.typicalFilesize+` property SHOULD describe the typical file size available from the service link.
+^|G |The `+links.distribution.availableFormats.numberOfFiles+` property SHOULD describe the typical number of files received during a given period (day, month, ...) when using the service link. It SHOULD follow the pattern X per day, X per month.
+^|H |The `+links.distribution.availableFormats.documentation+` property SHOULD be a `+link+` for accessing the documentation associated with the format.
+^|I |The `+links.distribution.availableFormats.samples+` property SHOULD be an array of direct links to representative samples of the data.
 |===
 //rec14
diff --git a/standard/recommendations/core/REC_keywords.adoc b/standard/recommendations/core/REC_keywords.adoc
@@ -2,6 +2,6 @@
 [width="90%",cols="2,6a"]
 |===
 ^|*Recommendation {counter:rec-id}* |*/rec/core/keywords*
-^|A |A WCMP record SHOULD provide a `+properties.keywords+` property, as a list of freeform text or tags that are not based on a controlled vocabulary.
+^|A |A WCMP record SHOULD provide a `+properties.keywords+` property, as a list of free text or tags that are not based on a controlled vocabulary.
 |===
 //rec2
diff --git a/standard/recommendations/core/REC_links.adoc b/standard/recommendations/core/REC_links.adoc
@@ -2,7 +2,7 @@
 [width="90%",cols="2,6a"]
 |===
 ^|*Recommendation {counter:rec-id}* |*/rec/core/links*
-^|A |A WCMP record's links SHOULD be provided using secure protocols (such as, HTTPS or MQTTS).
+^|A |A WCMP record's links SHOULD be provided using secure protocols (such as HTTPS or MQTTS).
 ^|B |The `+links+` property SHOULD provide a `+type+` property with a valid media type from IANA or as designated by WMO.
 |===
 //rec13
diff --git a/standard/recommendations/core/REC_status.adoc b/standard/recommendations/core/REC_status.adoc
@@ -4,8 +4,8 @@
 ^|*Recommendation {counter:rec-id}* |*/rec/core/status*
 ^|A |A WCMP record SHOULD provide a `+properties.status+` property to identify the operational status of a given dataset.
 ^|B |A WCMP record SHOULD provide a `+properties.status.id+` property to identify the concept of the status (see Annex D for possible codelists to use).
-^|C |A WCMP record SHOULD provide a `+properties.status.title+` property to provide a human readable title for the concept.
-^|D |A WCMP record SHOULD provide a `+properties.status.description+` property to provide a human readable description for the concept.
+^|C |A WCMP record SHOULD provide a `+properties.status.title+` property to provide a human-readable title for the concept.
+^|D |A WCMP record SHOULD provide a `+properties.status.description+` property to provide a human-readable description for the concept.
 ^|E |A WCMP record SHOULD provide a `+properties.status.url+` property to provide further description of the concept via the given URI.
 |===
 //rec11
diff --git a/standard/requirements/core/REQ_conformance.adoc b/standard/requirements/core/REQ_conformance.adoc
@@ -2,7 +2,7 @@
 [width="90%",cols="2,6a"]
 |===
 ^|*Requirement {counter:req-id}* |*/req/core/conformance*
-^|A |A WCMP record SHALL provide information on conformance via the OARec record `+conformsTo+` property.
+^|A |A WCMP record SHALL provide information on conformance via the OGC API – Records (OARec) record `+conformsTo+` property.
 ^|B |The `+conformsTo+` property SHALL advertise conformance to WCMP.
 |===
 //req3
diff --git a/standard/requirements/core/REQ_contacts.adoc b/standard/requirements/core/REQ_contacts.adoc
@@ -4,6 +4,6 @@
 ^|*Requirement {counter:req-id}* |*/req/core/contacts*
 ^|A |A WCMP record SHALL provide at least one contact via the `+properties.contacts+` property.
 ^|B |The `+properties.contacts+` SHALL provide an `+organization+` property.
-^|C |The `+roles+` property, when specified, SHALL provide a role type from the WCMP role type codelist.
+^|C |The `+roles+` property, when specified, SHALL provide a role type from the WCMP role type code list.
 |===
 //req11
diff --git a/standard/requirements/core/REQ_identifier.adoc b/standard/requirements/core/REQ_identifier.adoc
@@ -4,7 +4,7 @@
 ^|*Requirement {counter:req-id}* |*/req/core/identifier*
 ^|A |A WCMP record SHALL provide an identifier via the `+id+` property.
 ^|B |The `+id+` property SHALL have the following notation: `+urn:wmo:md:{centre_id}:{local_identifier}+`.
-^|C |The ``centre_id`` SHALL be based on the associated vocabulary specified in Appendix D: WIS2 Topic Hierarchy.
+^|C |The ``centre_id`` SHALL be based on the associated vocabulary specified in Appendix D. WIS2 Topic Hierarchy.
 ^|D |The `+id+` property SHALL include a local identifier as defined by the data publisher.  The local identifier SHALL NOT have spaces or accented characters.
 |===
 //req2
diff --git a/standard/requirements/core/REQ_links.adoc b/standard/requirements/core/REQ_links.adoc
@@ -5,7 +5,7 @@
 ^|A |A WCMP record SHALL provide a `+links+` property.
 ^|B |The `+links+` property SHALL contain at least one link to the data access service allowing users to download the data.
 ^|C |The `+links+` property SHALL contain a Web Accessible Folder (WAF) or an API link for non-real-time data (such as climate records or hydrometric data archives).
-^|D |The `+links+` property SHALL contain access control information for data, products, and services that require authentication or authorization.
+^|D |The `+links+` property SHALL contain access control information for data, products and services that require authentication or authorization.
 ^|E |For representing MQTT links, the URI scheme SHALL be `+mqtt+` (default port 1883) or `+mqtts+` (default port 8883) for secure transport layer security (TLS) encrypted connections.
 ^|F |The `+links+` property SHALL provide the `channel` property of the MQTT topic for real-time data under which the data publication notifications will be accessible from the WIS2 Global Broker, following the WIS2 Topic Hierarchy.
 ^|G |The `+links+` property SHALL include a valid link:https://www.iana.org/assignments/link-relations/link-relations.xml[IANA] link relation or a link:https://codes.wmo.int/wis/link-type[WIS link type] code.

diff --git a/standard/requirements/core/REQ_type.adoc b/standard/requirements/core/REQ_type.adoc
@@ -3,6 +3,6 @@
 |===
 ^|*Requirement {counter:req-id}* |*/req/core/type*
 ^|A |A WCMP record SHALL provide a `+properties.type+` property.
-^|B |The `+properties.type+` property SHALL be a valid code from the link:https://codes.wmo.int/wis/resource-type[WIS resource type] codelist.
+^|B |The `+properties.type+` property SHALL be a valid code from the link:https://codes.wmo.int/wis/resource-type[WIS resource type] code list.
 |===
 //req4
diff --git a/standard/requirements/core/REQ_validation.adoc b/standard/requirements/core/REQ_validation.adoc
@@ -3,7 +3,7 @@
 |===
 ^|*Requirement {counter:req-id}* |*/req/core/validation*
 ^|A |Each WCMP record SHALL validate without error against the WCMP schema.
-^|B |Each WCMP record SHALL provide `+id+`, `+type+`, `+geometry+` and `+properties+` properties for GeoJSON compliance.
+^|B |Each WCMP record SHALL provide id (see <<_1_4_identifier>>), type (see <<_1_6_properties_type>>), geometry  (see <<_1_11_1_geospatial_extent>>) and properties (see, for example, <<_1_7_properties_title>>) for GeoJSON compliance.
 ^|C |The `+type+` property SHALL be set to a fixed value of `+Feature+` for GeoJSON compliance.
 |===
 //req1
diff --git a/standard/requirements/requirements_class_core.adoc b/standard/requirements/requirements_class_core.adoc
@@ -7,5 +7,5 @@
 |Dependency |link:https://json-schema.org[JSON Schema] (2022)
 |Dependency |The GeoJSON Format link:https://datatracker.ietf.org/doc/html/rfc7946[(IETF: RFC-7946 (2016))] 
 |Dependency |OGC API - Features - Part 1: Core corrigendum link:https://docs.opengeospatial.org/is/17-069r4/17-069r4.html[(OGC: OGC 17-069r)]
-|Pre-conditions |The record conforms to OGC API - Records - Core: Part 1: Requirements Class: Record Core
+|Preconditions |The record conforms to the Requirements Class “Record Core” of link:https://docs.ogc.org/DRAFTS/20-004.html[OGC API - Records - Part 1: Core]
 |===