Review Metadata section in asset schema #136

asam-ev / OpenMATERIAL

3D model exchange format with physical material properties for virtual development, test and validation of automated driving.

https://asam-ev.github.io/OpenMATERIAL/

Mozilla Public License 2.0

13 stars 7 forks source link

Review Metadata section in asset schema #136 #188

Open MustafaTrian opened 5 days ago

MustafaTrian commented 5 days ago

Describe your changes

Added some more detailed description on every element of the metadata in the asset schema
few units and data types were clearly written
a url to the asset file chapter (7.2.4) was added.

Issue ticket number and link

Add a reference to a related issue.

Mention a member

Add @mentions of the person or team responsible for reviewing the proposed changes.

Checklist before requesting a review

[x] I have performed a self-review of my code/documentation.
[ ] My changes generate no new warnings during the documentation generation.

LudwigFriedmann commented 5 days ago

Ready for review after illustrations are added

MustafaTrian commented 4 days ago

so i edited descriptions of some elements in the asset_schema.json As i couldn't figure out how the json2asciidoc.py gonna deal with the newlines, tabs or escape characters, i will post the "illustrations" here , it would be nice if it could be added to the json alongside the images. Could you take care of this please as discussed today? @ClemensLinnhoff : illustrations_AssetFile_Metadata.txt

ClemensLinnhoff commented 4 days ago

so i edited descriptions of some elements in the asset_schema.json As i couldn't figure out how the json2asciidoc.py gonna deal with the newlines, tabs or escape characters, i will post the "illustrations" here , it would be nice if it could be added to the json alongside the images. Could you take care of this please as discussed today? @ClemensLinnhoff : illustrations_AssetFile_Metadata.txt

Thanks. Unfortunately, json schema files do not allow line breaks. So the entire description has to be in one line. That's why bullet points also don't work unfortunately. Also, the text looks a bit AI generated. Some of it is slightly generic in my opinion.

MustafaTrian commented 4 days ago

Ok, i will try to summarize the contents in one line. I remember adding \n in the one line string can be interpreted as new line in git viewer. However, i have not tested it and didn't know how would it looks like in Adoc, that's why, i posted here before pushing. Regarding some generic parts of the text. I mentioned some parts from the .xoma example files to make using the bounding box or metallic /specular workflow clearer in context of open material. Still, the rest is general information about the element. Anyway, i will get rid of them when i shorten the descriptions.