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

Add form page for optional metadata #146

Open
nuest opened this issue Apr 3, 2020 · 9 comments
Open

Add form page for optional metadata #146

nuest opened this issue Apr 3, 2020 · 9 comments
Assignees
Labels
enhancement New feature or request
Projects

Comments

@nuest
Copy link
Member

nuest commented Apr 3, 2020

For the pilot publication process, it would be most important that the author can edit the DOI before publishing the candidate, see also #130

@nuest nuest added the enhancement New feature or request label Apr 3, 2020
@MarkusKonk MarkusKonk added this to To do in UI via automation Apr 9, 2020
@nuest
Copy link
Member Author

nuest commented Sep 18, 2020

This is related to #130.

@nuest nuest moved this from Backlog to Sprint in UI Nov 27, 2020
@nuest
Copy link
Member Author

nuest commented Dec 4, 2020

  1. Identify which metadata fields exist, i.e. the content of metadata property, list here

Available Metadata properties

  • access_right String.
  • creators Array of objects.
  • creators.name String.
  • creators.orcid String.
  • creators.affiliation String.
  • codefiles Array of strings List of all files of the recursively parsed workspace that have an extension belonging to a ("R") codefile.
  • communities Array of objects prepared zenodo MD element
  • communities[0].identifier String. Indicating the collection as required in zenodo MD, default "o2r".
  • depends Array of objects.
  • depends.operatingSystem String.
  • depends.identifier String.
  • depends.packageSystem String. URL
  • description String. A text representation conveying the purpose and scope of the asset (the abstract).
  • displayfile String. The suggested file for viewing the text of the workspace, i.e. a rendering of the suggested mainfile.
  • ??? displayfile_candidates Array of strings. An unsorted list of candidates for displayfiles
  • identifier Object.
  • identifier.doi String.
  • identifier.doiurl String.
  • identifier.reversedoi String.
  • inputfiles Array of strings. A compiled list of files from the extracted workspace that is called or used in the extracted code of the workspace.
  • interaction TBD
  • keywords Array of strings. Tags associated with the asset.
  • licenseObject. License information for the entire ERC.
  • license.code String. License information for the code included.
  • license.data String. License information for the data included.
  • license.md String. License information for the metadata included. Should be cc0 to include in catalogues.
  • license.textString. License information for the text included.
  • mainfile String. The suggested main file of workspace
  • ??? mainfile_candidates Array. Unsorted list of mainfile candidates of the workspace.
  • paperLanguage Array of strings. List of guessed languages for the workspace.
  • publication_date String. The publication date of the paper publication as ISO8601 string.
  • publication_type String.
  • related_identifier String.
  • spatial Object. Spatial information of the workspace.
  • spatial.files Array of objects.
  • spatial.union Array of objects.
  • temporal Object. Aggregated information about the relevant time period of the underlying data sets.
  • temporal.begin
  • temporal.end
  • title The distinguishing name of the paper publication.
  • upload_type String. Zenodo preset. Defaults to "publication".

Checked Properties already have a form field in the ui.


  1. Decide which ones need to be exposed through a form

Fields

@Fmazin
Copy link
Contributor

Fmazin commented Dec 7, 2020

The above list is based on this list and responses from the api on the /metadata endpoint.

@nuest
Copy link
Member Author

nuest commented Dec 8, 2020

The list you link to is a good start, please update it if you find any information in the API responses that is not documented.

@Fmazin
Copy link
Contributor

Fmazin commented Dec 11, 2020

I have added a optional metadata form page in the create view. It functions like the required metadata. At the moment it contains only the doi field.
Bildschirmfoto von 2020-12-11 16-59-35

The doi will also be displayed in the metadata sections of the ERC view.

Bildschirmfoto von 2020-12-11 17-00-15

This can be expanded to to include the other metadata properties in the list above. But should i keep this general setup?

@nuest
Copy link
Member Author

nuest commented Dec 14, 2020

@nuest General setup is alright! I've removed two of the suggested fields (type, metadata license) as these should be set by the system, not the user. (I actually am not sure what "type" is for - is that "workspace" or "compendium"?)

@Fmazin Fmazin moved this from Sprint until next release to In progress in UI Dec 14, 2020
@Fmazin
Copy link
Contributor

Fmazin commented Jan 8, 2021

I had some issues with the implementation of the keywords and languages arrays. I tried to do it relatively analog to the authors in the required metadata section with formik. This unfortunately led to my PC crashing. Currently consulting with @NJaku01 over the problem.

@Fmazin
Copy link
Contributor

Fmazin commented Jan 18, 2021

Would it be to much if the Languages are checked agianst a list of the ISO 639-1 codes?

@nuest
Copy link
Member Author

nuest commented Jan 18, 2021

Yes, that validation of user input would be good. Maybe there even is a React module that does this?

If you have to implement this yourself, I suggest a link to the Wikipedia page and then letting the use enter the code, and then create a new issue for a more advanced "user enters first letters of language an then gets suggestions for matching languages and codes".

@Fmazin Fmazin moved this from In progress to Done - ask for review in UI Mar 11, 2021
@Fmazin Fmazin moved this from Done - ask for review to Done in UI Mar 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
UI
  
Done
Development

No branches or pull requests

2 participants