UKGovernmentBEIS / orpml

Contains the schemas and example usage of ORPML (TO BE TRANSFERED TO DBaT WHEN READY)

MIT License

2 stars 1 forks source link

Add initial first pass at doc #20

Closed stevenalanwilson closed 1 year ago

stevenalanwilson commented 1 year ago

Description

Adding an example of ORPML marked-up legislation.

We initially added "Working at Height" from the Health and Safety Executive (HSE) as it is simple and does not have any complex legal or technical sections.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] This change requires a documentation update
[ X ] Add an example

Checklist:

[ ] I have performed a self-review of my code
[ ] I have commented my code, particularly in hard-to-understand areas
[ ] I have made corresponding changes to the documentation

kevinxufs commented 1 year ago

Thanks @stevenalanwilson - Before I accept this I'd appreciate if you could discuss just a bit about the process of creating this marked up document.

Is the following accurate?:

create the overall structure (orpml tag -> meta data tags -> html)
Filled in the metadata content
Filled in the html content

Could I also ask where you identified the metadata content, and where for example you decided on the relevant key words (I guess maybe this is arbitrary)? Does the html exist already or did you need a converter of some kind?

I ask these things as it is really helpful for us to be able to generate our own content in the future, and also to provide any guidance to regulators.

Thanks!

stevenalanwilson commented 1 year ago

Hey @kevinxufs

Yes the overall structure is wrapped in a tag, then two main sections:

the metadata (more information on its structure is documented in the README file of this repo but is essentially a hierarchy of Dublin Core, DCAT fields then custom ORPML fields.
The HTML structure of the document with custom attributes to donate the systematics of the ORPML

It is worth noting that ORPML is still being developed, that is the main reason for adding the examples as they will help tease out any gaps in the metadata as we add different use cases.

This work should be socialised with the regulators as they are the domain experts and they will help development of ORPML