search

gbif / rs.gbif.org

GBIF machine-readable resources
https://rs.gbif.org
12 stars 12 forks source link

Add comments attribute to extension schema #45

Closed tucotuco closed 2 years ago

tucotuco commented 3 years ago

Darwin Core now supports comments separate from the term description and from examples. It would be extremely useful to propagate these comments in extension definition, as they provide recommendations on usage. The alternative now is to combine either description and comments (thus obfuscating the normative term definition) or to combine comments and examples (also not ideal).

Recommend to add the follow at the insert point in the schema given below:

https://github.com/gbif/rs.gbif.org/blob/8bf7d813cda2aed77c7541ce3ce7215f9dbca389/schema/extension.xsd#L37

Recommendations for the content for the property. While we're at it, it would be good to change the examples documentation as well, to: Example content for the property. If multiple examples are given, separate them with ' | '.
tucotuco commented 3 years ago

While we are at it, it would also be good to have authors and contact info.

tucotuco commented 3 years ago

Ready for review in https://github.com/gbif/rs.gbif.org/pull/71.

MattBlissett commented 3 years ago

This is now merged into the sandbox.