diff --git a/README.md b/README.md index 349dc48..25d45a2 100644 --- a/README.md +++ b/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 diff --git a/diagrams/CRediT.svg b/diagrams/CRediT.svg index 350bf2c..ef0928a 100644 --- a/diagrams/CRediT.svg +++ b/diagrams/CRediT.svg @@ -1,22 +1,22 @@ -CERIF coreDocumenttitle : Multilingual_StringpublicationDate : DateDOI : DOI_TypeTextual DocumentContributorshipcontacts : List<URI>displayName : StringContribution StatementFree Text Contributionstatement : Multilingual_StringAgentCRediT Contribution StatementCRediT Degree of ContributionLeadEqualSupportingCRediT Role TypeConceptualizationData curationFormal analysisFunding acquisitionInvestigationMethodologyProject administrationResourcesSoftwareSupervisionValidationVisualizationWriting - original draftWriting - review & editingcontributionStatementsroleTypedegreeOfContributionCERIF coreDocumenttitle : Multilingual_StringpublicationDate : DateDOI : DOI_TypeTextual_DocumentContributorshipcontacts : List<URI>displayName : StringContribution_StatementFree_Text_Contributionstatement : Multilingual_StringAgentCRediT_Contribution_StatementCRediT_Degree_of_ContributionLeadEqualSupportingCRediT_Role_TypeConceptualizationData curationFormal analysisFunding acquisitionInvestigationMethodologyProject administrationResourcesSoftwareSupervisionValidationVisualizationWriting – original draftWriting – review & editing0..*0..1 contributor0..*0..* contributionStatementsroleTypedegreeOfContribution \ No newline at end of file diff --git a/diagrams/coarAccessibilitySpecification.svg b/diagrams/coarAccessibilitySpecification.svg index 8372163..050fcb6 100644 --- a/diagrams/coarAccessibilitySpecification.svg +++ b/diagrams/coarAccessibilitySpecification.svg @@ -1,16 +1,16 @@ -CERIF coreTextual Document Accessibility SpecificationCOAR Accessibility Specification v1Open Access COAR v1 Accessibility SpecificationRestricted Access COAR v1 Accessibility SpecificationMetadata Only Access COAR v1 Accessibility SpecificationEmargoed Access COAR v1 Accessibility SpecificationembargoEndDate : DateCERIF coreTextual_Document_Accessibility_SpecificationCOAR_Accessibility_Specification_v1Open_Access_COAR_v1_Accessibility_SpecificationRestricted_Access_COAR_v1_Accessibility_SpecificationMetadata_Only_Access_COAR_v1_Accessibility_SpecificationEmargoed_Access_COAR_v1_Accessibility_SpecificationembargoEndDate : Date \ No newline at end of file diff --git a/diagrams/core.puml b/diagrams/core.puml index a33d704..48bea10 100644 --- a/diagrams/core.puml +++ b/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 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 \ No newline at end of file diff --git a/diagrams/core.svg b/diagrams/core.svg index b04647f..e7f44b3 100644 --- a/diagrams/core.svg +++ b/diagrams/core.svg @@ -1,36 +1,37 @@ -Documentclass "Textual Document Accessibility Specification"{AgentOrganisation Unitname : Multilingual_StringPersonorcidid : ORCID_iD«DataType»Person_NamefirstNames : StringfamilyNames : StringotherNames : StringAuthorshipcorrespondingAuthorFlag : BooleanContributorshipcontacts : List<URI>displayName : StringContribution StatementFree Text Contributionstatement : Multilingual_StringAffiliation StatementdisplayAffiliation : String«DataType»Postal_Addressstreet : Stringcity : StringzipCode : StringCountryname : Multilingual_Stringiso3166alphaCode : ISO3166_Alpha_Codeiso3166NumericCode : ISO3166_Numeric_CodeeuCountryCode : EU_Country_CodePostal AddressTextual DocumentTextual Document Accessibility SpecificationThe Agent is mandatory for almost allsubclasses of Contributorship,Reviewing is the exception if thereviewer's identity is concealed.Also useful when authors areusing pseudonyms.countrypostalAddressorgUnitinstitutionaffiliationscontributionStatementsauthor == contributorauthornamesaccessRightsauthorsDocumentclass "Textual_Document_Accessibility_Specification"{AgentOrganisation_Unitname : Multilingual_StringPersonorcidid : ORCID_iD«DataType»Person_NamefirstNames : StringfamilyNames : StringotherNames : StringAuthorshipcorrespondingAuthorFlag : BooleanContributorshipcontacts : List<URI>displayName : StringContribution_StatementFree_Text_Contributionstatement : Multilingual_StringAffiliation_StatementdisplayAffiliation : String«DataType»Postal_Addressstreet : Stringcity : StringzipCode : StringCountryname : Multilingual_Stringiso3166alphaCode : ISO3166_Alpha_Codeiso3166NumericCode : ISO3166_Numeric_CodeeuCountryCode : EU_Country_CodeTextual_DocumentTextual_Document_Accessibility_SpecificationThe Agent is mandatory for almost allsubclasses of Contributorship,Reviewing is the exception if thereviewer's identity is concealed.Also useful when authors areusing pseudonyms.countrypostalAddress0..1 orgUnit0..1 institutionperson0..*0..1 contributor0..*0..* affiliations0..* contributionStatementsauthor == contributor0..*0..1 authornames0..* accessRights0..* authoredDocuments0..* authors "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 @@ -127,12 +130,12 @@ reverse link Textual Document to Agent-->>{ @@ -169,33 +172,34 @@ reverse link Textual Document to Agent--> "postalAddress" "Postal_Address" - "Affiliation Statement" o- - "orgUnit" "Organisation Unit" - "Affiliation Statement" o- - "institution" "Organisation Unit" - "Contribution Statement" <|- - "Free Text Contribution" - "Contributorship" -l-* "Agent" - "Contributorship" *- - "affiliations" "Affiliation Statement" - "Contributorship" *-u- "contributionStatements" "Contribution Statement" - "Authorship" -r-* "Textual Document" + "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" + "Contribution_Statement" <|- - "Free_Text_Contribution" + "Contributorship" "0..*" -r-* "Document" + "Contributorship" "0..*" -l-* "0..1 contributor" "Agent" + "Contributorship" *- - "0..* affiliations" "Affiliation_Statement" + "Contributorship" *-u- "0..* contributionStatements" "Contribution_Statement" + "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" - "Document" <|-u- "Textual Document" - "Textual Document" *-u- "accessRights" "Textual Document Accessibility Specification" - "Textual Document" *- - "authors" "Agent" - + "Agent" <|-d- "Organisation_Unit" + "Document" <|-u- "Textual_Document" + "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 -PlantUML version 1.2021.8(Sat Jun 26 08:20:59 UTC 2021) +PlantUML version 1.2021.8(Sat Jun 26 10:20:59 CEST 2021) (GPL source distribution) -Java Runtime: OpenJDK Runtime Environment -JVM: OpenJDK 64-Bit Server VM -Default Encoding: UTF-8 +Java Runtime: Java(TM) SE Runtime Environment +JVM: Java HotSpot(TM) 64-Bit Server VM +Default Encoding: Cp1252 Language: en -Country: null +Country: US --> \ No newline at end of file diff --git a/diagrams/journalArticle.svg b/diagrams/journalArticle.svg index bb24806..5e3fbbf 100644 --- a/diagrams/journalArticle.svg +++ b/diagrams/journalArticle.svg @@ -1,13 +1,13 @@ -CERIF coreDocumenttitle : Multilingual_StringpublicationDate : DateDOI : DOI_TypeTextual DocumentJournaltitle : Multilingual_Stringacronym : Multilingual_StringISSN : ISSN_TypeeISSN : ISSN_TypestartDate : DateendDate : DateDOI : DOI_TypeJournal ArticlestartPage : StringendPage : Stringvolume : Stringissue : StringpredecessorsourceCERIF coreDocumenttitle : Multilingual_StringpublicationDate : DateDOI : DOI_TypeTextual_DocumentJournaltitle : Multilingual_Stringacronym : Multilingual_StringISSN : ISSN_TypeeISSN : ISSN_TypestartDate : DateendDate : DateDOI : DOI_TypeJournal_ArticlestartPage : StringendPage : Stringvolume : Stringissue : String0..* predecessors0..*source \ No newline at end of file diff --git a/diagrams/module.puml b/diagrams/module.puml index 27d678d..4a0ea96 100644 --- a/diagrams/module.puml +++ b/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. diff --git a/diagrams/module.svg b/diagrams/module.svg index 95535e3..d757409 100644 --- a/diagrams/module.svg +++ b/diagrams/module.svg @@ -1,67 +1,69 @@ -CERIF coreDocumentclass "Textual Document Accessibility Specification"{AgentOrganisation Unitname : Multilingual_StringPersonorcidid : ORCID_iD«DataType»Person_NamefirstNames : StringfamilyNames : StringotherNames : StringAuthorshipcorrespondingAuthorFlag : BooleanContributorshipcontacts : List<URI>displayName : StringContribution StatementFree Text Contributionstatement : Multilingual_StringAffiliation StatementdisplayAffiliation : String«DataType»Postal_Addressstreet : Stringcity : StringzipCode : StringCountryname : Multilingual_Stringiso3166alphaCode : ISO3166_Alpha_Codeiso3166NumericCode : ISO3166_Numeric_CodeeuCountryCode : EU_Country_CodePostal AddressTextual DocumentTextual Document Accessibility SpecificationThe Agent is mandatory for almost allsubclasses of Contributorship,Reviewing is the exception if thereviewer's identity is concealed.Also useful when authors areusing pseudonyms.COAR Accessibility Specification v1Open Access COAR v1 Accessibility SpecificationRestricted Access COAR v1 Accessibility SpecificationMetadata Only Access COAR v1 Accessibility SpecificationEmargoed Access COAR v1 Accessibility SpecificationembargoEndDate : DateJournaltitle : Multilingual_Stringacronym : Multilingual_StringISSN : ISSN_TypeeISSN : ISSN_TypestartDate : DateendDate : DateDOI : DOI_TypeJournal ArticlestartPage : StringendPage : Stringvolume : Stringissue : StringMonographISBN : ISBN_TypeeISBN : ISBN_TypeEditorshipleadingEditorFlag : BooleanPublishershipleadingPublisherFlag : BooleanCRediT Contribution StatementCRediT Degree of ContributionLeadEqualSupportingCRediT Role TypeConceptualizationData curationFormal analysisFunding acquisitionInvestigationMethodologyProject administrationResourcesSoftwareSupervisionValidationVisualizationWriting - original draftWriting - review & editingThe CRediT is currently not expressed as Linked Open Data.We hope it will be in the future. We estimate it will be morestraightforward for it to be exposed as a list of terms (perhapsa SKOS concept scheme), rather than a class hierarchy.This justifies our choice to model it as an enumeration ratherthan a class hierarchy in our model.countrypostalAddressorgUnitinstitutionaffiliationscontributionStatementsauthor == contributorauthornamesaccessRightsauthorspredecessorpublisherssourceeditor == contributoreditorpublisher == contributorpublisherroleTypedegreeOfContributionCERIF coreDocumentclass "Textual_Document_Accessibility_Specification"{AgentOrganisation_Unitname : Multilingual_StringPersonorcidid : ORCID_iD«DataType»Person_NamefirstNames : StringfamilyNames : StringotherNames : StringAuthorshipcorrespondingAuthorFlag : BooleanContributorshipcontacts : List<URI>displayName : StringContribution_StatementFree_Text_Contributionstatement : Multilingual_StringAffiliation_StatementdisplayAffiliation : String«DataType»Postal_Addressstreet : Stringcity : StringzipCode : StringCountryname : Multilingual_Stringiso3166alphaCode : ISO3166_Alpha_Codeiso3166NumericCode : ISO3166_Numeric_CodeeuCountryCode : EU_Country_CodeTextual_DocumentTextual_Document_Accessibility_SpecificationThe Agent is mandatory for almost allsubclasses of Contributorship,Reviewing is the exception if thereviewer's identity is concealed.Also useful when authors areusing pseudonyms.COAR_Accessibility_Specification_v1Open_Access_COAR_v1_Accessibility_SpecificationRestricted_Access_COAR_v1_Accessibility_SpecificationMetadata_Only_Access_COAR_v1_Accessibility_SpecificationEmargoed_Access_COAR_v1_Accessibility_SpecificationembargoEndDate : DateJournaltitle : Multilingual_Stringacronym : Multilingual_StringISSN : ISSN_TypeeISSN : ISSN_TypestartDate : DateendDate : DateDOI : DOI_TypeJournal_ArticlestartPage : StringendPage : Stringvolume : Stringissue : StringMonographISBN : ISBN_TypeeISBN : ISBN_TypeEditorshipleadingEditorFlag : BooleanPublishershipleadingPublisherFlag : BooleanCRediT_Contribution_StatementCRediT_Degree_of_ContributionLeadEqualSupportingCRediT_Role_TypeConceptualizationData curationFormal analysisFunding acquisitionInvestigationMethodologyProject administrationResourcesSoftwareSupervisionValidationVisualizationWriting – original draftWriting – review & editing"CRediT Role Type"The CRediT is currently not expressed as Linked Open Data.We hope it will be in the future. We estimate it will be morestraightforward for it to be exposed as a list of terms (perhapsa SKOS concept scheme), rather than a class hierarchy.This justifies our choice to model it as an enumeration ratherthan a class hierarchy in our model.countrypostalAddress0..1 orgUnit0..1 institutionperson0..*0..1 contributor0..*0..* affiliations0..* contributionStatementsauthor == contributor0..*0..1 authornames0..* accessRights0..* authoredDocuments0..* authors0..* predecessors0..* publishers0..*sourceeditor == contributoreditorpublisher == contributorpublisherroleTypedegreeOfContribution \ No newline at end of file diff --git a/entities/COAR_Accessibility_Specification_v_1_0.md b/entities/COAR_Accessibility_Specification_v_1_0.md index 794767e..a7209d0 100644 --- a/entities/COAR_Accessibility_Specification_v_1_0.md +++ b/entities/COAR_Accessibility_Specification_v_1_0.md @@ -4,28 +4,21 @@ The COAR Access Rights vocabulary defines concepts to declare the access status of a resource. Multilingual labels regard regional distinctions in language and term. The Access Rights vocabulary builds on access rights defined in info:eu-repo/semantics. [1](#fn1) ## Usage notes -This is an abstract entity. There are four subclasses which should be used for open access, embargoed access, restricted access, metadata only access. - -![The COAR diagram](../diagrams/coarAccessibilitySpecification.svg) +This is an abstract entity. There are four subclasses which should be used for [open access](../entities/Open_Access_COAR_Accessibility_Specification_v_1_0.md), +[embargoed access](../entities/Embargoed_Access_COAR_Accessibility_Specification_v_1_0.md), +[restricted access](../entities/Restricted_Access_COAR_Accessibility_Specification_v_1_0.md), +[metadata only access](../entities/Metadata_Only_Access_COAR_Accessibility_Specification_v_1_0.md). ## Specialization of [Textual Document Accessibility Rights](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Textual_Document_Accessibility_Specification.md) -## Generalization of -[Open Access COAR Accessibility Specification v1.0](../entities/Open_Access_COAR_Accessibility_Specification_v_1_0.md) - -[Embargoed Access COAR Accessibility Specification v1.0](../entities/Embargoed_Access_COAR_Accessibility_Specification_v_1_0.md) - -[Restricted Access COAR Accessibility Specification v1.0](../entities/Restricted_Access_COAR_Accessibility_Specification_v_1_0.md) - -[Metadata Only Access COAR Accessibility Specification v1.0](../entities/Metadata_Only_Access_COAR_Accessibility_Specification_v_1_0.md) - -## Attributes +## Illustrative Diagram +![The COAR diagram](../diagrams/coarAccessibilitySpecification.svg) --- ## Matches - +1. Close match of [COAR access rights](http://vocabularies.coar-repositories.org/documentation/access_rights/) ## References \[1\] Source: Source: Controlled Vocabulary for Access Rights, http://vocabularies.coar-repositories.org/documentation/access_rights/ diff --git a/entities/CRediT_Contribution_Statement.md b/entities/CRediT_Contribution_Statement.md index 068f916..84926d5 100644 --- a/entities/CRediT_Contribution_Statement.md +++ b/entities/CRediT_Contribution_Statement.md @@ -11,6 +11,7 @@ role type : [CRediT Role Type](../datatypes/CRediT_Role_Type.md) degree of contribution : [CRediT Degree of Contribution](../datatypes/CRediT_Degree_of_Contribution.md) +## Illustrative Diagram ![The CRediT diagram](../diagrams/CRediT.svg) --- diff --git a/entities/Editorship.md b/entities/Editorship.md index 718fc94..9d4920d 100644 --- a/entities/Editorship.md +++ b/entities/Editorship.md @@ -8,24 +8,19 @@ An **editor** selects and prepares for publication material created and submitte [Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Authorship.md) ## Attributes -editor: [Agent](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Agent.md) -* [FIXME] replacing the inherited contributor attribute from [Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md) -document: [Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Document.md) +Beside those inherited from [Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md#attributes), there are also the following specific attribute: -affiliations: List<[Affiliation Statement](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Affiliation_Statement.md)> (inherited from [Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md)) +leading editor flag : [Boolean](https://github.com/EuroCRIS/CERIF-Core/blob/main/datatypes/Boolean.md) – indicates whether this editor contributed all or major effort (true) -contribution statements: List<[Contribution Statement](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contribution_Statement.md)> (inherited from [Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md)) +## Relationships -contacts: List<[URI](https://github.com/EuroCRIS/CERIF-Core/blob/main/datatypes/URI.md)> (inherited from [Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md)) - -display name: [String](https://github.com/EuroCRIS/CERIF-Core/blob/main/datatypes/String.md) (inherited from [Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md)) - -leading editor flag : [Boolean](https://github.com/EuroCRIS/CERIF-Core/blob/main/datatypes/Boolean.md) – indicates whether this editor contributed all or major effort (true) +Beside those inherited from [Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md#relationships), there is also a link to *editor*: an instance of [Agent](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Agent.md) +[FIXME] replacing the derived *contributor* link from [Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md) --- ## Matches -Close match with the **editor** named individual (http://purl.org/spar/pro/editor) from the SPAR PRO Ontology.[1](#fn1) +1. Close match with the **[editor](https://sparontologies.github.io/pro/current/pro.html#d4e705)** named individual from the SPAR PRO Ontology.[1](#fn1) ## References \[1\] Editor. In: *PRO, the Publishing Roles Ontology*. Shotton, D. and Peroni, S. Available: https://sparontologies.github.io/pro/current/pro.html diff --git a/entities/Embargoed_Access_COAR_Accessibility_Specification_v_1_0.md b/entities/Embargoed_Access_COAR_Accessibility_Specification_v_1_0.md index 96bd19b..87f6cba 100644 --- a/entities/Embargoed_Access_COAR_Accessibility_Specification_v_1_0.md +++ b/entities/Embargoed_Access_COAR_Accessibility_Specification_v_1_0.md @@ -3,8 +3,6 @@ ## Definition Embargoed access refers to a resource that is metadata only access until released for open access on a certain date. Embargoes can be required by publishers and funders policies, or set by the author (e.g such as in the case of theses and dissertations).[1](#fn1) -## Usage notes - ## Specialization of [COAR Accessibility Specification v1.0](../entities/COAR_Accessibility_Specification_v_1_0.md) @@ -15,7 +13,7 @@ embargo end date : [Date](https://github.com/EuroCRIS/CERIF-Core/blob/main/datat --- ## Matches - +1. Exact match of [COAR emargoed access rights](https://vocabularies.coar-repositories.org/access_rights/c_f1cf/) (identified by URI http://purl.org/coar/access_right/c_f1cf) ## References \[1\] Source: Source: Controlled Vocabulary for Access Rights, http://vocabularies.coar-repositories.org/documentation/access_rights/ diff --git a/entities/Journal.md b/entities/Journal.md index dc7e567..5520f17 100644 --- a/entities/Journal.md +++ b/entities/Journal.md @@ -21,7 +21,11 @@ start date: [Date](https://github.com/EuroCRIS/CERIF-Core/blob/main/datatypes/Da end date: [Date](https://github.com/EuroCRIS/CERIF-Core/blob/main/datatypes/Date.md) -publishers: List<[Agent](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Agent.md) +## Relationships + +A journal can have any number of *publishers*: instances of [Agent](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Agent.md) + +Moreover, a journal can have any number of its *predecessors*, i.e. it might be a journal which change the title or ISSN, or it might be two journals merged into the new one. ## Matches diff --git a/entities/Journal_Article.md b/entities/Journal_Article.md index 8f7e7fc..42c4141 100644 --- a/entities/Journal_Article.md +++ b/entities/Journal_Article.md @@ -11,19 +11,7 @@ An article on a particular topic and published in a journal issue. [1](#fn1 ## Attributes -DOI: [DOI_Type](https://github.com/EuroCRIS/CERIF-Core/blob/main/datatypes/DOI.md) (inherited from [Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Document.md)) - -title: [Multilingual String](https://github.com/EuroCRIS/CERIF-Core/blob/main/datatypes/Multilingual_String.md) (inherited from [Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Document.md)) - -publication date: [Date](https://github.com/EuroCRIS/CERIF-Core/blob/main/datatypes/Date.md) (inherited from [Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Document.md)) - -access rights: [Textual Document Accessibility Specification](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Textual_Document_Accessibility_Specification.md) - -contributorships: List<[Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md) (inherited from [Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Document.md)) - -authorships: List<[Authorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Authorship.md) (inherited from [Textual Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Textual_Document.md)) - -authors: List<[Agent](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Agent.md) (inherited from [Textual Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Textual_Document.md)) +Beside those inherited from [Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Document.md#attributes), and [Textual Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Textual_Document.md#attributes), there are the following attributes specific for this type of textual document: startPage: [String](https://github.com/EuroCRIS/CERIF-Core/blob/main/datatypes/String.md) @@ -33,7 +21,12 @@ volume: [String](https://github.com/EuroCRIS/CERIF-Core/blob/main/datatypes/Stri number: [String](https://github.com/EuroCRIS/CERIF-Core/blob/main/datatypes/String.md) -journal: [Journal](../entities/Journal.md) +## Relationships +Those from [Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Document.md#relationships), and [Textual Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Textual_Document.md#relationships). + +A journal article should contain information about *[journal](../entities/Journal.md)* in which it is published. + +## Illustrative Diagram ![The JournalArticle diagram](../diagrams/journalArticle.svg) diff --git a/entities/Metadata_Only_Access_COAR_Accessibility_Specification_v_1_0.md b/entities/Metadata_Only_Access_COAR_Accessibility_Specification_v_1_0.md index 96d64c9..2716dee 100644 --- a/entities/Metadata_Only_Access_COAR_Accessibility_Specification_v_1_0.md +++ b/entities/Metadata_Only_Access_COAR_Accessibility_Specification_v_1_0.md @@ -3,18 +3,13 @@ ## Definition Metadata only access refers to a resource in which access is limited to metadata only. The resource itself is described by the metadata, but neither is directly available through the system or platform nor can be referenced to an open access copy in an external journal or trustworthy archive.[1](#fn1) -## Usage notes - ## Specialization of [COAR Accessibility Specification v1.0](../entities/COAR_Accessibility_Specification_v_1_0.md) - -## Attributes - --- ## Matches - +1. Exact match of [COAR metadata only access rights](https://vocabularies.coar-repositories.org/access_rights/c_14cb/) (identified by URI http://purl.org/coar/access_right/c_14cb) ## References \[1\] Source: Source: Controlled Vocabulary for Access Rights, http://vocabularies.coar-repositories.org/documentation/access_rights/ diff --git a/entities/Monograph.md b/entities/Monograph.md index 26515eb..e6f4602 100644 --- a/entities/Monograph.md +++ b/entities/Monograph.md @@ -3,36 +3,24 @@ [FIXME] Book is a non-serial publication that is complete in one volume or a designated finite number of volumes. [1](#fn1) Monograph is a scholarly book or a treatise on a single subject or a group of related subjects. -## Usage notes - ## Specialization of [Textual Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Textual_Document.md) ## Attributes -DOI: [DOI_Type](https://github.com/EuroCRIS/CERIF-Core/blob/main/datatypes/DOI.md) (inherited from [Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Document.md)) - -title: [Multilingual String](https://github.com/EuroCRIS/CERIF-Core/blob/main/datatypes/Multilingual_String.md) (inherited from [Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Document.md)) - -publication date: [Date](https://github.com/EuroCRIS/CERIF-Core/blob/main/datatypes/Date.md) (inherited from [Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Document.md)) - -access rights: [Textual Document Accessibility Specification](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Textual_Document_Accessibility_Specification.md) - -contributorships: List<[Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md) (inherited from [Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Document.md)) - -authorships: List<[Authorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Authorship.md) (inherited from [Textual Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Textual_Document.md)) - -authors: List<[Agent](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Agent.md) (inherited from [Textual Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Textual_Document.md)) +Beside those inherited from [Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Document.md#attributes), and [Textual Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Textual_Document.md#attributes), there are the following attributes specific for this type of textual document: ISBN: [ISBN](../datatypes/ISBN.md) eISBN: [ISBN](../datatypes/ISBN.md) -editorships: List<[Editorship](../entities/Editorship.md) +## Relationships +Those from [Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Document.md#relationships), and [Textual Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Textual_Document.md#relationships). -publisherships: List<[Publisher](../entities/Publishership.md) +A Textual Document has any number of *editorships*: instances of [Editorship](../entities/Editorship.md). This relationship is derived from *Document.contributorships* by including just those [Contributorships](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md) that are [Editorships](../entities/Editorship.md). +A Textual Document has any number of *publisherships*: instances of [Publishership](../entities/Publishership.md). This relationship is derived from *Document.contributorships* by including just those [Contributorships](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md) that are [Publisherships](../entities/Publishership.md). ## Matches diff --git a/entities/Open_Access_COAR_Accessibility_Specification_v_1_0.md b/entities/Open_Access_COAR_Accessibility_Specification_v_1_0.md index a0c07f5..4127761 100644 --- a/entities/Open_Access_COAR_Accessibility_Specification_v_1_0.md +++ b/entities/Open_Access_COAR_Accessibility_Specification_v_1_0.md @@ -3,18 +3,15 @@ ## Definition Open access refers to a resource that is immediately and permanently online, and free for all on the Web, without financial and technical barriers.The resource is either stored in the repository or referenced to an external journal or trustworthy archive.[1](#fn1) -## Usage notes - ## Specialization of [COAR Accessibility Specification v1.0](../entities/COAR_Accessibility_Specification_v_1_0.md) - -## Attributes - --- ## Matches - +1. Exact match of [COAR open access rights](https://vocabularies.coar-repositories.org/access_rights/c_abf2/) (identified by URI http://purl.org/coar/access_right/c_abf2) +2. Close match of [ARCHE public access](https://vocabs.acdh.oeaw.ac.at/archeaccessrestrictions/public) +3. Close match of [EPrints open access](http://purl.org/eprint/accessRights/OpenAccess) ## References \[1\] Source: Source: Controlled Vocabulary for Access Rights, http://vocabularies.coar-repositories.org/documentation/access_rights/ diff --git a/entities/Publishership.md b/entities/Publishership.md index 2a553ba..0f29389 100644 --- a/entities/Publishership.md +++ b/entities/Publishership.md @@ -8,23 +8,19 @@ A **publisher** (a person or an organization) publishes material.[1](#fn1)< [Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Authorship.md) ## Attributes -publisher: [Agent](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Agent.md) -* [FIXME] replacing the inherited contributor attribute from [Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md) -document: [Document](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Document.md) +Beside those inherited from [Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md#attributes), there are also the following specific attribute: -[FIXME] is there any sense in the next three inhereted attributes in the context of publisership -affiliations: List<[Affiliation Statement](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Affiliation_Statement.md)> (inherited from [Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md)) +leading editor flag : [Boolean](https://github.com/EuroCRIS/CERIF-Core/blob/main/datatypes/Boolean.md) – indicates whether this publisher was the leading one among several (true) -contribution statements: List<[Contribution Statement](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contribution_Statement.md)> (inherited from [Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md)) +## Relationships -contacts: List<[URI](https://github.com/EuroCRIS/CERIF-Core/blob/main/datatypes/URI.md)> (inherited from [Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md)) - -display name: [String](https://github.com/EuroCRIS/CERIF-Core/blob/main/datatypes/String.md) (inherited from [Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md)) - -leading publisher flag : [Boolean](https://github.com/EuroCRIS/CERIF-Core/blob/main/datatypes/Boolean.md) – indicates whether this publisher was the leading one among several +Beside those inherited from [Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md#relationships), there is also a link to *editor*: an instance of [Agent](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Agent.md) +[FIXME] replacing the derived *contributor* link from [Contributorship](https://github.com/EuroCRIS/CERIF-Core/blob/main/entities/Contributorship.md) --- -## References -\[1\] Publisher. In: *PRO, the Publishing Roles Ontology.* Shotton, D. and Peroni, S. Available: https://sparontologies.github.io/pro/current/pro.html +## Matches +1. Close match with the **[publisher](https://sparontologies.github.io/pro/current/pro.html#d4e893)** named individual from the SPAR PRO Ontology.[1](#fn1) +## References +\[1\] Publisher. In: *PRO, the Publishing Roles Ontology*. Shotton, D. and Peroni, S. Available: https://sparontologies.github.io/pro/current/pro.html diff --git a/entities/Restricted_Access_COAR_Accessibility_Specification_v_1_0.md b/entities/Restricted_Access_COAR_Accessibility_Specification_v_1_0.md index 43aeaca..2bcb3fd 100644 --- a/entities/Restricted_Access_COAR_Accessibility_Specification_v_1_0.md +++ b/entities/Restricted_Access_COAR_Accessibility_Specification_v_1_0.md @@ -3,18 +3,15 @@ ## Definition Restricted access refers to a resource that is available in a system but with some type of restriction for full open access. This type of access can occur in a number of different situations. Some examples are described below: The user must log-in to the system in order to access the resource The user must send an email to the author or system administrator to access the resource Access to the resource is restricted to a specific community (e.g. limited to a university community).[1](#fn1) -## Usage notes - ## Specialization of [COAR Accessibility Specification v1.0](../entities/COAR_Accessibility_Specification_v_1_0.md) - -## Attributes - --- ## Matches - +1. Exact match of [COAR restricted access rights](https://vocabularies.coar-repositories.org/access_rights/c_16ec/) (identified by URI http://purl.org/coar/access_right/c_16ec) +2. Close match of [ARCHE restricted access](https://vocabs.acdh.oeaw.ac.at/archeaccessrestrictions/restricted) +3. Close match of [EPrints restricted access](http://purl.org/eprint/accessRights/RestrictedAccess) ## References \[1\] Source: Source: Controlled Vocabulary for Access Rights, http://vocabularies.coar-repositories.org/documentation/access_rights/