DataONEorg / collections-portals-schemas

Enabling project and data paper views via MetacatUI, Metacat, and EML
Apache License 2.0
3 stars 3 forks source link

Add a description to the collection definition #81

Closed robyngit closed 3 years ago

robyngit commented 3 years ago

I think it would be nice to allow users to add context and describe their collection of data. It could serve as a brief introduction to the data page. This would be especially useful when the data page is the first page within a portal that a user visits. For example:

SASAP-data-desc
robyngit commented 3 years ago

On second thought, the collection <description> should already serve this purpose, see:

https://github.com/DataONEorg/collections-portals-schemas/blob/da45bffd2c52ece3bb2b97a703b849eb1336a47b/schemas/collections.xsd#L42-L43

I think it might be redundant to have a description at the root of the <collection> element, then again within the <definition> element.

If we would like to allow some user-generated text above the dataCatalogView, as shown in the image above, then perhaps we could use the <introduction> element, if the proposed changes to the <section> elements are accepted, e.g.:

https://github.com/DataONEorg/collections-portals-schemas/blob/c1b61fe949e91cd4f477be4443c651b381b18051/docs/examples/example-portal.xml#L71-L74