Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Additional metadata for Collections #1121

Open
richterMPDL opened this issue Mar 19, 2019 · 5 comments

Comments

4 participants
@richterMPDL
Copy link

commented Mar 19, 2019

Goal: Data providers get the opportunity to add metadata to collections – during initial upload and at a later stage (e.g. if journal or article doi isn’t known yet when the Collection is created), then data users have more options for faceted search.

Actors: Data providers (default user with create collection grant)

Glossary:
Key = Title of metadata field
Value = Value for metadata field
Metadatum = key and value pair
Collection Metadata = key and value pairs for a collection

Actions: Data provider starts to create a collection and adds additional information.

  1. Data entry:
    “Start page” -> “ create collection” -> View “Create Collection” is displayed.
    “Title/Description” and “Authors” remain as already implemented.

1.1. “Additional information” -> remove this header
1.2. Collection metadata fields are displayed and ready for data entry

Following Metadata entry fields are visible by default for user

i. Study type (mandatory/required): Radioboxes observational - experimental - simulation/modelling - survey – other (without free text field)
ii. Project (Free text)
iii. Journal (Free text)
iv. Article doi (Free text). Include Syntax Validation

1.3. User has the option to add multiple metadata entry fields, according to existing “Add Additional Information” functionality.
Keys for possible entry fields are given by system, provided eg. by Pull-down list of keys or Auto-suggest. Nothing should be mandatory, data providers can select what applies to their dataset. Multiple entries should be possible.

Choice menu preceded by Text "Material/Method" with placeholder text "Select from List"

The following metadata are included:
i. Geolocation – Place [Free text]
ii. Geolocation – Latitude [Free text]
iii. Geolocation – Longitude [Free text]
iv. Geolocation – Altitude [Free text]
v. Biological study object - common name [Free text]
vi. Biological study object - taxonomic name [Free text]
vii. Chemical element/compound [Free text]
viii. Temporal coverage (Format to be discussed, various ones for date exist), single value or min-max
ix. Keywords (Free text). One field with list of several comma-separated terms is fine if search functions can deal with it (i.e. are able to find single terms which are part of such a list)

->”Save”

  1. Data display:
    Earlier saved collection metadata are displayed in “Collection” -> “More information” -> inserted as a block after metadata “Permalink”
    Only filled out fields are displayed.

  2. Edit data:
    “Collection” -> “Collection information” -> edit information/same access rights as for existing functionality
    Allowed actions:
    Change value
    Add new metadata entry field
    Delete multiple metadata entry field – default metadata are not deletable
    ->”Save”, changes are displayed in “More information”

  3. Search data:
    Include keys to faceted search

