Skip to content

Commit

Permalink
Correct the relationship syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
jdvorak001 committed Feb 13, 2024
1 parent 4faf866 commit 3c0621a
Show file tree
Hide file tree
Showing 13 changed files with 225 additions and 22 deletions.
14 changes: 9 additions & 5 deletions datatypes/Structured_Physical_Address.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,15 @@ The main intended usage of multiple strings for different languages is to allow
[Physical Address](../datatypes/Physical_Address.md)

## Components
- those inherited from [Physical Address](../datatypes/Physical_Address.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)
Those inherited from [Physical Address](../datatypes/Physical_Address.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)

---
## Matches
Expand Down
7 changes: 7 additions & 0 deletions entities/Acknowledgement_Statement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Acknowledgement Statement

## Definition
Anything that testifies, demonstrates or acknowledges a [Contribution](../entities/Contribution.md).

## Relationships
<a name="rel__testifies">An Acknowledgement Statement *[testifies](../entities/Contribution.md#user-content-rel__is-testified-by)* a [Contribution](../entities/Contribution.md).</a>
6 changes: 3 additions & 3 deletions entities/Affiliation_Statement.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ contacts: List<[Contact Information](../datatypes/Contact_Information.md)>

## Relationships

An Affiliation Statement can optionally be linked with *institution*, an instance of [Organisation Unit](../entities/Organisation_Unit.md).
<a name="rel__has-institution">An Affiliation Statement *[has institution](../entities/Organisation_Unit.md#user-content-rel__is-the-institution-in)*, an instance of [Organisation Unit](../entities/Organisation_Unit.md).</a>

An Affiliation Statement can optionally be linked with *organisation unit*, an instance of [Organisation Unit](../entities/Organisation_Unit.md).
<a name="rel__has-organisation-unit">An Affiliation Statement can optionally *[have organisation unit](../entities/Organisation_Unit.md#user-content-rel__is-the-organisation-unit-in)*, an instance of [Organisation Unit](../entities/Organisation_Unit.md).</a>

An Affiliation Statement is typically linked with *person*: an instance of [Person](../entities/Person.md).
<a name="rel__has-person">An Affiliation Statement typically *[has person](../entities/Person.md#user-content-rel__is-the-person-in)*, an instance of [Person](../entities/Person.md).</a>

<a name="rel__is-used-in">An Affiliation Statement can optionally *[be used in](../entities/Activity.md#user-content-rel__has-affiliation-statements)* any number of [Activities](../entities/Activity.md).</a>
6 changes: 6 additions & 0 deletions entities/Agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ contacts : List<[Contact_Information](../datatypes/Contact_Information.md)>

<a name="rel__solicits">An Agent can *[invite](../entities/Call_for_Applications.md#user-content-rel__inviter)* any number of [Calls for Applications](../entities/Call_for_Applications.md).</a>

<a name="rel__is-the-applicant-in">An Agent can *[be the applicant in](../entities/Application.md#user-content-rel__has-applicant)* any number of [Applications](../entities/Application.md).</a>

<a name="rel__is-the-addressee-of">An Agent can *[be the addressee of](../entities/Application.md#user-content-rel__has-addressee)* any number of [Applications](../entities/Application.md).</a>

<a name="rel__receives">An Agent can *[receive](../entities/Prize_Award.md#user-content-rel__recipient)* any number of [Prize Awards](../entities/Prize_Award.md).</a>

<a name="rel__in-expertise-and-skills-possession">An Agent can *[be the agent in](../entities/Expertise_and_Skills_Possession.md#user-content-rel__by-agent)* any number of [Expertise and Skills Possessions](../entities/Expertise_and_Skills_Possession.md).</a>
Expand All @@ -30,6 +34,8 @@ contacts : List<[Contact_Information](../datatypes/Contact_Information.md)>

<a name="rel__has-identifier">An Agent can *[have](../entities/Agent_Identifier.md#user-content-rel__is-assigned-to)* any number of [Agent_Identifiers](../entities/Agent_Identifier.md).</a>

<a name="rel__is-the-author-of">An Agent can *[be the author of](../entities/Textual_Document.md#user-content-rel__has-author)* any number of [Textual Documents](../entities/Textual_Document.md).</a>

## Illustrative Diagram
![The Agent diagram](../diagrams/agent.svg)

Expand Down
6 changes: 3 additions & 3 deletions entities/Application.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ application date: [Date](../datatypes/Date.md)

## Relationships

An application always references the *applicant*, the [Agent](../entities/Agent.md) that makes the application. (Note the role can be called differently in specific contexts.)
<a name="rel__has-applicant">An Application always has the *[applicant](../entities/Agent.md#user-content-rel__is-the-applicant-in)*, the [Agent](../entities/Agent.md) that is applying. (Note the role can be called differently in specific contexts.)</a>

An application always references its *addressee*, the [Agent](../entities/Agent.md) that is expected to consider the application. (Note the role can be called differently in specific contexts.)
<a name="rel__has-addressee">An application always references its *[addressee](../entities/Agent.md#user-content-rel__be-the-addressee-of)*, the [Agent](../entities/Agent.md) that is expected to consider the application. (Note the role can be called differently in specific contexts.)</a>

<a name="rel__in-response-to">An application can reference the *[in-response-to](../entities/Call_for_Applications.md#user-content-rel__applications)* [Call for Applications](../entities/Call_for_Applications.md), the invitation that this application is responding to.</a>

An application can optionally reference its *contents*, the [Document](../entities/Document.md) that details the application.
<a name="rel__contents">A Call for Applications can optionally reference its *[contents](../entities/Document.md#user-content-rel__be-contents-for)*, the [Document](../entities/Document.md) that details the invitation.</a>

---

Expand Down
1 change: 1 addition & 0 deletions entities/Authorship.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ corresponding author flag: [Boolean](../datatypes/Boolean.md) – indicates whet

## Relationships

FIXME! These are probably just renames of other relationships
Beside those inherited from [Contribution to Document](../entities/Contribution_to_Document.md#relationships), there is also a link to *author*: an instance of [Agent](../entities/Agent.md)
[FIXME] replacing the derived *contributor* link from [Contribution to Document](../entities/Contribution_to_Document.md)

Expand Down
4 changes: 2 additions & 2 deletions entities/Call_for_Applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ deadline: [Date](../datatypes/Date.md) – until when applications can be submit
## Relationships
<a name="rel__inviter">A Call for Applications always references the *[inviter](../entities/Agent.md#user-content-rel__solicits)*, the [Agent](../entities/Agent.md) that solicits the applications. (Note the role can be called differently in specific contexts.)</a>

<a name="rel__applications">A Call for Applications can reference any number of *[applications](../entities/Application.md#user-content-rel__in-response-to)*, instances of [Application](../entities/Application.md), that are formed with a reference to it.
<a name="rel__applications">A Call for Applications can reference any number of *[applications](../entities/Application.md#user-content-rel__in-response-to)*, instances of [Application](../entities/Application.md), that are formed with a reference to it.</a>

A Call for Applications can optionally reference its *contents*, the [Document](../entities/Document.md) that details the invitation.
<a name="rel__contents">A Call for Applications can optionally reference its *[contents](../entities/Document.md#user-content-rel__be-contents-for)*, the [Document](../entities/Document.md) that details the invitation.</a>

---
## References
Expand Down
2 changes: 1 addition & 1 deletion entities/Contribution.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Beside those inherited from [Activity](../entities/Activity.md#relationships):

<a name="rel__has-contribution-statement">A Contribution has any number of *[contribution statements](../entities/Contribution_Statement.md#user-content-rel__contribution)*: instances of [Contribution Statement](../entities/Contribution_Statement.md).</a>

<a name="rel__has-acknowledgement-statement">A Contribution has any number of *acknowledgement statements*: instances of [Acknowledgement Statement](../entities/Acknowledgement_Statement).</a>
<a name="rel__is-testified-by">A Contribution *[is testified by](../entities/Acknowledgement_Statement.md#user-content-rel__testifies)* any number of [Acknowledgement Statements](../entities/Acknowledgement_Statement.md).</a>

---
## Matches
Expand Down
2 changes: 2 additions & 0 deletions entities/Document.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ publication date: [Date](../datatypes/Date.md) in case the document has gone thr

<a name="rel__prove_Activity">A Document can *[prove_Activity](../entities/Activity.md#user-content-rel__is-evidenced-by)* any number of [Activities](../entities/Activity.md).</a>

<a name="rel__"

---
## Matches
1. Close match of [Bibo Document](http://purl.org/ontology/bibo/Document)
Expand Down
4 changes: 4 additions & 0 deletions entities/Organisation_Unit.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ Those of [Agent](../entities/Agent.md#relationships)

<a name="rel__has-subunit">An Organisation Unit can *[have](../entities/Organisation_Unit.md#user-content-rel__has-superunit)* any number of [Organisation subunits](../entities/Organisation_Unit.md).</a>

<a name="rel__is-the-institution-in">An Organisation Unit can *[be the institution in](../entities/Affiliation_Statement.md#user-content-rel__has-institution)* any number of [Affiliation Statements](../entities/Affiliation_Statement.md).</a>

<a name="rel__is-the-organisation-unit-in">An Organisation Unit can *[be the organisation unit in](../entities/Affiliation_Statement.md#user-content-rel__has-organisation-unit)* any number of [Affiliation Statements](../entities/Affiliation_Statement.md).</a>

---
## Matches
1. Narrow match of [FOAF Organization](http://xmlns.com/foaf/spec/#term_Organization)
Expand Down
2 changes: 2 additions & 0 deletions entities/Person.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ alternate names : List<[Person Name](../datatypes/Person_Name.md)>

Those of [Agent](../entities/Agent.md#relationships)

<a name="rel__is-the-person-in">A Person can *[is the person in](../entities/Affiliation_Statement.md#user-content-rel__has-person)* any number of Affiliation Statement, instances of [Affiliation Statement](../entities/Affiliation_Statement.md).</a>

---
## Matches
1. Close match of [FOAF Person](http://xmlns.com/foaf/spec/#term_Person) (identified by URI http://xmlns.com/foaf/0.1/Person), which is also used in VIVO
Expand Down
4 changes: 2 additions & 2 deletions entities/Textual_Document.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ Those of [Document](../entities/Document.md#relationships)

A Textual Document has an optional *access rights specification*: an instance of [Textual Document Accessibility Specification](../entities/Textual_Document_Accessibility_Specification.md).

A Textual Document has any number of *authorships*: instances of [Authorship](../entities/Authorship.md). This relationship is derived from *Document.contributorships* by including just those [Contributions to Documents](../entities/Contribution_to_Document.md) that are [Authorships](../entities/Authorship.md).
<a name="rel__has-authorship">A Textual Document has any number of *[authorships](../entities/Authorship.md#user-content-rel__document)*, instances of [Authorship](../entities/Authorship.md). This relationship is derived from *Document.contributorships* by including just those [Contributions to Documents](../entities/Contribution_to_Document.md) that are [Authorships](../entities/Authorship.md).</a>

A Textual Document has any number of *authors*: instances of [Agent](../entities/Agent.md). This relationships is derived: it relates the Textual Document with the *actors* of its *authorships*. This is a simplified form of expressing *authorships* without any additional qualification or context.
<a name="rel__has-author">A Textual Document has any number of *[authors](../entities/Agent.md#user-content-rel__is-the-author-of)*, instances of [Agent](../entities/Agent.md). This relationships is derived: it relates the Textual Document with the *actors* of its *authorships*. This is a simplified form of expressing *authorships* without any additional qualification or context.</a>

## Illustrative Diagram

Expand Down
Loading

0 comments on commit 3c0621a

Please sign in to comment.