Improvements/aipreadme - Revision history

Jhs: changing README.txt to README.html

2017-06-21T00:03:45Z

changing README.txt to README.html

Dan: minor fixes to formatting

2017-06-20T19:18:52Z

minor fixes to formatting

Evelyn: /* Sample README file text */

2017-06-20T18:12:06Z

Sample README file text

Evelyn: /* Sample README file text */

2017-06-20T18:10:52Z

Sample README file text

Evelyn: /* Sample README file text */

2017-06-20T18:05:37Z

Sample README file text

Evelyn: /* Sample README file text */

2017-06-20T18:03:43Z

Sample README file text

Evelyn: /* Sample README file text */

2017-06-20T17:56:10Z

Sample README file text

Evelyn: /* Sample README file text */

2017-06-20T17:55:07Z

Sample README file text

Sallain: /* Sample README file text */

2017-06-19T18:42:07Z

Sample README file text

Sallain: /* Sample README file text */

2017-06-19T18:00:24Z

Sample README file text

@@ Line 93: / Line 93: @@
 (9)        ├── thumbnails
 (10)       ├── METS.0ad8cdab-dbbf-4863-8a4d-9a675c227216.xml
-(11)  	   └── README.txt
+(11)  	   └── README.html
 </pre>
@@ Line 103: / Line 103: @@
 (9) thumbnails directory - contains thumbnails generated from the original object for use in the Archivematica user interface</p>
 (10) the Archivematica METS file</p>
-(11) this README text file</p>
+(11) this README file</p>
 === Use case: Create and Use a Bag Profile ===

@@ Line 35: / Line 35: @@
 ====Sample README file text====
-This readme file describes the basic structure of an AIP generated by Archivematica.
+This readme file describes the basic structure of an Archival Information Package (AIP) generated by Archivematica.
 '''Acronyms'''
@@ Line 97: / Line 97: @@
 (1) AIP root directory, with an appended UUID</p>
-(2)-(5): Standard packaging files produced in accordance with the BagIt specification.</p>
+(2)-(5) Standard packaging files produced in accordance with the BagIt specification.</p>
-(6): data directory - this is also a standard directory specified by the BagIt specification. The data directory contains the AIP Content Information and PDI</p>
+(6) data directory - this is also a standard directory specified by the BagIt specification. The data directory contains the AIP Content Information and PDI</p>
 (7) logs directory - contains log outputs of some of the tools that Archivematica uses in generating the AIP</p>
 (8) objects directory - contains the original digital objects as well as normalized versions</p>

@@ Line 98: / Line 98: @@
 (1) AIP root directory, with an appended UUID</p>
 (2)-(5): Standard packaging files produced in accordance with the BagIt specification.</p>
-(6): data directory - this is also a standard directory specified by the BagIt specification. The data directory contains the AIP Content Information and PDI file</p>
+(6): data directory - this is also a standard directory specified by the BagIt specification. The data directory contains the AIP Content Information and PDI</p>
 (7) logs directory - contains log outputs of some of the tools that Archivematica uses in generating the AIP</p>
 (8) objects directory - contains the original digital objects as well as normalized versions</p>

@@ Line 97: / Line 97: @@
 (1) AIP root directory, with an appended UUID</p>
-(2)-(5): Standard packaging files produced in accordance with the IETF Trust ''BagIt File Packaging Format'' specification.</p>
+(2)-(5): Standard packaging files produced in accordance with the BagIt specification.</p>
-(6): data directory - contains subdirectories logs, objects, and thumbnails, as well as the METS file</p>
+(6): data directory - this is also a standard directory specified by the BagIt specification. The data directory contains the AIP Content Information and PDI file</p>
-(7) logs directory - contains the log outputs of the various tools that Archivematica uses in generating the AIP (8) objects directory - contains the original digital objects as well as normalized versions</p>
+(7) logs directory - contains log outputs of some of the tools that Archivematica uses in generating the AIP</p>
-(9) thumbnails directory - contains thumbnails generated from the original object for use in the Archivematica user interface
+(8) objects directory - contains the original digital objects as well as normalized versions</p>
 (10) the Archivematica METS file</p>
 (11) this README text file</p>

@@ Line 48: / Line 48: @@
 '''Introduction'''
-Archivematica is an open-source suite of tools designed to ingest diverse digital content and prepare AIPs for long-term storage. Once an AIP is generated it is not dependent on Archivematica for retrieval, and can be opened using any standard file browser. The concept of an AIP is derived from the ISO 14721:2012 Reference Model for an ''Open Archival Information System (OAIS)'', which defines it as “[a]n Information Package, consisting of the Content Information and the associated Preservation Description Information (PDI), which is preserved within an OAIS.”
+Archivematica is an open-source suite of tools designed to ingest diverse digital content and prepare AIPs for long-term storage. Once an AIP is generated it is not dependent on Archivematica for retrieval, and can be opened using any standard file browser. The concept of an AIP is derived from the ISO 14721:2012 ''Reference Model for an Open Archival Information System (OAIS)'', which defines it as “[a]n Information Package, consisting of the Content Information and the associated Preservation Description Information (PDI), which is preserved within an OAIS.”
 '''Content Information'''

