Write descriptive release notes for specification version 2.2.0 before publication

[jmaferreira]

17th May 2024

Specification Changes

Version 2.2.0 of the SIP specification introduces textual enhancements and clarifications, rectification of previously detected typographical errors, adjustments to the cardinality of certain METS elements, along with comprehensive reviews and updates to examples and METS profiles. Further, enhancements in indentation have been applied to augment the legibility of the examples.

Corrections

• Amended the text for requirement SIP19 from 'The submitting agent has a note providing a unique identification code for the archival creator.' to 'The submitting agent has a note providing a unique identification code for the submitter.' [#126]
• Altered the cardinality of the structMap element in the METS Profile from SHOULD to MUST. Owing to the absence of modifications in the element's cardinality by the SIP specification itself, this requirement was subsequently removed from the SIP specification. Additionally, the METS profile erroneously referenced CSIP_3 instead of the structMap requirement CSIP_80. [#115]
• Introduced version numbers for METS profiles versions 2.2.0 and 2.1.0. [[baa2c9990f1f323334b2c15b681b6013193b3edd]
• Implemented several enhancements to the specification text, indentation, and formatting for increased clarity. [ba05428560c78266ec4ee7a2b88a7bcccabbff00], [ffd4a1613390dbc74ffd79008181f10cb941803c]
• Enhanced the indentation of examples for improved readability. [ba05428560c78266ec4ee7a2b88a7bcccabbff00]
• Minor textual improvements concerning the employment of PREMIS within SIPs. [f219da13fc3834dc4310b2146ab40bbb55bb9eac]
• Added a METS profile specific to SIP version 2.2.0. [baa2c9990f1f323334b2c15b681b6013193b3edd]
• Updated the incorrect cardinality of the <agent> element from SHOULD to MUST (requirement SIP12). [827cede48fc3870eb049fca733ab713308025681], [#101], [#102]
• Rectified a typo in the RECORDSTATUS controlled vocabulary entry from REPLEACEMENT to REPLACEMENT. [827cede48fc3870eb049fca733ab713308025681]
• Corrected a language attribute typo in the RECORDSTATUS vocabulary entry TEST from eb to en. [9176fc889af2decd3e5d44dfdaec1884e7d27dba]

Administrative

• The specification abstract has been updated for enhanced readability and clarity. The table of authors and the table of revisions have also been updated. [ba05428560c78266ec4ee7a2b88a7bcccabbff00]

Website and PDF Presentation

• The publication process for converting the markdown specification into its HTML and PDF formats has been significantly improved and updated.

[jmaferreira]

@shsdev @karinbredenberg What do you think of these release notes? Are they inline with your vision for this?

[shsdev]

@shsdev @karinbredenberg What do you think of these release notes? Are they inline with your vision for this?

Looks good to me.

[karinbredenberg]

Only thing is that for me some of the links looks like a 8 character hex code, if possible get them to say something people can understand instead.

Otherwise OK!

[jmaferreira]

Thanks Karin and Sven. The links are commit numbers. I didn't have an Issue to refer to, but I'll try to make it nicer.