TheELNConsortium / TheELNFileFormat

Specification for the ELN File Format
MIT License
45 stars 9 forks source link

Update kadi4mat readme #16

Closed jmanideep closed 2 years ago

NicolasCARPi commented 2 years ago

Great!

Here is how it looks in eLab after import: 2022-07-07-152732_1736x741_scrot

Note: in eLab I removed the CSV and PDF export from eln archive export for several reasons:

That's just my point of view, I'm not advocating for anything, you do what you want, but I believe the .eln export should not contain other exports too, but rather focus on the metadata file which holds all the info, from which one can do what they want afterwards.

NicolasCARPi commented 2 years ago

It would be great if the sample record could contain tags and comments (if you have comments in kadi4mat). Maybe also some text? Not sure if it should be in text or description property. Should be text if it's like the main content, and description would be more to describe what the node is. So the way I see it, description is more internal to the crate whereas text is the main content.

jmanideep commented 2 years ago

In the examples, I somehow missed adding tags of a resource(for both records and collections), but in the eln archive export implementation, the tags are also included in the crate metadata JSON file. I will add tags to the sample record. And in the current version of kadi4mat, there is no possibility to add comments.

And I do remove QR and PDF export from adding it to the eln archive export. I just wanted to populate the files in the example.

I will use text property instead of description property, as it will have the main content of the resource.

NicolasCARPi commented 2 years ago

here is how it looks now: the tags are showing and the main content too! :)

2022-07-10-021108_1270x1052_scrot