Skip to content

Commit

Permalink
improvements to specification text. Fixed identation of examples. upd…
Browse files Browse the repository at this point in the history
…ated authors and change log
  • Loading branch information
jmaferreira committed Mar 5, 2024
1 parent baa2c99 commit ba05428
Show file tree
Hide file tree
Showing 13 changed files with 242 additions and 222 deletions.
127 changes: 70 additions & 57 deletions specification/E-ARK-SIP_specification-v2.0.md

Large diffs are not rendered by default.

48 changes: 24 additions & 24 deletions specification/appendices/vocabs/vocabs.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,55 @@

### Package status
<a name="VocabularyRECORDSTATUS"></a>

**Maintained By:** DILCIS Board
<a name="VocabularyRECORDSTATUS"></a>

**Location:** [http://earksip.dilcis.eu/schema/SIPVocabularyRecordStatus.xml](http://earksip.dilcis.eu/schema/SIPVocabularyRecordStatus.xml)
**Maintained By:** DILCIS Board

**Context:** Used in `@RECORDSTATUS`
**Location:** [http://earksip.dilcis.eu/schema/SIPVocabularyRecordStatus.xml](http://earksip.dilcis.eu/schema/SIPVocabularyRecordStatus.xml)

**Description:**
**Context:** Used in `@RECORDSTATUS`

Describes the status of the package.
**Description:**

Describes the status of the package.

### Alternative record ID's
<a name="VocabularyaltrecordIDTYPE"></a>

**Maintained By:** DILCIS Board
<a name="VocabularyaltrecordIDTYPE"></a>

**Location:** [http://earksip.dilcis.eu/schema/SIPVocabularyRecordIDType.xml](http://earksip.dilcis.eu/schema/SIPVocabularyRecordIDType.xml)
**Maintained By:** DILCIS Board

**Context:** Used in `altrecordID/@TYPE`
**Location:** [http://earksip.dilcis.eu/schema/SIPVocabularyRecordIDType.xml](http://earksip.dilcis.eu/schema/SIPVocabularyRecordIDType.xml)

**Description:**
**Context:** Used in `altrecordID/@TYPE`

Describes the type of the alternative record ID.
**Description:**

Describes the type of the alternative record ID.

### Note type
<a name="VocabularyNoteType"></a>

**Maintained By:** DILCIS Board
<a name="VocabularyNoteType"></a>

**Location:** [http://earkcsip.dilcis.eu/schema/CSIPVocabularyNoteType.xml](http://earkcsip.dilcis.eu/schema/CSIPVocabularyNoteType.xml)
**Maintained By:** DILCIS Board

**Context:** Used in `@csip:NOTETYPE`
**Location:** [http://earkcsip.dilcis.eu/schema/CSIPVocabularyNoteType.xml](http://earkcsip.dilcis.eu/schema/CSIPVocabularyNoteType.xml)

**Description:**
**Context:** Used in `@csip:NOTETYPE`

Describes the type of a note for an agent.
**Description:**

Describes the type of a note for an agent.

### OAIS Package type

<a name="VocabularyOAISPackageType"></a>

**Maintained By:** DILCIS Board
**Maintained By:** DILCIS Board

**Location:** [http://earkcsip.dilcis.eu/schema/CSIPVocabularyOAISPackageType.xml](http://earkcsip.dilcis.eu/schema/CSIPVocabularyOAISPackageType.xml)
**Location:** [http://earkcsip.dilcis.eu/schema/CSIPVocabularyOAISPackageType.xml](http://earkcsip.dilcis.eu/schema/CSIPVocabularyOAISPackageType.xml)

**Context:** Used in `@csip:OAISPACKAGETYPE`
**Context:** Used in `@csip:OAISPACKAGETYPE`

**Description:**
**Description:**

Describes the OAIS type the package belongs to in the OAIS reference model.
Describes the OAIS type the package belongs to in the OAIS reference model.
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
| ID | Name, Location & Description | Card & Level |
| ------- | ---------------------------- | ------------ |
| <a name="REF_CSIP_2"></a>**REF_CSIP_2** | **Administrative metadata** <br/> <br/> The DIP amdSec element should comply with <br/> amdSec requirements in the CSIP profile. | <br/> SHOULD |
| ID | Name, Location & Description | Card & Level |
| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| <a name="REF_CSIP_2"></a>**REF_CSIP_2** | **Administrative metadata** <br/> <br/> The DIP amdSec element should comply with <br/> amdSec requirements in the CSIP profile. | <br/> SHOULD |
22 changes: 17 additions & 5 deletions specification/implementation/metadata/mets/filesec/examples.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,22 @@

**Example:** METS example of an SIP with file information together with the info from CS IP.

```xml
<mets:file ID="uuid-0C0049CA-6DE0-4A6D-8699-7975E4046A81" MIMETYPE="application/vnd.openxmlformats-officedocument.wordprocessingml.document" SIZE="2554366" CREATED="2012-08-15T12:08:15.432+01:00" CHECKSUM="91B7A2C0A1614AA8F3DAF11DB4A1C981F14BAA25E6A0336F715B7C513E7A1557" CHECKSUMTYPE="SHA-256" FILEFORMATNAME="Microsoft Word for Windows" FILEFORMATVERSION="2007 onwards" FORMATREGISTRY="PRONOM" FORMATREGISTRYKEY="fmt/412">
<mets:FLocat LOCTYPE="URL" type="simple" href="documentation/File.docx">
</mets:FLocat>
<mets:file
ID="uuid-0C0049CA-6DE0-4A6D-8699-7975E4046A81"
MIMETYPE="application/vnd.openxmlformats-officedocument.wordprocessingml.document"
SIZE="2554366"
CREATED="2012-08-15T12:08:15.432+01:00"
CHECKSUM="91B7A2C0A1614AA8F3DAF11DB4A1C981F14BAA25E6A0336F715B7C513E7A1557"
CHECKSUMTYPE="SHA-256"
FILEFORMATNAME="Microsoft Word for Windows"
FILEFORMATVERSION="2007 onwards"
FORMATREGISTRY="PRONOM"
FORMATREGISTRYKEY="fmt/412">

<mets:FLocat
LOCTYPE="URL"
type="simple"
href="documentation/File.docx"/>

</mets:file>
```

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
| ID | Name, Location & Description | Card & Level |
| ------- | ---------------------------- | ------------ |
| ID | Name, Location & Description | Card & Level |
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
| <a name="SIP32"></a>**SIP32** | **File format name** <br/> `fileSec/fileGrp/file/@sip:FILEFORMATNAME` <br/> An optional attribute may be used if the MIMETYPE is not sufficient for the purposes of processing the information package. <br/> Example: "Extensible Markup Language" <br/> Example: "PDF/A" <br/> Example: "ISO/IEC 26300:2006" | **0..1** <br/> MAY |
| <a name="SIP33"></a>**SIP33** | **File format version** <br/> `fileSec/fileGrp/file/@sip:FILEFORMATVERSION` <br/> The version of the file format when the use of PREMIS has not been agreed upon in the submission agreement. <br/> Example: "1.0" | **0..1** <br/> MAY |
| <a name="SIP34"></a>**SIP34** | **File format registry** <br/> `fileSec/fileGrp/file/@sip:FILEFORMATREGISTRY` <br/> The name of the format registry used to identify the file format when the use of PREMIS has not been agreed upon in the submission agreement. <br/> Example: "PRONOM" | **0..1** <br/> MAY |
| <a name="SIP35"></a>**SIP35** | **File format registry key** <br/> `fileSec/fileGrp/file/@sip:FILEFORMATKEY` <br/> Key of the file format in the registry when use of PREMIS has not been agreed upon in the submission agreement. <br/> Example: "fmt/101" | **0..1** <br/> MAY |
| <a name="SIP33"></a>**SIP33** | **File format version** <br/> `fileSec/fileGrp/file/@sip:FILEFORMATVERSION` <br/> The version of the file format when the use of PREMIS has not been agreed upon in the submission agreement. <br/> Example: "1.0" | **0..1** <br/> MAY |
| <a name="SIP34"></a>**SIP34** | **File format registry** <br/> `fileSec/fileGrp/file/@sip:FILEFORMATREGISTRY` <br/> The name of the format registry used to identify the file format when the use of PREMIS has not been agreed upon in the submission agreement. <br/> Example: "PRONOM" | **0..1** <br/> MAY |
| <a name="SIP35"></a>**SIP35** | **File format registry key** <br/> `fileSec/fileGrp/file/@sip:FILEFORMATKEY` <br/> Key of the file format in the registry when use of PREMIS has not been agreed upon in the submission agreement. <br/> Example: "fmt/101" | **0..1** <br/> MAY |
10 changes: 7 additions & 3 deletions specification/implementation/metadata/mets/mets-root/examples.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@

**Example:** METS root element example with values from E-ARK-SIP as well as CS IP.

```xml
<mets:mets OBJID="uuid-4422c185-5407-4918-83b1-7abfa77de182" LABEL="Accounting records of 2017" TYPE="OTHER" OTHERTYPE="Accounting" PROFILE="https://earksip.dilcis.eu/profile/E-ARK-SIP.xml" schemaLocation="http://www.loc.gov/METS/ http://www.loc.gov/standards/mets/mets.xsd http://www.w3.org/1999/xlink http://www.loc.gov/standards/mets/xlink.xsd https://dilcis.eu/XML/METS/CSIPExtensionMETS https://dilcis.eu/XML/METS/CSIPExtensionMETS/DILCISExtensionMETS.xsd">
<mets:mets
OBJID="uuid-4422c185-5407-4918-83b1-7abfa77de182"
LABEL="Accounting records of 2017"
TYPE="OTHER"
OTHERTYPE="Accounting"
PROFILE="https://earksip.dilcis.eu/profile/E-ARK-SIP-v2-1-1.xml"
schemaLocation="http://www.loc.gov/METS/ http://www.loc.gov/standards/mets/mets.xsd http://www.w3.org/1999/xlink http://www.loc.gov/standards/mets/xlink.xsd https://dilcis.eu/XML/METS/CSIPExtensionMETS https://dilcis.eu/XML/METS/CSIPExtensionMETS/DILCISExtensionMETS.xsd">
</mets:mets>
```

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
| ID | Name, Location & Description | Card & Level |
| ------- | ---------------------------- | ------------ |
| <a name="SIP1"></a>**SIP1** | **Package name** <br/> `mets/@LABEL` <br/> An optional short text describing the contents of the package, e.g. "Accounting records of 2017". | **0..1** <br/> MAY |
| <a name="SIP2"></a>**SIP2** | **METS Profile** <br/> `mets/@PROFILE` <br/> The value is set to "https://earksip.dilcis.eu/profile/E-ARK-SIP.xml". | **1..1** <br/> MUST |
| ID | Name, Location & Description | Card & Level |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
| <a name="SIP1"></a>**SIP1** | **Package name** <br/> `mets/@LABEL` <br/> An optional short text describing the contents of the package, e.g. "Accounting records of 2017". | **0..1** <br/> MAY |
| <a name="SIP2"></a>**SIP2** | **METS Profile** <br/> `mets/@PROFILE` <br/> The value is set to "https://earksip.dilcis.eu/profile/E-ARK-SIP-v2-1-1.xml". | **1..1** <br/> MUST |
14 changes: 11 additions & 3 deletions specification/implementation/metadata/mets/metshdr/examples.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,36 @@

**Example:** METS example of altrecordID's, and SIP agents following the SIP profile as well as CS IP.

```xml
<mets:metsHdr CREATEDATE="2018-04-24T14:37:49.602+01:00" LASTMODDATE="2018-04-24T14:37:49.602+01:00" RECORDSTATUS="NEW" OAISPACKAGETYPE="SIP">
<mets:metsHdr
CREATEDATE="2018-04-24T14:37:49.602+01:00"
LASTMODDATE="2018-04-24T14:37:49.602+01:00"
RECORDSTATUS="NEW"
OAISPACKAGETYPE="SIP">

<mets:agent ROLE="ARCHIVIST" TYPE="ORGANIZATION">
<mets:name>The Swedish health agency</mets:name>
<mets:note NOTETYPE="IDENTIFICATIONCODE">VAT:SE201345098701</mets:note>
</mets:agent>

<mets:agent ROLE="CREATOR" TYPE="ORGANIZATION">
<mets:name>The agency, Personnel</mets:name>
<mets:note NOTETYPE="IDENTIFICATIONCODE">VAT:SE2098109810-AF87</mets:note>
</mets:agent>

<mets:agent ROLE="OTHER" TYPE="INDIVIDUAL" OTHERROLE="SUBMITTER">
<mets:name>Sven Svensson</mets:name>
<mets:note>Phone: 08-123456, Email: sven.svensson@mail.mail</mets:note>
</mets:agent>

<mets:agent ROLE="PRESERVATION" TYPE="ORGANIZATION">
<mets:name>The archives</mets:name>
<mets:note NOTETYPE="IDENTIFICATIONCODE">ID:1234567</mets:note>
</mets:agent>

<mets:altrecordID TYPE="SUBMISSIONAGREEMENT">http://submissionagreement.kb.se/dnr331-1144-2011/20120711/</mets:altrecordID>
<mets:altrecordID TYPE="PREVIOUSSUBMISSIONAGREEMENT">FM 12-2387/12726, 2007-09-19</mets:altrecordID>
<mets:altrecordID TYPE="REFERENCECODE">SE/RA/123456/24/P</mets:altrecordID>
<mets:altrecordID TYPE="PREVIOUSREFERENCECODE">SE/FM/123/123.1/123.1.3</mets:altrecordID>

</mets:metsHdr>
```

Loading

0 comments on commit ba05428

Please sign in to comment.