#######
Changes to previous version:
Start all keys with capital letter
Add text "Study context" before second block (metadata entry fields that aren't visible by default)
Items v. and vi.: make this "Biological study object" (was: biological species)
#######

@hofmannc hofmannc changed the title Additional metadata statements for Collections Additional metadata for Collections Apr 4, 2019

@haarli haarli self-assigned this Apr 4, 2019

@helkv helkv added this to In progress in imeji 4.5 Apr 24, 2019

@haarli

This comment has been minimized.

Copy link

commented May 3, 2019

I think the position of the "Collection metadata" headline is a bit confusing, as "title", "description" and authors are also collection metadata.
It's also not possible to write "Study context" before the pulldown lists, as they are internally in the same list as "Project", "Journal" and "Article DOI", the system can not differentiate.

Suggestion: What about using "Study Context" instead of "Collection Metadata" and no headline preceeding the choice menu?
We could also change the text of the placeholder in the choide menus

@richterMPDL

This comment has been minimized.

Copy link
Author

commented May 3, 2019

Fair enough - ticket edited. I just don't like "Additional information" as it could be understood to be less important/relevant than earlier fields. Terms don't apply to all datasets and therefore cannot become mandatory, but they are equally important for dataset description and (via search functions) data discovery.

haarli added a commit that referenced this issue May 6, 2019

haarli added a commit that referenced this issue May 6, 2019

helkv added a commit that referenced this issue May 7, 2019

#1121 Edited the JS imports in the html head
-> Importing the JS libraries with the script tag in the html head
resulted in some flickering (in firefox) when loading a new page.
Reason: The JS libraries were loaded before the css. Therefore the page
without css was visible for some ms which lead to the flickering.

- Add the JS/jQuery libraries with the h:outputScript tag instead of the
script tag. This way the libraries get loaded after the css.
- Use the name attribute in the h:outputScript tag to locate the
libraries (using the library attribute did not work).
- Remove footer_imports.xhtml (Add font-awesome.min.css to
html_head_default.xhtml)

@haarli haarli moved this from In progress to Done in imeji 4.5 May 8, 2019

@haarli

This comment has been minimized.

Copy link

commented May 8, 2019

Implemented in the following way
The values for study types, material/methods and fixed metadata values can be configured via Admin->Collections. Single values have to be seperated by a newline.

@helkv

This comment has been minimized.

Copy link

commented May 13, 2019

Added requirements:

  1. Article doi: display as clickable link
  2. Include error message for study type (if no box has been ticked)
  3. Separate field for Geo-coordinates with validation [latitude between -90 and 90, longitude between -180 and 180]; Geolocation-Latitude and Geolocation-Longitude can be removed from Choice menu.
  4. Display "Authors" and "Cite as" on top of 'more information' for a Collection

@helkv helkv moved this from Done to In progress in imeji 4.5 May 13, 2019

helkv added a commit that referenced this issue May 14, 2019

#1121 Change 'more information' order & Add 'study type' error message
-> Changes due to the added requirements 2 and 4, see ticket 1121.
- Change 'more information' order: In the 'more information' view of a
collection 'Authors' and 'Cite as' is now displayed directly after the
description
- Add 'study type' error message, which is shown if no study type is
selected

helkv added a commit that referenced this issue May 15, 2019

#1121 Add validation and placeholder for metadata 'Geo-coordinates'
-> Changes due to the added requirement 3, see ticket 1121.
-> Implementation variant 1: 'Geo-coordinates' is still part of the
general collection metadata (= additional information). If
'Geo-coordinates' exists as collection metadata with the exact label
'Geo-coordinates', it gets validated and has a placeholder.

- Add 'Geo-coordinates' and 'Article DOI' as specific additional
information labels to ImejiConfiguration
- Add getPlaceholder() method to CollectionBean (used in editForm.xhtml)
- Add validateGeoCoordinates() method to CollectionValidator
- Add appropriate placeholder and error message as label/message

helkv added a commit that referenced this issue May 16, 2019

#1121 Add metadata 'Article DOI' as clickable link in more informations
-> Changes due to the added requirement 1, see ticket 1121.
-> Implementation variant 1: 'Article DOI' is still part of the
general collection metadata (= additional information). If
'Article DOI' exists as collection metadata with the exact label
'Article DOI', it is rendered as clickable link in more informations.

- Add render 'Article DOI' as clickable linke (in details.xhtml)
- Add getArticleDoiLabel() method to CollectionItemsBean

helkv added a commit that referenced this issue May 17, 2019

#1121 Remove tooltip from 'Material & Methods' select Button
-> The tooltip was displayed on the wrong position (and is not needed)
- Removed attribute title from combobox.js => The tooltip is not shown
anymore
@richterMPDL

This comment has been minimized.

Copy link
Author

commented May 17, 2019

Suggested placeholder (grey text before data are entered) for Geo-coordinates:

"Latitude(-90 TO 90), Longitude (-180 TO 180)
e.g. 60.123, -120.4567
[South is negative, West is negative]"

Most scientists/data providers should be familiar with these conventions, but it doesn't hurt to be explicit.

helkv added a commit that referenced this issue May 20, 2019

#1121 Small Fixes and Additions
- Article DOI link now opens in a new tab/browser
- Changed additional informations placeholder label
- Extended geo-coordinates placeholder label
- Fixed typo in geo-coordinates error message

helkv added a commit that referenced this issue May 20, 2019

#1121 Small Adaptions
- Add additional information below the current additional information in
the list (when clicking the '+' button)
- Rename "Materials & Methods" to "Study Context"
- Adaptions in labels and messages

helkv added a commit that referenced this issue May 21, 2019

#1121 Adapt validation for metadata 'Geo-coordinates'
-> Added two more "validation-steps":
- Only the following characters are allowed in the geoCoordinates
String: +, -, numbers, commas, points and whitespaces
- The geoCoordinates String must not be null or empty
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.