Implement the Citation Documentation field in Scheme and Organization #11
Conversation
| @@ -2051,6 +2051,7 @@ class Scheme(Record): | |||
| schema = { | |||
| "title": {"type": "text", "useful": True}, | |||
| "description": {"type": "html", "useful": True}, | |||
| "citation_docs": {"type": "html", "useful": True}, | |||
There was a problem hiding this comment.
"useful" might be the wrong word here; perhaps I should have used "requisite". I didn't want to use "required" since none of the fields are technically required.
"useful" is short for the statement "The record cannot be considered useful without a value for this field."
"optional" is short for the statement "The record can be considered complete even without a value for this field."
I think "optional" is probably the right flag to use.
| @@ -2527,6 +2528,7 @@ class Group(Record): | |||
| schema = { | |||
| "name": {"type": "text", "useful": True}, | |||
| "description": {"type": "html"}, | |||
| "citation_docs": {"type": "html", "useful": True }, | |||
There was a problem hiding this comment.
I think "optional" is probably the right flag to use, rather than "useful".
| {{ form.citation_docs(class="form-control") }} | ||
| {{ errors(form.citation_docs) }} | ||
| <ul class="form-text text-muted"> | ||
| <li>Insert references about citations |
There was a problem hiding this comment.
The guidance here should be the same as the guidance given in openapi.yaml (or nearly so).
| {{ form.citation_docs(class="form-control") }} | ||
| {{ errors(form.citation_docs) }} | ||
| <ul class="form-text text-muted"> | ||
| <li>Insert references about citations |
There was a problem hiding this comment.
The guidance here should be the same as the guidance given in openapi.yaml (or nearly so).
| @@ -3321,6 +3323,7 @@ class SampleForm(Form): | |||
| class SchemeForm(FlaskForm): | |||
| title = StringField("Name of metadata scheme") | |||
| description = TextHTMLField("Description") | |||
| citation_docs = TextHTMLField("Citation Documentation") | |||
There was a problem hiding this comment.
Should be sentence case, i.e. "Citation documentation".
| @@ -3477,6 +3480,7 @@ class CrosswalkVersionForm(FlaskForm): | |||
| class GroupForm(FlaskForm): | |||
| name = StringField("Name of organization") | |||
| description = TextHTMLField("Description") | |||
| citation_docs = TextHTMLField("Citation Documentation") | |||
There was a problem hiding this comment.
Should be sentence case, i.e. "Citation documentation".
To strengthen the FAIR enabling of CH citation, we propose to add the “Citation Documentation” property to the metadata standard descriptors to describe the support for citation by the metadata standard and to describe how to cite resources (for example, CHOs).
Also, repositories can have citation guidelines, so we propose to add “Citation Documentation” to the Organisations fields, to fill in when applicable.
As a prototype implementation of this proposal, we implemented those fields in this PR.
The proposal is part of "A FAIR-enabling citation model for Cultural Heritage Objects" project activities.