Rebuilding generated documents.

tdwg · Nov 3, 2024 · e32d8e3 · e32d8e3
1 parent 10c4978
commit e32d8e3
Show file tree

Hide file tree

Showing 8 changed files with 23 additions and 71 deletions.
diff --git a/tg2/_review/docs/extension/bdqffdq/index.md b/tg2/_review/docs/extension/bdqffdq/index.md
@@ -133,11 +133,13 @@ The following namespace abbreviations are used in this document:
 | ------------ | --------- | ---------- | ------- |
 | Name (rdf:value) | normative | Idiomatic property used for structured values. | [https://rs.tdwg.org/ bdqffdq/terms/ COMPLETE](https://rs.tdwg.org/bdqffdq/terms/COMPLETE) |
 | Type (rdf:type) | normative | The subject is an instance of a class. | [https://rs.tdwg.org/ bdqffdq/terms/ ResponseResult](https://rs.tdwg.org/bdqffdq/terms/ResponseResult) |
-| Range (rdfs:range) | normative | A range of the subject property. In present context: shown as either a simple range in the form of a class, or as an owl:restriction in the form [ owl:someValuesFrom bdqffdq:targetedMeasure ]. | ne663fee9794549b8b21c1e571b33b72cb1 |
+| Range (rdfs:range) | normative | A range of the subject property. In present context: shown as either a simple range in the form of a class, or as an owl:restriction in the form [ owl:someValuesFrom bdqffdq:targetedMeasure ]. | n2ec6dc1cb27f47a9b5193596d8c5298eb1 |
 | DifferentFrom (owl:differentFrom) | normative | The property that determines that two given individuals are different. | [https://rs.tdwg.org/ bdqffdq/terms/ NOT_COMPLETE](https://rs.tdwg.org/bdqffdq/terms/NOT_COMPLETE) |
 | Label (rdfs:label) | normative | A human-readable name for the subject. TDWG SDS: A a word or short phrase that serves as a human-readable name for the term. | COMPLETE |
 
 
+Terms used to describe the terms in this vocabulary follow the guidance of the [TDWG Standards Documentation Standard (SDS)](https://www.tdwg.org/standards/sds/).  Term definitions include the definition of the underlying RDF vocabulary term, and may include a TDWG specific meaning from the SDS, and may also include specific definition in this local context.
+
 ## 2 Use of Terms (normative)
 
 Due to the requirements of [bdqffdq](https://rs.tdwg.org/bdqffdq/terms), resources MUST be used as values from the `bdq:` namespace, except for bdq:empty and bdq:notEmpty, where controlled value strings MUST be used.

diff --git a/tg2/_review/docs/intro/index.md b/tg2/_review/docs/intro/index.md
@@ -89,7 +89,11 @@ This document is a general introduction to BDQ Core standard designed for anyone
 
 ### 1.3 Associated Documents
 
-Those who want a quick view of the Tests should consult the [BDQ Core Tests Quick Reference Guide](../terms/bdqcore/index.md).  Those interested in more detail on the interpretation of test results should consult the [BDQ Core User's Guide](../guide/users/index.md "BDQ Core Users Guide"), while those interested in the implementation of tests following the BDQ Core should consult the [BDQ Core Implementer's Guide](../guide/implementers/index.md "BDQ Core Implementation Guide").  Those interested in composing new tests, or seeking to represent test results as linked open data should consult the [Framework Ontology guide](../guide/bdqffdq/index.md).
+- Those who want a quick view of the Tests should consult the [BDQ Core Tests Quick Reference Guide](../terms/bdqcore/index.md).  
+- Those interested in more detail on the interpretation of test results should consult the [BDQ Core User's Guide](../guide/users/index.md "BDQ Core Users Guide").
+- Those interested in the implementation of tests following the BDQ Core should consult the [BDQ Core Implementer's Guide](../guide/implementers/index.md "BDQ Core Implementation Guide").
+- Those interested in composing new tests, or seeking to represent test results as linked open data should consult the [Framework Ontology guide](../guide/bdqffdq/index.md).
+- The documentation of BDQ Core follows the guidance of the [TDWG Standards Documentation Standard (SDS)](https://www.tdwg.org/standards/sds/).
 
 ### 1.4. Status of the Content of This Document
 

diff --git a/tg2/_review/docs/list/bdq/index.md b/tg2/_review/docs/list/bdq/index.md
@@ -103,6 +103,8 @@ The following namespace abbreviations are used in this document:
 | Term Name (rdf:value) | normative | Idiomatic property used for structured values. TDWG SDS: The term name is a controlled value that represents the class, property, or concept described by the term definition. | Alien-Species |
 
 
+Terms used to describe the terms in this vocabulary follow the guidance of the [TDWG Standards Documentation Standard (SDS)](https://www.tdwg.org/standards/sds/).  Term definitions include the definition of the underlying RDF vocabulary term, and may include a TDWG specific meaning from the SDS, and may also include specific definition in this local context.
+
 ## 2 Use of Terms (normative)
 
 Due to the requirements of [bdqffdq](https://rs.tdwg.org/bdqffdq/terms), resources MUST be used as values from the `bdq:` namespace, except for bdq:empty and bdq:notEmpty, where controlled value strings MUST be used.

diff --git a/tg2/_review/docs/list/bdqcore/index.md b/tg2/_review/docs/list/bdqcore/index.md
@@ -144,7 +144,9 @@ There are four types of BDQ Core Tests: Validations, Issues, Amendments and Meas
 
 ### 1.9 Key to Vocabulary Terms
 
-These "Test Descriptors" are terms that are necessary to comprehensively describe each Test. Some terms, such as the IRI and term_localName are intended for machine consumption. Some terms such as the "Description" are designed to be human-readable and to be understood by consumers of biodiversity data quality reports. Terms such as the "Specification" ensure that implementers have no ambiguity about how the Test should be coded.
+These "Test Descriptors" (terms used to describe the terms in this vocabulary) are the set of terms that are necessary to comprehensively describe each Test. Some terms, such as the IRI and term_localName are intended for machine consumption. Some terms such as the "Description" are designed to be human-readable and to be understood by consumers of biodiversity data quality reports. Terms such as the "Specification" ensure that implementers have no ambiguity about how the Test should be coded.
+
+Terms used to describe the terms in this vocabulary follow the guidance of the [TDWG Standards Documentation Standard (SDS)](https://www.tdwg.org/standards/sds/).  Term definitions include the definition of the underlying RDF vocabulary term, and may include a TDWG specific meaning from the SDS, and may also include specific definition in this local context.
 
 | Label (Term) | Normative | Definition | Example |
 | ------------ | --------- | ---------- | ------- |
@@ -153,7 +155,7 @@ These "Test Descriptors" are terms that are necessary to comprehensively describ
 | Term Name (rdf:value) | normative | Idiomatic property used for structured values. TDWG SDS: The term name is a controlled value that represents the class, property, or concept described by the term definition. | 3c2590c7-af8a-4eb4-af57-5f73ba9d1f8e |
 | Modified (dcterms:issued) |  | Date of formal issuance of the resource. TDWG SDS: The date in ISO 8601 Date format on which the most recent version of the term was issued. In present context: The most recent date for any change to any element of the test. | 2024-09-04 |
 | Label (rdfs:label) | normative | A human-readable name for the subject. TDWG SDS: A a word or short phrase that serves as a human-readable name for the term. In present context: A descriptive label for humans to use to identify the test. | AMENDMENT_COORDINATES_FROM_VERBATIM |
-| Preferred Label (skos:prefLabel) | non-normative | The preferred lexical label for a resource, in a given language. In present context: An easy to read label for the test, similar to the Label, but in words. | Amendment Coordinates From Verbatim |
+| Preferred Label (skos:prefLabel) | normative | The preferred lexical label for a resource, in a given language. In present context: An easy to read label for the test, similar to the Label, but in words. | Amendment Coordinates From Verbatim |
 | DateLastUpdated (bdqffdq:hasDateLastUpdated) |  | Date of the most recent dcterms:Issued for this class with a change that would be pertenent to implementation. | 2024-08-20 |
 | Guids for Arguments (bdqffdq:Argument) | normative | A value that, when provided to a test Specification to replace a Parameter changes the behavior of the test in a defined manner. | 7ecc692d-e65f-4ea5-9d54-04421ec96ab4 |
 | Guid for Specification (bdqffdq:Specification) | normative | A specific statement about how to evaluate a data quality need. | urn:uuid:1e16fbb3-0c8d-4f23-bf55-68e159ab2b04 |
@@ -184,73 +186,6 @@ These "Test Descriptors" are terms that are necessary to comprehensively describ
 | Developed As Github Issue (skos:historyNote) | non-normative | A note about the past state/use/meaning of a concept. In present context: A link to the github issue that provided rationale management recording a history (changes and comments) of the development of the test. | [https://api.github.com/repos/tdwg/bdq/issues/ 32](https://api.github.com/repos/tdwg/bdq/issues/32) |
 
 
-<!--- TODO: Confirm that metadata for 1.9 has these values ---> 
-<!---
-In Section 4 the values of the rdfs:Label, skos:prefLabel, Versioned IRI,
-Resource Type, Specification, Information Elements ActedUpon, Information
-Elements Consulted, and Parameters are normative.  The values of
-Description, Examples, Use Cases, and Notes are non-normative.
---->
-
-<!--- @Tasilee text for comparison with generated table.  Some of these will need to be incorporated into definitions in the generated table.
-
-**Term Name**. The full identifier for the Test in the form of "bdqcore:"test GUID, for example "bdqcore:42408a00-bf71-4892-a399-4325e2bc1fb8"
-
-**Label**. An easy-to-read English descriptive label in the form of Test Type_Darwin Core Term(s) used_criterion, for example "VALIDATION_BASISOFRECORD_STANDARD"
-
-**iri**. A composite of the web address of the Test with its GUID and date last updated appended, for example " https://rs.tdwg.org/bdqcore/terms/version/15f78619-811a-4c6f-997a-a4c7888ad849-2023-09-18 "
-
-**term-iri**. The unversioned form of the iri, as for example " https://rs.tdwg.org/bdqcore/terms/15f78619-811a-4c6f-997a-a4c7888ad849" 
-
-**issued**. The most recent date for any change to any element of the Test (ISO 8601), for example "2023-01-17" 
-
-**DateLastUpdated**. The date an element of the Test that would affect implementations was last updated (ISO 8601), for example "2024-09-30" 
-
-**prefLabel**. An easy to read label for the Test, for example "Validation dcterms:license Standard"
-
-**IE Class**. The Darwin Core Information Element class, for example "Record-level"
-
-**InformationElement:ActedUpon**. The [Darwin Core Terms](https://dwc.tdwg.org/list/) (Darwin Core Maintenance Group 2021) that are the focus of the Test, for example "dwc:country, dwc:countryCode"
-
-**InformationElement:Consulted**. The [Darwin Core Terms](https://dwc.tdwg.org/list/) (Darwin Core Maintenance Group 2021) that are required to be consulted in the process of evaluating the InformationElements:ActedUpon, for example "dwc:countryCode"
-
-**Specification**. The formal definition of how the Test must be implemented, for example "EXTERNAL_PREREQUISITES_NOT_MET if the bdq:sourceAuthority is not available; INTERNAL_PREREQUISITES_NOT_MET if the dwc:countryCode is bdq:Empty; COMPLIANT if dwc:countryCode can be unambiguously interpreted as a valid ISO 3166-1-alpha-2 country code in the bdq:sourceAuthority; otherwise NOT_COMPLIANT"
-
-**AuthoritiesDefaults**. The source authority that the Test must consult to provide a response. The format is ideally in two parts, the first part referring to what the authority is, and if available, a second part that provides an API that can be used for evaluation. For example "bdq:sourceAuthority default = "ISO 3166 Country Codes" {[ https://www.iso.org/iso-3166-country-codes.html]} {ISO 3166-1-alpha-2 Country Code search [https://www.iso.org/obp/ui/#search]}"
-
-**Description**. A breif English description of what the Test does
-
-**Criterion Label**. A combination of the Dimension (bdqdim:) value and the bdqcrit: value, for example "Conformance: standard"
-
-**Type**. The type of the Test, one of Validation, Issue, Amendment or Measure, for example "**VALIDATION**_DECIMALLONGITUDE_INRANGE"
-
-**Resource Type**. The Test either operates on a Single Record or Multiple Records 
-
-**Dimension**. The Data Quality Dimension focus of the Test: One of "Completeness", "Conformance", "Consistency", "Likeliness", "Reliability" or "Resolution"
-
-**Enhancement**. For Amendment Tests: The type of enhancement that is bring proposed. One of "Assumed Default", "Converted", "Fill in From", "STandardized" and "Transposed".
-
-**Examples**. Two examples of input and output data and Test responses for a 'pass' and 'fail' case, for example "[dwc:country="Eswatini": Response.status=RUN_HAS_RESULT, Response.result=COMPLIANT, Response.comment="dwc:country is a valid country name in the bdq:sourceAuthority"], [dwc:country="Tasmania": Response.status=RUN_HAS_RESULT, Response.result=NOT_COMPLIANT, Response.comment="Tasmania is not found at the level of national in the bdq:sourceAuthority"]
-
-**Source**. The origin of the concept of the Test, for example "ALA" (The Atlas of Living Australia)
-
-**References**. The minimum set of references that are required for an understanding of the nature of the Test
-
-**Notes**. Additional information that may not be obvious from the Specification, for example for the Test [VALIDATION_COUNTRYCODE_STANDARD](https://rs.tdwg.org/bdqcore/terms/0493bcfb-652e-4d17-815b-b0cce0742fbe), the Notes are "Locations outside of a jurisdiction covered by a country code may have a value in the field dwc:countryCode, the ISO user defined codes include XZ used by the UN for installations on the high seas and suitable for a marker for the high seas.  Also available in the ISO user defined codes is ZZ, used by GBIF to mark unknown countries.  This Test should accept both XZ and ZZ as COMPLIANT country codes. This Test must return NOT_COMPLIANT if there is leading or trailing whitespace or there are leading or trailing non-printing characters".
-
-**UseCases**. An example of one or more Use Cases where this Test would apply. Note that one Test will likely have many Use Cases, and one Use Case will likely have many applicable Tests.
-
-**skos:historyNote**. A link (URL) to the GitHub issue that provides a history (changes and comments) of the development of the Test, for example https://github.com/tdwg/bdq/issues/36.
-
-**bdqffdq:AmendmentMethod**. For AMENDMENTs: A URN to the AmendmentMethodLabel in for form of "urn:uuid:GUID", for example "urn:uuid:1f38a0bc-4e1f-47a4-bd4a-b6be1c9a456a"
-
-**AmendmentMethod label**. For AMENDMENTs: The nature of the method of AMENDMENT, for example "AmendmentMethod: Proposes an amendment to the value of dc:type using the DCMI type vocabulary. Amendment for SingleRecord with Specification for: [AMENDMENT_DCTYPE_STANDARDIZED](https://rs.tdwg.org/bdqcore/terms/bd385eeb-44a2-464b-a503-7abe407ef904).
-
-**bdqffdq:Specification**. For AMENDMENTs: A urn in the form of "urn:uuid:GUID" that points to the Specification label, for example "urn:uuid:825f551a-2adf-4509-9f95-5a42601a8e88"
-
-**Specification label**. A descriptive label for the specification of an AMENDMENT, for example "Specification for: AMENDMENT_LICENSE_STANDARDIZED".
---->
-
 ## 2 Normative Guidance
 
 See the [landing page](../../bdqcore/index.md) for normative guidance on the use of bdqcore terms.

diff --git a/tg2/_review/docs/list/bdqcrit/index.md b/tg2/_review/docs/list/bdqcrit/index.md
@@ -108,6 +108,8 @@ The following namespace abbreviations are used in this document:
 | Term Name (rdf:value) | normative | Idiomatic property used for structured values. TDWG SDS: The term name is a controlled value that represents the class, property, or concept described by the term definition. | Complete |
 
 
+Terms used to describe the terms in this vocabulary follow the guidance of the [TDWG Standards Documentation Standard (SDS)](https://www.tdwg.org/standards/sds/).  Term definitions include the definition of the underlying RDF vocabulary term, and may include a TDWG specific meaning from the SDS, and may also include specific definition in this local context.
+
 ## 2 Use of Terms (normative)
 
 Due to the requirements of [bdqffdq](https://rs.tdwg.org/bdqffdq/terms), resources MUST be used values of `bdqffdq:Criterion`.

diff --git a/tg2/_review/docs/list/bdqdim/index.md b/tg2/_review/docs/list/bdqdim/index.md
@@ -109,6 +109,8 @@ The following namespace abbreviations are used in this document:
 | Term Name (rdf:value) | normative | Idiomatic property used for structured values. TDWG SDS: The term name is a controlled value that represents the class, property, or concept described by the term definition. | Completeness |
 
 
+Terms used to describe the terms in this vocabulary follow the guidance of the [TDWG Standards Documentation Standard (SDS)](https://www.tdwg.org/standards/sds/).  Term definitions include the definition of the underlying RDF vocabulary term, and may include a TDWG specific meaning from the SDS, and may also include specific definition in this local context.
+
 ## 2 Use of Terms (normative)
 
 Due to the requirements of [bdqffdq](https://rs.tdwg.org/bdqffdq/terms), resources MUST be used as values of `bdqffdq:dataQualityDimension`.

diff --git a/tg2/_review/docs/list/bdqenh/index.md b/tg2/_review/docs/list/bdqenh/index.md
@@ -108,6 +108,8 @@ The following namespace abbreviations are used in this document:
 | Term Name (rdf:value) | normative | Idiomatic property used for structured values. TDWG SDS: The term name is a controlled value that represents the class, property, or concept described by the term definition. | AssumedDefault |
 
 
+Terms used to describe the terms in this vocabulary follow the guidance of the [TDWG Standards Documentation Standard (SDS)](https://www.tdwg.org/standards/sds/).  Term definitions include the definition of the underlying RDF vocabulary term, and may include a TDWG specific meaning from the SDS, and may also include specific definition in this local context.
+
 ## 2 Use of Terms (normative) 
 
 Due to the requirements of [bdqffdq](https://rs.tdwg.org/bdqffdq/terms), resources MUST be used as values of `bdqffdq:Enhancement`.

diff --git a/tg2/_review/docs/list/bdqffdq/index.md b/tg2/_review/docs/list/bdqffdq/index.md
@@ -139,6 +139,9 @@ The following namespace abbreviations are used in this document:
 | Term Name (rdf:value) | normative | Idiomatic property used for structured values. TDWG SDS: The term name is a controlled value that represents the class, property, or concept described by the term definition. | [https://rs.tdwg.org/ bdqffdq/terms/ AbstractInformationElement](https://rs.tdwg.org/bdqffdq/terms/AbstractInformationElement) |
 
 
+Terms used to describe the terms in this vocabulary follow the guidance of the [TDWG Standards Documentation Standard (SDS)](https://www.tdwg.org/standards/sds/).  Term definitions include the definition of the underlying RDF vocabulary term, and may include a TDWG specific meaning from the SDS, and may also include specific definition in this local context.
+
+
 ## 2 Use of Terms (normative)
 
 Due to the requirements of [bdqffdq](https://rs.tdwg.org/bdqffdq/terms), resources MUST be used as values from the `bdq:` namespace, except for bdq:empty and bdq:notEmpty, where controlled value strings MUST be used.