Skip to content

Latest commit

 

History

History
110 lines (83 loc) · 2.68 KB

NNNN-content-subpath.md

File metadata and controls

110 lines (83 loc) · 2.68 KB
Raw

OCFL Community Extension NNNN: Content Subpath

  • Extension Name: NNNN-content-subpath
  • Authors: Jürgen Enge (Basel)
  • Minimum OCFL Version: 1.0
  • OCFL Community Extensions Version: 1.0
  • Obsoletes: n/a
  • Obsoleted by: n/a

Overview

This object extension permits the creation of an additional path hierarchy within the content folder of an object version. In essence, the concept of an "area" encompasses both a folder name and a description. This allows for the alteration of subfolders while ensuring that the gocfl tools are able to identify the location of the content. It is imperative that one ˋareaˋ is designated as "content" to guarantee that the payload can be readily accessed by any ocfl tool.

Usage Scenario

This extra path layer lets you create subfolders for meta, data and log, for example. The data folder is where you'll find the payload for the archived object. You can use these three folders to organise content, metadata and logging.

Parameters

Summary

  • Name: subPath
    • Description: map of named PathDescription. The entry name is the area.
    • Type: map
    • Default:

PathDescription

  • Name: path

    • Description: subpath in object content
    • Type: string
    • Default:

  • Name: description

    • Description: description of content belonging to this subfolder
    • Type: string
    • Default:

Caveat

There MUST exist an area called content since this is the default area for adding payload files.

Procedure

When adding a content file the subfolder will be automatically inserted into the content path of the manifest. Within the version content folder write a readme.md file containing the description of the folders.

Examples

Parameters

It is not necessary to specify any parameters to use the default configuration. However, if you were to do so, it would look like the following:

{
  "extensionName": "NNNN-content-subpath",
  "subPath": {
    "content": {
      "path": "data",
      "description": "Payload of archival object"
    },
    "metadata": {
      "path": "meta",
      "description": "additional semantic metadata"
    },
    "index": {
      "path": "index",
      "description": "additional technical metadata"
    }
  }
}

Result

File Structure

\---content
    |   README.md
    |
    +---data
    |   |   [...]
    |   |
    |   \---[...]
    +---meta
    |   |   [...]
    |
    \---index
            indexer_v1.jsonl

readme.md

### Description of folders


##### data
Payload of archival object

##### meta
additional semantic metadata

##### index
additional technical metadata