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

265 adding ipt required fields to metadata form #284

Closed
wants to merge 13 commits into from

Conversation

sjbruce
Copy link
Contributor

@sjbruce sjbruce commented Nov 29, 2023

Added a biological tab for Geographic Description, Sampling Description, Study Extent and Method Steps (repeating section).

Updated EML generation to include new elements.

@sjbruce sjbruce linked an issue Nov 29, 2023 that may be closed by this pull request
@n-a-t-e
Copy link
Member

n-a-t-e commented Dec 1, 2023

This looks good!

It would be good to give this "Add Item" button some context, like if items are method steps, maybe this can be in a section called "Methods" and items can be "Steps" or something like that.

Screen Shot 2023-11-30 at 4 48 05 PM

…plain the section

Changed wording to add/remove step from add/remove item to be more descriptive
Copy link

github-actions bot commented Dec 13, 2023

Visit the preview URL for this PR (updated for commit 69acb74):

https://cioos-metadata-form--pr284-265-adding-ipt-requi-4atwslqv.web.app

(expires Fri, 23 Feb 2024 17:49:40 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 57eda2a7622dc877ccadb675a0532261c52b09fd

@sjbruce
Copy link
Contributor Author

sjbruce commented Dec 13, 2023

Thanks, only getting back to this now.

As suggested, I've renamed the buttons to give more context and moved the method steps themselves into a section with descriptive text. I've also added key to the steps so they can be enumerated on the page.

I guess this could be reworked to behave like contacts or instruments - for the moment I've modeled it after the resources tab.

@n-a-t-e
Copy link
Member

n-a-t-e commented Dec 14, 2023

Looks good! Tiny thing - looks like "Move up" is correctly greyed out when theres a single method step, but "Move down" is still clickable (doesn't do anything)

Screen Shot 2023-12-14 at 3 07 51 PM

<methodStep>
<description>
<section>
<title>{{ method.title.en }}</title>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My text editor (VSCode) is complaining about <title> being here. do you have any links to info on this <title> tag?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also possible my editor is using the wrong schema files, if this works in the IPT thats good enough

Copy link
Contributor Author

@sjbruce sjbruce Dec 18, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I consulted a few different sources but ultimately based my structure on the following example: https://ediorg.github.io/data-package-best-practices/methods.html

Based on the idea that the description for a methodStep element is a section and a section has a title.

This seems to bear out in the EML schema detailed here (https://eml.ecoinformatics.org/schema/eml-methods_xsd.html#MethodsType_methodStep), but I'm no expert in this either - the following validator doesn't complain about it: https://knb.ecoinformatics.org/emlparser/

It does have some opinions on roles being specified for associated party:
The content of element 'associatedParty' is not complete. One of '{userId, role}' is expected.

Copy link
Member

@fostermh fostermh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

highlighting a few areas I think biological data and iso19115 schema overlap

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At first glance, there appears to be quite a bit of overlap between 'Method' from EML and 'Lineage' from iso1911. Specifically the processing step.

</description>
</methodStep>
{% endfor %}
<sampling>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

<para>{{ record.biological.studyExtent.en }}</para>
</description>
</studyExtent>
<samplingDescription>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

samplingDescription also seems to overlap with the iso lineage section

@@ -70,6 +72,7 @@
</distribution>
<coverage>
<geographicCoverage>
<geographicDescription>{{ record.biological.geographicDescription.en }}</geographicDescription>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fostermh fostermh mentioned this pull request Jan 17, 2024
@fostermh fostermh self-assigned this Feb 21, 2024
@fostermh fostermh mentioned this pull request Feb 22, 2024
@fostermh
Copy link
Member

fostermh commented Mar 7, 2024

replaced by #322

@fostermh fostermh closed this Mar 7, 2024
@fostermh fostermh linked an issue Apr 3, 2024 that may be closed by this pull request
@fostermh fostermh deleted the 265-adding-ipt-required-fields-to-metadata-form branch April 11, 2024 03:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Adding IPT-required fields to Metadata Form Improve EML.xml mapping
3 participants