Merge branch 'main' into tools

EuroCRIS · Oct 6, 2023 · 4fe1307 · 4fe1307
2 parents bd9d944 + 5ff09ae
commit 4fe1307
Show file tree

Hide file tree

Showing 12 changed files with 231 additions and 165 deletions.
diff --git a/README.md b/README.md
@@ -122,6 +122,8 @@ for instance the [ORCID Identifier](./entities/ORCID_Identifier.md).
 * [Wikidata ID Type](./datatypes/Wikidata_ID.md)
 * [Person Name](./datatypes/Person_Name.md)
 * [Postal Address](./datatypes/Postal_Address.md)
+  * [Simple Postal Address](./datatypes/Simple_Postal_Address.md)
+  * [Structured Postal Address](./datatypes/Structured_Postal_Address.md)
 * [Language](./datatypes/Language.md), [Country](./datatypes/Country.md), [Script](./datatypes/Script.md)
 * [Language Tag](./datatypes/Language_Tag.md)
 * [Monetary Amount](./datatypes/Monetary_Amount.md)

diff --git a/datatypes/Postal_Address.md b/datatypes/Postal_Address.md
@@ -4,13 +4,10 @@ The location assigned to an [Organisation Unit](../entities/Organisation_Unit.md
 
 ## Components
 
-- street : [Multilingual String](../datatypes/Multilingual_String.md)
-- city : [Multilingual String](../datatypes/Multilingual_String.md)
-- ZIP code: [Multilingual String](../datatypes/Multilingual_String.md)
-- stateOrProvince: [Multilingual String](../datatypes/Multilingual_String.md)
 - country : [Country](../datatypes/Country.md)
 
 ## Notes
 
-The main intended usage of multiple strings for different languages is to allow the representation of the addresses in different scripts, allowing for transliterations.
+Please note there are two specializations of this data type providing more or less structured details about a postal 
+address [Simple Postal Address](../datatypes/Simple_Postal_Address.md) and [Structured Postal Address](../datatypes/Structured_Postal_Address.md)
 
diff --git a/datatypes/Simple_Postal_Address.md b/datatypes/Simple_Postal_Address.md
@@ -0,0 +1,13 @@
+# Simple Postal Address
+
+This data type is used when a string representation of postal address is used.
+
+## Components
+
+- address : [Multilingual String](../datatypes/Multilingual_String.md)
+
+## Notes
+
+The main intended usage of multiple strings for different languages is to allow the representation of the addresses in different scripts, allowing for transliterations. 
+This is a subtype of [Postal Address](../datatypes/Postal_Address.md), and therefore it also includes inherited country component.  
+
diff --git a/datatypes/Structured_Postal_Address.md b/datatypes/Structured_Postal_Address.md
@@ -0,0 +1,16 @@
+# Structured Postal Address
+
+This data type is used when a structured representation of postal address is used.
+
+## Components
+
+- street : [Multilingual String](../datatypes/Multilingual_String.md)
+- city : [Multilingual String](../datatypes/Multilingual_String.md)
+- ZIP code: [Multilingual String](../datatypes/Multilingual_String.md)
+- stateOrProvince: [Multilingual String](../datatypes/Multilingual_String.md)
+
+## Notes
+
+The main intended usage of multiple strings for different languages is to allow the representation of the addresses in different scripts, allowing for transliterations.
+This is a subtype of [Postal Address](../datatypes/Postal_Address.md), and therefore it also includes inherited country component.  
+
diff --git a/diagrams/activity.svg b/diagrams/activity.svg
diff --git a/diagrams/application.svg b/diagrams/application.svg
diff --git a/diagrams/contributionToDocument.svg b/diagrams/contributionToDocument.svg
diff --git a/diagrams/core.puml b/diagrams/core.puml
@@ -275,11 +275,21 @@
 
 !startsub Postal_Address
     datatype("Postal_Address") {
+        country : Country
+    }
+
+    datatype("Simple_Postal_Address") {
+        address : Multilingual_String
+    }
+
+    datatype("Structured_Postal_Address") {
         street : Multilingual_String
         city : Multilingual_String
         zipCode : Multilingual_String
-        country : Country
     }
+
+     "Postal_Address" <|-d- "Simple_Postal_Address"
+     "Postal_Address" <|-d- "Structured_Postal_Address"
 !endsub
 
 !startsub Country

diff --git a/diagrams/core.svg b/diagrams/core.svg
diff --git a/diagrams/membership.svg b/diagrams/membership.svg
diff --git a/guidelines/DESCRIBING_DATATYPES.md b/guidelines/DESCRIBING_DATATYPES.md
@@ -10,11 +10,12 @@ URIs for the datatypes (used in interchange formats) should be constructed using
 ## Sections
 
 1. **Definition**: The scope of the datatype and its meaning. (The heading can be ommited of simple types.)
-2. **Notes**: An additional description to communicate the purpose of the datatype.
-3. **Components**: The list of fields the datatype is composed of. Similar to attributes for [entities](DESCRIBING_ENTITIES.md#sections).
+2. **Specialization of**: The link to the super datatype (the datatype this type extends)
+3. **Notes**: An additional description to communicate the purpose of the datatype.
+4. **Components**: The list of fields the datatype is composed of. Similar to attributes for [entities](DESCRIBING_ENTITIES.md#sections).
 ---
-4. **Matches**: Describe any external datatypes this datatype matches. 
-5. **References**: References to external resources in case these are referenced.
+5. **Matches**: Describe any external datatypes this datatype matches. 
+6. **References**: References to external resources in case these are referenced.
 
 A heading is left out if the section is empty.
 

diff --git a/guidelines/TEMPLATE_DATATYPE.md b/guidelines/TEMPLATE_DATATYPE.md
@@ -6,6 +6,9 @@ FIXME
 The scope of the datatype and its meaning.<sup>[1](#fn1)</sup> 
 (The heading can be ommited of simple types.)
 
+## Specialization of
+[XXX](../datatypes/XXX.md)
+
 ## Notes
 An additional description to communicate the purpose of the datatype.