Browse Source

Update documentation.

Stefano Cossu 5 days ago
parent
commit
9f4e9a2f9d
2 changed files with 26 additions and 1 deletions
  1. 1 1
      doc/roadmap.md
  2. 25 0
      doc/submission.md

+ 1 - 1
doc/roadmap.md

@@ -67,7 +67,7 @@ usage and opportunities for expanding adoption in relevant areas.
 - ⚒ Content model
   - ✓ Generate content model documentation (HTML)
   - ❏ Multilingual support
-  -  Content model dump (CLI)
+  -  Content model dump (CLI)
   - ❏ Local overrides
 - ⚒ Presentation
   - ⎊ Generate site for one collection only

+ 25 - 0
doc/submission.md

@@ -34,6 +34,8 @@ Archive.](./pkar_res_lifecycle.png)
 8. If the archivist wants to update the archived resources, they can either
    request a full copy of the SIP, or to only update metadata, only the laundry
    list, and re-submit it.
+9. The archivist can remove a resource and, optionally, all its members at any
+   time.
 
 Processing of the SIP (point 4 above) either succeeds or fails as a unit. This
 means that a submission will never perform only a part of the task that it is
@@ -167,6 +169,11 @@ depends on the content model used.
 - `source_path`: mandatory for files, single-valued. It refers to the
   file or folder path relative to the package, using forward slash `/`
   characters to separate folders and subfolders or files.
+- `has_member`: this behaves like all normal properties, but it has a special
+  meaning when deleting resources. If the `--members` option is provided,
+  resources linked via the `has_member` property to the resource bing deleted
+  are also deleted, along with their own members, recursively. See the
+  "Deleting resources" section below.
 
 Example of a table representing an artifact with two files:
 
@@ -413,3 +420,21 @@ with tools provided by most spreadsheet applications. A macro (a mini-program
 that runs in an application) for LibreOffice Calc is [provided
 here](../src/util/libreoffice_idgen.bas) to automatically generate 16-character
 IDs for all the cells selected in a table.
+
+## 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
+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
+Archive supports deleting resources immediately and irreversibly.
+
+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
+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
+per line.
+
+If `pkar_watch`, the process watching the drop box, was started with the `-r`
+option, all members of the resources are recursively deleted (this means also
+members of members).