From 7bcc683efddc1af5d9e52cbd9acd0a9995c8f5cd Mon Sep 17 00:00:00 2001 From: Andrew Hankinson Date: Tue, 29 Oct 2019 17:30:07 +0000 Subject: [PATCH] Initial pass at wording for extensions directory --- draft/spec/index.html | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/draft/spec/index.html b/draft/spec/index.html index d8296d0a..a3eee52e 100644 --- a/draft/spec/index.html +++ b/draft/spec/index.html @@ -854,7 +854,17 @@

Logs Directory

wrong, while others may wish to only store a log entry if an intervention was required.

+ +
+

Extensions directory

+

+ The base directory of an OCFL Object MAY contain a directory named extensions for the purposes + of extending the functionality of an OCFL Object. Sub-directories of the extensions directory MUST be named + according to a registered extension name. OCFL Validators MUST ignore any content in extensions that are + not understood. The specific structure and function of the extension, as well as a declaration of the + registered extension name MUST be defined in the OCFL Extensions Registry. +

@@ -953,7 +963,7 @@

Storage Hierarchies

-

Extensions

+

Root Extensions

The behavior of the storage root may be extended to support features from other specifications. An OCFL validator MUST ignore any files in the storage root it does not understand. Additional @@ -1512,6 +1522,27 @@

Moab in an OCFL Object

}
+
+

Example Extended OCFL Object

+

+ The following example OCFL Object has an extension containing custom content. The OCFL Object itself + remains valid. +

+
+[object root]
+    ├── 0=ocfl_object_1.0
+    ├── inventory.json
+    ├── inventory.json.sha512
+    ├── extensions
+    │   └── my-extension
+    │       └── file1-new.txt
+    └── v1
+        ├── inventory.json
+        ├── inventory.json.sha512
+        └── content
+            └── file.txt
+
+