co-cddo / ukgov-metadata-exchange-model

A metadata model for describing data assets for exchanging between UK government organisations.
https://co-cddo.github.io/ukgov-metadata-exchange-model/
Other
13 stars 1 forks source link

Improve presentation of a properties #54

Closed AlasdairGray closed 11 months ago

AlasdairGray commented 11 months ago

This PR changes the way that properties are presented both on the class pages and on the property specific pages and is a fix for #51. The new presentation provides more interpretation of the attributes of the properties to make them accessible to a wider set of users.

On a class page, the properties are now grouped by their obligation level (Mandatory, Recommended, and Optional) and ordered alphabetically within them. Each table of properties includes a hyperlink to the property, its expected range including any constraints such a minimum values, a summary of its description, and its cardinality (One or Many). An obligation level is only displayed if there are properties of that level. (See screenshots below).

On a property page, the attributes of the property are now displayed in their own section in a table using the primary definition of the property, i.e. if a property has different obligations for different classes then the primary definition is displayed on the property page (see modified for an example of this). The table includes the URL of the property, its range, obligation level, and cardinality.

Screenshots

Class pages

Screenshot 2023-10-27 at 12 00 36 Screenshot 2023-10-27 at 12 00 45

Property pages

Example with cardinality of one and mandatory: Screenshot 2023-10-26 at 10 47 58

Example with cardinality of many: Screenshot 2023-10-26 at 10 48 59

Example with a regular expression pattern: Screenshot 2023-10-26 at 10 49 33

Example with a minimum value (we don't have any maximum values set but it would work the same): Screenshot 2023-10-26 at 10 50 19

Example with an obligation of optional: Screenshot 2023-10-26 at 10 51 28