search

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

Should we allow different `documentContent` types other than `HTML`? #13

Open rishson opened 1 year ago

rishson commented 1 year ago

We could change documentContent to be a choice, e.g.

<xs:element name="documentContent"  minOccurs="1" maxOccurs="1">
  <xs:complexType>
    <xs:choice>
      <xs:element name="html" type="HTMLTyppe"/>
      <xs:element name="xml" type="XMLType"/>
    </xs:choice>
  </xs:complexType>
</xs:element>

This would allow for better integration with upstream publishing systems that don't want to support HTML. An XML payload version could look to be a 'pro' version of the content that meets a more structured document use case. For example, citations:

(in HTML documentContent) <cite><a href="https://www.legislation.gov.uk/uksi/1992/3004/contents/made">Work at Height Regulations 2005 (WAHR)</a></cite>

(in XML documentContent) legal style citation markup, e.g. legalCiteM goes here

rishson commented 1 year ago

Perhaps the 'pro' version could be RDFa or similar?