← Older revision		Revision as of 17:55, 20 June 2017
Line 77:		Line 77:

	The fileSec and structMap use identifier attributes to link a digital object to its amdSec and (if used) dmdSec. For example, if a file entry in the fileSec has the attribute ''ADMID="amdSec_1"'' this means that the amdSec with the identifier ''amdSec_1'' contains the administrative (i.e. technical and provenance) metadata for that file. The fileSec also uses a group identifier attribute to indicate relationships between digital objects. For example, if file A in ''fileGrp "USE=original"'' and file B in ''fileGrp "USE="preservation"'' both have the group identifier attribute ''"Group-269b494d-01cb-451b-8d5e-590d57126d3d"'', then file B is a preservation version generated from file A.		The fileSec and structMap use identifier attributes to link a digital object to its amdSec and (if used) dmdSec. For example, if a file entry in the fileSec has the attribute ''ADMID="amdSec_1"'' this means that the amdSec with the identifier ''amdSec_1'' contains the administrative (i.e. technical and provenance) metadata for that file. The fileSec also uses a group identifier attribute to indicate relationships between digital objects. For example, if file A in ''fileGrp "USE=original"'' and file B in ''fileGrp "USE="preservation"'' both have the group identifier attribute ''"Group-269b494d-01cb-451b-8d5e-590d57126d3d"'', then file B is a preservation version generated from file A.
		+
		+	'''AIP structure'''
		+
		+	An Archivematica AIP is packaged into a bag in accordance with the Library of Congress BagIt specification, and contains some contents not described in the sections above. This tree structure depicts a typical Archivematica AIP:
		+
		+	<pre>
		+	(1) AIP-name-e3a3988d-8149-49ea-adc5-c255fb68d4f9
		+	(2) ├── bag-info.txt
		+	(3) ├── bagit.txt
		+	(4) ├── manifest-sha512.txt
		+	(5) ├── tagmanifest-md5.txt
		+	(6) └── data
		+	(7) ├── logs
		+	(8) ├── objects
		+	(9) ├── thumbnails
		+	(10) ├── METS.0ad8cdab-dbbf-4863-8a4d-9a675c227216.xml
		+	(11) └── README.txt
		+	</pre>
		+
		+	(1) AIP root directory, with an appended UUID</p>
		+	(2)-(5): Standard packaging files produced in accordance with the Bagit Specification. See the specification for more information</p>
		+	(6): data directory - contains subdirectories logs, objects, and thumbnails, as well as the METS file</p>
		+	(7) logs directory - contains the log outputs of the various tools that Archivematica uses in generating the AIP (8) objects directory - contains the original digital objects as well as normalized versions</p>
		+	(9) thumbnails directory - contains thumbnails generated from the original object for use in the Archivematica user interface (10) the Archivematica METS file</p>

	=== Use case: Create and Use a Bag Profile ===		=== Use case: Create and Use a Bag Profile ===

@@ Line 54: / Line 54: @@
 In an Archivematica AIP, the Content Information consists primarily of the originally ingested digital objects and any preservation versions of the objects created to mitigate the risk of format obsolescence over time. The preservation copies typically have the same filenames as the original objects but with different file extensions and with UUIDs appended to the filename. For example, for an original file named ''BBhelmet.ai'' the preservation version may be named ''BBhelmet-e3a3988d-8149-49ea-adc5-c255fb68d4f9.pdf''.
-The originally ingested digital objects and any preservation versions are located in the ''objects'' directory of the AIP. There will be nested subdirectories in the ''objects'' directory if these subdirectories were included in the original transfer or added during SIP arrangement. The ''objects'' directory also includes a ''submissiondocumentation'' folder and a ''metadata'' folder. The ''submissiondocumentation'' folder contains documentation such as donor agreements and transfer forms, if these are included in the AIP, as well as a METS file that records the contents of the original transfer(s) from which the AIP was created. The ''metadata'' folder holds any metadata files included in the original transfer(s), and any OCR text files generated during processing.
+The originally ingested digital objects and any preservation versions are located in the ''objects'' directory of the AIP. There will be nested subdirectories in the ''objects'' directory if these subdirectories were included in the original transfer or added during SIP arrangement. The ''objects'' directory also includes a ''submissionDocumentation'' folder and a ''metadata'' folder. The ''submissionDocumentation'' folder contains documentation such as donor agreements and transfer forms, if these are included in the AIP, as well as a METS file that records the contents of the original transfer(s) from which the AIP was created. The ''metadata'' folder holds any metadata files included in the original transfer(s), and any OCR text files generated during processing.
 '''Preservation Description Information (PDI)'''