|
@@ -54,7 +54,7 @@ A [working SIP
|
|
example](https://git.knowledgetx.com/scossu/pocket_archive/src/master/test/sample_submission)
|
|
example](https://git.knowledgetx.com/scossu/pocket_archive/src/master/test/sample_submission)
|
|
including files and a laundry list, used for testing, is available as a quick
|
|
including files and a laundry list, used for testing, is available as a quick
|
|
reference (note: the CSV file is currently displayed as a raw file. To view it
|
|
reference (note: the CSV file is currently displayed as a raw file. To view it
|
|
-as a spreadsheet, download it and open it with Libreoffice or another
|
|
|
|
|
|
+as a spreadsheet, download it and open it with LibreOffice or another
|
|
spreadsheet editor). Other examples are illustrated further down in this
|
|
spreadsheet editor). Other examples are illustrated further down in this
|
|
document.
|
|
document.
|
|
|
|
|
|
@@ -63,7 +63,7 @@ is successfully archived, it can be deleted. The full SIP can be regenerated by
|
|
the archive and retrieved at a later time.
|
|
the archive and retrieved at a later time.
|
|
|
|
|
|
The original files in the archivist's workstation can be optionally kept and/or
|
|
The original files in the archivist's workstation can be optionally kept and/or
|
|
-copied to local storage. This is stongly recommended, at least until Pocket
|
|
|
|
|
|
+copied to local storage. This is strongly recommended, at least until Pocket
|
|
Archive reaches a stable status and can be exclusively relied on for long-term
|
|
Archive reaches a stable status and can be exclusively relied on for long-term
|
|
preservation. More copies means more chances to recover data from corruption or
|
|
preservation. More copies means more chances to recover data from corruption or
|
|
loss, but it also means higher storage costs.
|
|
loss, but it also means higher storage costs.
|
|
@@ -104,7 +104,7 @@ This creates a collection, `my_collection`, with two members, `artifact1` and
|
|
containing `file3.mpg`.
|
|
containing `file3.mpg`.
|
|
|
|
|
|
Ordering of the files or folder in a SIP is defined in the laundry list, as we
|
|
Ordering of the files or folder in a SIP is defined in the laundry list, as we
|
|
-will see further down, so using file namings to force a certain order is not
|
|
|
|
|
|
+will see further down, so using file names to force a certain order is not
|
|
necessary (however it can provide a good starting point for large lists of
|
|
necessary (however it can provide a good starting point for large lists of
|
|
files or folders under a parent).
|
|
files or folders under a parent).
|
|
|
|
|
|
@@ -371,7 +371,7 @@ guide for more information about sub-types.
|
|
|
|
|
|
Types provided by Pocket Archive may have similar names but different uses. For
|
|
Types provided by Pocket Archive may have similar names but different uses. For
|
|
example, the `still_image` type, a sub-type of `artifact`, designates a visual
|
|
example, the `still_image` type, a sub-type of `artifact`, designates a visual
|
|
-object, e.g. a photograh. `still_image_file` may be the capture (e.g. scan) of
|
|
|
|
|
|
+object, e.g. a photograph. `still_image_file` may be the capture (e.g. scan) of
|
|
that object, but also the capture of a `text` artifact if it is the scan of a
|
|
that object, but also the capture of a `text` artifact if it is the scan of a
|
|
book page.
|
|
book page.
|
|
|
|
|
|
@@ -393,7 +393,7 @@ The ID is automatically generated and system-controlled. It cannot be changed.
|
|
A submission can also have a name, which is optional and user-defined. The
|
|
A submission can also have a name, which is optional and user-defined. The
|
|
submission name is determined by the file name used for the laundry list. E.g.
|
|
submission name is determined by the file name used for the laundry list. E.g.
|
|
`pkar_submission-my_new_collection.csv` will use `my_new_collection`, i.e. the
|
|
`pkar_submission-my_new_collection.csv` will use `my_new_collection`, i.e. the
|
|
-text between `pkar_submission-` and `.csv`, as the submission name. Submisson
|
|
|
|
|
|
+text between `pkar_submission-` and `.csv`, as the submission name. Submission
|
|
names are not required to be unique. Of course, the laundry list file names
|
|
names are not required to be unique. Of course, the laundry list file names
|
|
must be unique in the drop box they are deposited to.
|
|
must be unique in the drop box they are deposited to.
|
|
|
|
|
|
@@ -423,7 +423,7 @@ As mentioned before, explicitly adding IDs in a laundry list simplifies later
|
|
editing and management. However, this is one of the most tedious parts of a
|
|
editing and management. However, this is one of the most tedious parts of a
|
|
laundry list creation.
|
|
laundry list creation.
|
|
|
|
|
|
-Fortuntately, such repetitive and error-prone tasks can be easily automated
|
|
|
|
|
|
+Fortunately, such repetitive and error-prone tasks can be easily automated
|
|
with tools provided by most spreadsheet applications. A macro (a mini-program
|
|
with tools provided by most spreadsheet applications. A macro (a mini-program
|
|
that runs in an application) for LibreOffice Calc is [provided
|
|
that runs in an application) for LibreOffice Calc is [provided
|
|
here](https://git.knowledgetx.com/scossu/pocket_archive/src/master/src/util/libreoffice_idgen.bas)
|
|
here](https://git.knowledgetx.com/scossu/pocket_archive/src/master/src/util/libreoffice_idgen.bas)
|
|
@@ -432,16 +432,18 @@ table.
|
|
|
|
|
|
## Deleting resources
|
|
## Deleting resources
|
|
|
|
|
|
-Although some archivists argue against deleting *anything* from an archive,
|
|
|
|
-Pocket Archive acknowledge that in real life things may actually need to be
|
|
|
|
|
|
+Although some archivists advise against deleting *anything* from an archive,
|
|
|
|
+Pocket Archive acknowledges that in real life things may actually need to be
|
|
removed. The cause may be a duplicate, or something that was not supposed to
|
|
removed. The cause may be a duplicate, or something that was not supposed to
|
|
be archived, etc. In any case, the resource-conservative alignment of Pocket
|
|
be archived, etc. In any case, the resource-conservative alignment of Pocket
|
|
-Archive supports deleting resources immediately and irreversibly.
|
|
|
|
|
|
+Archive supports deleting resources immediately and irreversibly. Versioning
|
|
|
|
+and "soft" deletion, which keep prior states of resources including deleted
|
|
|
|
+ones, is not supported.
|
|
|
|
|
|
A resource can be deleted via the `pkar remove` CLI method, or by uploading a
|
|
A resource can be deleted via the `pkar remove` CLI method, or by uploading a
|
|
special file to the drop box, named `pkar_remove*` (asterisk means zero or more
|
|
special file to the drop box, named `pkar_remove*` (asterisk means zero or more
|
|
characters—note that the file name does not need an extension). The delete file
|
|
characters—note that the file name does not need an extension). The delete file
|
|
-must be a list of arhchival IDs, in the short **URI** form (`par:<ID>`), one
|
|
|
|
|
|
+must be a list of archival IDs, in the short **URI** form (`par:<ID>`), one
|
|
per line.
|
|
per line.
|
|
|
|
|
|
If `pkar_watch`, the process watching the drop box, was started with the `-r`
|
|
If `pkar_watch`, the process watching the drop box, was started with the `-r`
|