Rel/2.3.0#145
Open
jmaferreira wants to merge 17 commits intomasterfrom
Open
Conversation
…2.3.0 Key changes include: - Updating the profile URI to https://earksip.dilcis.eu/profile/E-ARK-SIP-v2-3-0.xml. - Updating the profile title to E-ARK SIP METS Profile. - Adding a more comprehensive abstract for the profile.- Updating the profile date to 2025-02-19. - Updating requirement SIP9 (agent that creates the SIP package) to have cardinality of 3..* . - Updating requirement SIP10 (SIP creator role) to specify that the role must be CREATOR. - Updating requirement SIP11 (SIP Creator type). - Updating requirement SIP12 (SIP creator name). - Updating requirement SIP13 (SIP creator note). \ - Updating requirement SIP14 (SIP creator identification code). - Updating requirement SIP15 (SIP Submitter agent). - Updating requirement SIP16 (SIP Submitter role). - Updating requirement SIP17 (SIP Submitter other role). - Updating requirement SIP18 (SIP Submitter type). - Updating requirement SIP19 (SIP Submitter name). - Updating requirement SIP20 (SIP Submitter note). - Updating requirement SIP21 (SIP Submitter identification code). - Removed optional elements from requirements - Updating the examples accordingly.
…ment and its use. Improved the examples. Removed optional agent requirements from the requirements table. Renamed some files that had typos. Placed vocabularies in diferent files. Marked some files as DEPRECATED.
- now handles line endings in descriptions properly.
- converted all markdown files below the `specification` directory to AsciiDoc using kramdown-asciidoc; - did not convert the duplicate PDF specific `postface` markdown files; and - removed the markdown source files.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* MAINT: Convert Markdown specification to AsciiDoc - converted all markdown files below the `specification` directory to AsciiDoc using kramdown-asciidoc; - did not convert the duplicate PDF specific `postface` markdown files; and - removed the markdown source files. * FIX: Typo in revisions.adoc Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * FIX: replace pass through with ticks. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * MAINT: Created basic AsciiDoc structure - created new format `specification.yaml` file: - removed `preface:` section; - renamed `body:` section `tables:`; - removed all `type: file` entries, these transferred to `specification/E-ARK-SIP.adoc` as `include::` directives; - added new top-level AsciiDoc source file with include directives that reflect the structure removed from `specification.yaml`; - added `[chapter]` indicators to level one headings in document; - fixed XML validation issues in old METS profiles, and in the new v2.3 profile; - converted any defunct Markdown preprocessor `!INCLUDE` directives with AsciiDoc `include::` equivalents; and - updated `spec-publisher` project to generate AsciiDoc tables and appendices. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* MAINT: Convert Markdown specification to AsciiDoc - converted all markdown files below the `specification` directory to AsciiDoc using kramdown-asciidoc; - did not convert the duplicate PDF specific `postface` markdown files; and - removed the markdown source files. * FIX: Typo in revisions.adoc Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * FIX: replace pass through with ticks. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * MAINT: Created basic AsciiDoc structure - created new format `specification.yaml` file: - removed `preface:` section; - renamed `body:` section `tables:`; - removed all `type: file` entries, these transferred to `specification/E-ARK-SIP.adoc` as `include::` directives; - added new top-level AsciiDoc source file with include directives that reflect the structure removed from `specification.yaml`; - added `[chapter]` indicators to level one headings in document; - fixed XML validation issues in old METS profiles, and in the new v2.3 profile; - converted any defunct Markdown preprocessor `!INCLUDE` directives with AsciiDoc `include::` equivalents; and - updated `spec-publisher` project to generate AsciiDoc tables and appendices. * MAINT: Logical flow for AsciiDoc document - all AsciiDoc document parts now represent a logical document section, i.e. each starts with a top leve H1; - table includes moved to the logical point in each document; - correct AsciiDoc indicator for Appendices, Bibliography, etc. - removed headings from tables in `specification.yaml; - control `imagedir` properly in `specification/E-ARK-SIP.adoc` document; and - updated `spec-publisher` project to format requirement table lines properly. --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Miguel Ferreira <mferreira@keep.pt>
* Fixes issue #139 * MAINT: Updated GitHub Actions versions. * MAINT: Update spec-publisher - now handles line endings in descriptions properly. * FIX: Update spec-publisher for table bug fix. --------- Co-authored-by: Miguel Ferreira <mferreira@keep.pt>
* Fixes issue #139 * MAINT: Updated GitHub Actions versions. * MAINT: Update spec-publisher - now handles line endings in descriptions properly. * FIX: Update spec-publisher for table bug fix. --------- Co-authored-by: Miguel Ferreira <mferreira@keep.pt>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces a new version of the SIP specification (v2.3.0) for publication on September, 2025.
Specification Changes
Version 2.3.0 of the SIP specification introduces textual enhancements and clarifications, correction of reported issues which included adjustments to the cardinality of certain METS elements and comprehensive updates to examples and METS profiles.
Corrections
Fixed issue [METS CSIP related profile should be v2.2 and url should include version in order to resolve correctly. #139]: The issue had to do with a correction that was necessary to the E-ARK-SIP profile in the element <related_profile> which wrongly referenced E-ARK CSIP METS Profile 2.1 instead of E-ARK CSIP METS Profile v2.2.0.
Fixed issue [METS SIP Header Agent Elements SIP9 to SIP12 #141]: The issue found an incongruence on the cardinality of the element between the SIP specification and the Common specification. The common specification (CSIP) states that an IP should include one and only one agent element to describe the SOFTWARE used to create the package. This is defined in requirements CSIP10 to CSIP16. The SIP specification adds to this requirement stating that, additionally, the SIP could also include information about the following agents:
The issue also allowed us to detect some misalignments between the description of agents and the METS specification. The entire section about agents on the SIP specification has been entirely revised and simplified. Optional requirements have been greatly removed from the specification, and the description of mandatory requirements has been improved for better clarity.