Alignment of entity descriptions and diagrams with guidelines

README.md

@@ -35,7 +35,7 @@ And the following data types:
   * [Role Type](./datatypes/CRediT_Role_Type.md)
   * [Degree of Contribution](./datatypes/CRediT_Degree_of_Contribution.md)
 
-
+## Illustrative Diagram
 ![The module diagram](./diagrams/module.svg)
 
 ## Usage note

diagrams/core.puml

@@ -10,17 +10,17 @@
         publicationDate : Date
         DOI : DOI_Type
     }
-    class "Textual Document"{
+    class "Textual_Document"{
     }
     !endsub
     !startsub TDAS
-    class "Textual Document Accessibility Specification"{
+    class "Textual_Document_Accessibility_Specification"{
     }
     !endsub
     class "Agent"{
 
     }
-    class "Organisation Unit"{
+    class "Organisation_Unit"{
         name : Multilingual_String
     }
     class "Person"{
@@ -39,13 +39,13 @@
         contacts : List<URI>
         displayName : String
     }
-    class "Contribution Statement"{
+    class "Contribution_Statement"{
     }
-    class "Free Text Contribution"{
+    class "Free_Text_Contribution"{
         statement : Multilingual_String
     }
     !endsub
-    class "Affiliation Statement"{
+    class "Affiliation_Statement"{
         displayAffiliation : String
     }
    datatype("Postal_Address"){
@@ -59,33 +59,35 @@
         iso3166NumericCode : ISO3166_Numeric_Code
         euCountryCode : EU_Country_Code
     }
-    "Postal Address" *-- "country" "Country"
-    "Affiliation Statement" ..> "postalAddress" "Postal_Address"
-    "Affiliation Statement" o-- "orgUnit" "Organisation Unit"
-    "Affiliation Statement" o-- "institution" "Organisation Unit"
+    "Postal_Address" o-- "country" "Country"
+    "Affiliation_Statement" ..> "postalAddress" "Postal_Address"
+    "Affiliation_Statement" o-- "0..1 orgUnit" "Organisation_Unit"
+    "Affiliation_Statement" o-- "0..1 institution" "Organisation_Unit"
+    "Affiliation_Statement" o-- "person" "Person"
     !startsub Contributorship
-    "Contribution Statement" <|-- "Free Text Contribution"
-    "Contributorship" -r-* "Document"
+    "Contribution_Statement" <|-- "Free_Text_Contribution"
     !endsub
     !startsub Contributorship
-    "Contributorship" -l-* "Agent"
+    "Contributorship" "0..*" -r-* "Document"
     !endsub
-    "Contributorship" *-- "affiliations" "Affiliation Statement"
     !startsub Contributorship
-    "Contributorship" *-u- "contributionStatements" "Contribution Statement"
+    "Contributorship" "0..*" -l-* "0..1 contributor" "Agent"
     !endsub
-    "Authorship" -r-* "Textual Document"
+    "Contributorship" *-- "0..* affiliations" "Affiliation_Statement"
+    !startsub Contributorship
+    "Contributorship" *-u- "0..* contributionStatements" "Contribution_Statement"
+    !endsub
+    "Authorship" -r-* "Textual_Document"
     "Contributorship" <|-u- "Authorship"
-    "Authorship" --> "author" "Agent"
-    note on link #red: author == contributor
+    "Authorship" "0..*" --o "0..1 author" "Agent"
+    note on link #yellow: author == contributor
     "Person" .d.> "names" "Person_Name"
     "Agent" <|-d- "Person"
-    "Agent" <|-d- "Organisation Unit"
+    "Agent" <|-d- "Organisation_Unit"
     !startsub Document
-    "Document" <|-u- "Textual Document"
+    "Document" <|-u- "Textual_Document"
     !endsub
-    "Textual Document" *-u- "accessRights" "Textual Document Accessibility Specification"
-    "Textual Document" *--  "authors" "Agent"
-
+    "Textual_Document" *-u- "0..* accessRights" "Textual_Document_Accessibility_Specification"
+    "Textual_Document" "0..* authoredDocuments" --- "0..* authors" "Agent"
     note left of Agent: The Agent is mandatory for almost all \nsubclasses of Contributorship,\nReviewing is the exception if the \nreviewer's identity is concealed. \nAlso useful when authors are \nusing pseudonyms.
 @enduml

diagrams/module.puml

@@ -6,15 +6,15 @@ package "CERIF core" #EFEFEF{
     !include ./core.puml
 }
     !startsub Coar
-    class "COAR Accessibility Specification v1"
+    class "COAR_Accessibility_Specification_v1"
 
-    class "Open Access COAR v1 Accessibility Specification"
+    class "Open_Access_COAR_v1_Accessibility_Specification"
 
-    class "Restricted Access COAR v1 Accessibility Specification"
+    class "Restricted_Access_COAR_v1_Accessibility_Specification"
 
-    class "Metadata Only Access COAR v1 Accessibility Specification"
+    class "Metadata_Only_Access_COAR_v1_Accessibility_Specification"
 
-    class "Emargoed Access COAR v1 Accessibility Specification"{
+    class "Emargoed_Access_COAR_v1_Accessibility_Specification"{
         embargoEndDate : Date
     }
     !endsub
@@ -29,7 +29,7 @@ package "CERIF core" #EFEFEF{
         endDate : Date
         DOI : DOI_Type
     }
-    class "Journal Article"{
+    class "Journal_Article"{
         startPage : String
         endPage : String
         volume : String
@@ -48,14 +48,14 @@ package "CERIF core" #EFEFEF{
         leadingPublisherFlag : Boolean
     }
     !startsub CRediT
-    class "CRediT Contribution Statement"{
+    class "CRediT_Contribution_Statement"{
     }
-    enum "CRediT Degree of Contribution"{
+    enum "CRediT_Degree_of_Contribution"{
         Lead
         Equal
         Supporting
     }
-    enum "CRediT Role Type"{
+    enum "CRediT_Role_Type"{
         Conceptualization
         Data curation
         Formal analysis
@@ -74,43 +74,43 @@ package "CERIF core" #EFEFEF{
     !endsub
 
     !startsub Coar
-    "Textual Document Accessibility Specification" <|-- "COAR Accessibility Specification v1"
+    "Textual_Document_Accessibility_Specification" <|-- "COAR_Accessibility_Specification_v1"
     !endsub
     !startsub Coar
-    "COAR Accessibility Specification v1" <|-- "Open Access COAR v1 Accessibility Specification"
+    "COAR_Accessibility_Specification_v1" <|-- "Open_Access_COAR_v1_Accessibility_Specification"
     !endsub
     !startsub Coar
-    "COAR Accessibility Specification v1" <|-- "Restricted Access COAR v1 Accessibility Specification"
+    "COAR_Accessibility_Specification_v1" <|-- "Restricted_Access_COAR_v1_Accessibility_Specification"
     !endsub
     !startsub Coar
-    "COAR Accessibility Specification v1" <|-- "Emargoed Access COAR v1 Accessibility Specification"
+    "COAR_Accessibility_Specification_v1" <|-- "Emargoed_Access_COAR_v1_Accessibility_Specification"
     !endsub
     !startsub Coar
-    "COAR Accessibility Specification v1" <|-- "Metadata Only Access COAR v1 Accessibility Specification"
+    "COAR_Accessibility_Specification_v1" <|-- "Metadata_Only_Access_COAR_v1_Accessibility_Specification"
     !endsub
     !startsub Journal
-    "Textual Document" <|-- "Journal Article"
+    "Textual_Document" <|-- "Journal_Article"
     !endsub
-    "Textual Document" <|-- "Monograph"
+    "Textual_Document" <|-- "Monograph"
     "Contributorship" <|-- "Editorship"
     "Contributorship" <|-- "Publishership"
     !startsub CRediT
-    "Contribution Statement" <|-- "CRediT Contribution Statement"
+    "Contribution_Statement" <|-- "CRediT_Contribution_Statement"
     !endsub
     !startsub Journal
-    "Journal" o-- "predecessor" "Journal"
+    "Journal" o-- "0..* predecessors" "Journal"
     !endsub
-    "Journal" o--  "publishers" "Agent"
+    "Journal" o--  "0..* publishers" "Agent"
     !startsub Journal
-    "Journal Article" o-- "source" "Journal"
+    "Journal_Article" "0..*" o-- "source" "Journal"
     !endsub
     "Editorship" --> "editor" "Agent"
-    note on link #red: editor == contributor
+    note on link #yellow: editor == contributor
     "Publishership" --> "publisher" "Agent"
-    note on link #red: publisher == contributor
+    note on link #yellow: publisher == contributor
     !startsub CRediT
-    "CRediT Contribution Statement" ..> "roleType" "CRediT Role Type"
-    "CRediT Contribution Statement" ..> "degreeOfContribution" "CRediT Degree of Contribution"
+    "CRediT_Contribution_Statement" ..> "roleType" "CRediT_Role_Type"
+    "CRediT_Contribution_Statement" ..> "degreeOfContribution" "CRediT_Degree_of_Contribution"
     !endsub
 
     note right of "CRediT Role Type": The CRediT is currently not expressed as Linked Open Data. \nWe hope it will be in the future. We estimate it will be more \nstraightforward for it to be exposed as a list of terms (perhaps \na SKOS concept scheme), rather than a class hierarchy. \nThis justifies our choice to model it as an enumeration rather \nthan a class hierarchy in our model.