From 85f2d02d4b7c4e16a2da2125abc4c30d506c3525 Mon Sep 17 00:00:00 2001 From: Rebecca Younes Date: Thu, 18 Apr 2024 11:24:55 -0400 Subject: [PATCH 1/6] Remove occupies predicates and shorten isGeographicallyContainedIn to isGeoContainedIn --- docs/release_notes/issue812-geo-predicates | 4 +++ ontologies/gistCore.ttl | 31 +++------------------- 2 files changed, 8 insertions(+), 27 deletions(-) create mode 100644 docs/release_notes/issue812-geo-predicates diff --git a/docs/release_notes/issue812-geo-predicates b/docs/release_notes/issue812-geo-predicates new file mode 100644 index 00000000..d6edc9fb --- /dev/null +++ b/docs/release_notes/issue812-geo-predicates @@ -0,0 +1,4 @@ +### Major Updates + +- Removed `gist:occupiesGeographically` and `gist:occupiesGeographicallyPermanently`, and replaced with `gist:hasPhysicalLocation` in class restriction. Issue [#809](https://github.com/semanticarts/gist/issues/809). +- Shortened local name of `gist:isGeographicallyContainedin` to `isGeoContainedin`. Issue [#812](https://github.com/semanticarts/gist/issues/812). diff --git a/ontologies/gistCore.ttl b/ontologies/gistCore.ttl index 46ed37e3..751793b2 100644 --- a/ontologies/gistCore.ttl +++ b/ontologies/gistCore.ttl @@ -1115,7 +1115,7 @@ gist:GeoVolume [ a owl:Restriction ; owl:onProperty [ - owl:inverseOf gist:isGeographicallyContainedIn ; + owl:inverseOf gist:isGeoContainedIn ; ] ; owl:someValuesFrom gist:GeoPoint ; ] @@ -1294,7 +1294,7 @@ gist:Landmark gist:PhysicalIdentifiableItem [ a owl:Restriction ; - owl:onProperty gist:occupiesGeographicallyPermanently ; + owl:onProperty gist:hasPhysicalLocation ; owl:someValuesFrom [ a owl:Class ; owl:unionOf ( @@ -3436,14 +3436,14 @@ gist:isExpressedIn skos:prefLabel "is expressed in"^^xsd:string ; . -gist:isGeographicallyContainedIn +gist:isGeoContainedIn a owl:ObjectProperty , owl:TransitiveProperty ; rdfs:domain gist:Place ; rdfs:range gist:Place ; - skos:definition "Relates one place to another place that contains the first."^^xsd:string ; + skos:definition "Relates one place to another that contains it."^^xsd:string ; skos:prefLabel "is geographically contained in"^^xsd:string ; . @@ -3633,29 +3633,6 @@ gist:numericValue skos:prefLabel "numeric value"^^xsd:string ; . -gist:occupiesGeographically - a owl:ObjectProperty ; - rdfs:domain [ - a owl:Class ; - owl:unionOf ( - gist:PhysicalIdentifiableItem - gist:PhysicalSubstance - ) ; - ] ; - rdfs:range gist:Place ; - owl:deprecated "true"^^xsd:boolean ; - skos:definition "A thing occupies are region"^^xsd:string ; - skos:prefLabel "occupies geographically"^^xsd:string ; - . - -gist:occupiesGeographicallyPermanently - a owl:ObjectProperty ; - rdfs:subPropertyOf gist:occupiesGeographically ; - owl:deprecated "true"^^xsd:boolean ; - skos:definition "To be in a fixed position on the earth"^^xsd:string ; - skos:prefLabel "occupies geographically permanently"^^xsd:string ; - . - gist:occursIn a owl:ObjectProperty ; skos:definition "The geospatial place where something happened or will happen"^^xsd:string ; From 721a0dfd67622ced4ba864d9dfe999d0a7d05896 Mon Sep 17 00:00:00 2001 From: Rebecca Younes Date: Thu, 18 Apr 2024 11:40:36 -0400 Subject: [PATCH 2/6] Update section on formatting pref labels --- docs/gistStyleGuide.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/gistStyleGuide.md b/docs/gistStyleGuide.md index dd6df46e..319c2450 100644 --- a/docs/gistStyleGuide.md +++ b/docs/gistStyleGuide.md @@ -11,6 +11,7 @@ - [Labels](#labels) - [Classes](#classes) - [Properties](#properties) + - [Valid Exceptions](#valid-exceptions) - [gist Definition of Title Case](#gist-definition-of-title-case) - [Annotations](#annotations) - [Conventions for Use](#conventions-for-use) @@ -118,7 +119,7 @@ Note: As of version 12.0.0, gist itself does not itself follow the infix convent ## Labels -*The* following conventions apply to `skos:prefLabel` but *not* `skos:altLabel`. +The following conventions apply to `skos:prefLabel` but *not* `skos:altLabel`, which by nature may be idiosyncratic. ### Classes @@ -131,6 +132,11 @@ Note: As of version 12.0.0, gist itself does not itself follow the infix convent - Lower case - Normalized to natural language standards. E.g., hyphens inserted, acronyms in all caps, proper nouns capitalized, etc. - Examples: *has unit of measure*, *has SSN*, *unit symbol Unicode* +- In some cases the label may deviate lexically from the local name. For example, the predicate `gist:isGeoContainedIn` uses a shortened form of "geographically" for conciseness. The `skos:prefLabel` uses the fully spelled out word: "is geographically contained in." + +### Valid Exceptions + +Occasionally there is a valid reason to deviate from the label format conventions. Since this will fail the SHACL validation constraints applied to `skos:prefLabel`s during the ontology build and release process, add the predicate to the `gistValidationAnnotations.ttl` file so that label validation will be skipped. ### gist Definition of Title Case From c3f23225659b641ad549e5dc0413e60ff964fa02 Mon Sep 17 00:00:00 2001 From: Rebecca Younes Date: Thu, 18 Apr 2024 11:53:24 -0400 Subject: [PATCH 3/6] Add release note; style guide correction --- docs/gistStyleGuide.md | 2 +- docs/release_notes/issue812-geo-predicates | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/gistStyleGuide.md b/docs/gistStyleGuide.md index 319c2450..aed9deb2 100644 --- a/docs/gistStyleGuide.md +++ b/docs/gistStyleGuide.md @@ -81,7 +81,7 @@ Some of the examples resulted in changes to gist `10.0.0`, others are hypothetic || `usesTimeZoneStandard`, not `timeZoneStandardUsed` | | Prefix "is" to "-ed" forms, both past participles and adjectives | `isGovernedBy`, not `governedBy` | || `isCharacterizedBy`, not `characterizedBy` | -| Prefer an ordinary verb to "hasX" or "isX", even in a pair of inverses | `follows`, not `isPrecededBy`, even when inverse `precedes` exists | +| Prefer an ordinary verb to "hasX" or "isX" | `precedes`, not `isFollowedBy` | | "At" rather than "on" for datetimes | `isRecordedAt`, not `isRecordedOn`. | | Present tense only with minimal exceptions when the meaning is inherently in the past | `isRenderedOn`, not `wasRenderedOn`, but `wasLastModifiedBy` rather than `isLastModifiedBy` | || `precedes`, not `preceded` | diff --git a/docs/release_notes/issue812-geo-predicates b/docs/release_notes/issue812-geo-predicates index d6edc9fb..dfcaadf7 100644 --- a/docs/release_notes/issue812-geo-predicates +++ b/docs/release_notes/issue812-geo-predicates @@ -2,3 +2,7 @@ - Removed `gist:occupiesGeographically` and `gist:occupiesGeographicallyPermanently`, and replaced with `gist:hasPhysicalLocation` in class restriction. Issue [#809](https://github.com/semanticarts/gist/issues/809). - Shortened local name of `gist:isGeographicallyContainedin` to `isGeoContainedin`. Issue [#812](https://github.com/semanticarts/gist/issues/812). + +### Patch Updates + +- Added notes on exceptions to `skos:prefLabel` formatting conventions to [gist Style Guide](#gistStyleGuide.md). From 7aef579be69befceef1e97a763a224b2a59735eb Mon Sep 17 00:00:00 2001 From: Rebecca Younes Date: Thu, 18 Apr 2024 12:02:00 -0400 Subject: [PATCH 4/6] Rewrite sections on pref label convention deviations --- docs/gistStyleGuide.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/gistStyleGuide.md b/docs/gistStyleGuide.md index aed9deb2..2ba917ec 100644 --- a/docs/gistStyleGuide.md +++ b/docs/gistStyleGuide.md @@ -131,12 +131,14 @@ The following conventions apply to `skos:prefLabel` but *not* `skos:altLabel`, w - Lower case - Normalized to natural language standards. E.g., hyphens inserted, acronyms in all caps, proper nouns capitalized, etc. -- Examples: *has unit of measure*, *has SSN*, *unit symbol Unicode* -- In some cases the label may deviate lexically from the local name. For example, the predicate `gist:isGeoContainedIn` uses a shortened form of "geographically" for conciseness. The `skos:prefLabel` uses the fully spelled out word: "is geographically contained in." +- Examples: *has unit of measure*, *has SSN* ### Valid Exceptions -Occasionally there is a valid reason to deviate from the label format conventions. Since this will fail the SHACL validation constraints applied to `skos:prefLabel`s during the ontology build and release process, add the predicate to the `gistValidationAnnotations.ttl` file so that label validation will be skipped. +There may occasionally be valid reasons to deviate from the conventions stated here: + +- Deviation from wording of the local name. For example, the predicate `gist:isGeoContainedIn` uses a shortened form of "geographically" for conciseness. The `skos:prefLabel` uses the fully spelled out word: "is geographically contained in." +- Deviation from typographical conventions such as case. For example, a proper name in a property label could appropriately be capitalized. Since this will fail the SHACL validation constraints during the ontology build and release process, add the term to the `gistValidationAnnotations.ttl` file so that label validation will be skipped. ### gist Definition of Title Case From f7aeabf326a563951df07879674aaeeed6e89e8a Mon Sep 17 00:00:00 2001 From: Rebecca Younes Date: Thu, 23 May 2024 10:40:10 -0400 Subject: [PATCH 5/6] Fix section on non-conforming labels --- docs/gistStyleGuide.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/gistStyleGuide.md b/docs/gistStyleGuide.md index 2ba917ec..fd34146f 100644 --- a/docs/gistStyleGuide.md +++ b/docs/gistStyleGuide.md @@ -12,6 +12,7 @@ - [Classes](#classes) - [Properties](#properties) - [Valid Exceptions](#valid-exceptions) + - [gist:nonConformingLabel](#gistnonconforminglabel) - [gist Definition of Title Case](#gist-definition-of-title-case) - [Annotations](#annotations) - [Conventions for Use](#conventions-for-use) @@ -131,14 +132,17 @@ The following conventions apply to `skos:prefLabel` but *not* `skos:altLabel`, w - Lower case - Normalized to natural language standards. E.g., hyphens inserted, acronyms in all caps, proper nouns capitalized, etc. -- Examples: *has unit of measure*, *has SSN* +- Examples: *has unit of measure*, *has SSN*, *Unicode symbol*, *W2* ### Valid Exceptions There may occasionally be valid reasons to deviate from the conventions stated here: - Deviation from wording of the local name. For example, the predicate `gist:isGeoContainedIn` uses a shortened form of "geographically" for conciseness. The `skos:prefLabel` uses the fully spelled out word: "is geographically contained in." -- Deviation from typographical conventions such as case. For example, a proper name in a property label could appropriately be capitalized. Since this will fail the SHACL validation constraints during the ontology build and release process, add the term to the `gistValidationAnnotations.ttl` file so that label validation will be skipped. + +### gist:nonConformingLabel + +- The general label conventions have been captured in SHACL shapes which are run during the ontology build and release process and the repository continuous integration script. These shapes do not allow for special cases like capitalized proper names. To prevent validation failures, add the annotation `gist:nonConformingLabel true` to the term in the `gistValidationAnnotations` ontology so that label validation will be skipped. ### gist Definition of Title Case From fba3d2932468fac32d4811037a3a186403259f13 Mon Sep 17 00:00:00 2001 From: Rebecca Younes Date: Thu, 23 May 2024 10:48:17 -0400 Subject: [PATCH 6/6] Revise release note --- docs/release_notes/issue812-geo-predicates | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release_notes/issue812-geo-predicates b/docs/release_notes/issue812-geo-predicates index dfcaadf7..8e024ec0 100644 --- a/docs/release_notes/issue812-geo-predicates +++ b/docs/release_notes/issue812-geo-predicates @@ -5,4 +5,4 @@ ### Patch Updates -- Added notes on exceptions to `skos:prefLabel` formatting conventions to [gist Style Guide](#gistStyleGuide.md). +- Added section on use of `gist:nonConformingLabel` annotation to `gistStyleGuide.md`.