Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove ocfl_layout.json #481

Closed
wants to merge 1 commit into from
Closed

Remove ocfl_layout.json #481

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 2 additions & 21 deletions draft/spec/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -975,23 +975,6 @@ <h2>Root Structure</h2>
<a href="#storage-root-extensions">storage root extensions</a>. An OCFL validator
<span id="E087">MUST</span> ignore any files in the storage root it does not understand.
</p>
<p>
An OCFL Storage Root MAY contain a JSON file named <code>ocfl_layout.json</code> to describe the arrangement
of directories and OCFL objects under the storage root. If present, this JSON document
<span id="E070">MUST</span> include the following two keys in the root JSON object:
</p>
<ul>
<li>
<code>key</code> - A key identifying the precise arrangement of directories and OCFL objects under the
storage root, i.e. how OCFL object identifiers are mapped to directory hierarchies. The value of this key
is not defined in the OCFL specification, but <span id="E071">MUST</span> correspond to a value given in an
<a>Extension</a>.
</li>
<li>
<code>description</code> - A human readable description of the arrangement of directories and OCFL
objects under the storage root.
</li>
</ul>
<p>
An OCFL Storage Root <span id="E088">MUST NOT</span> contain directories or sub-directories other than as
a directory hierarchy used to store OCFL Objects or for <a href="#storage-root-extensions">storage root
Expand All @@ -1010,8 +993,7 @@ <h2>Root Structure</h2>
<pre>
[storage_root]
├── 0=ocfl_1.0
├── ocfl_1.0.txt (human-readable text of the OCFL specification; optional)
└── ocfl_layout.json (description of storage hierarchy layout; optional)
└── ocfl_1.0.txt (human-readable text of the OCFL specification; optional)
</pre>
</section>

Expand Down Expand Up @@ -1633,8 +1615,7 @@ <h2>Example Extended OCFL Storage Root</h2>
├── extensions
│   └── 0000-example-extension
│   └── file-example.txt
├── ocfl_1.0.txt
└── ocfl_layout.json
└── ocfl_1.0.txt
</pre>
</section>
<section id="example-extended-object">
Expand Down
2 changes: 0 additions & 2 deletions validation/validation-codes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,6 @@
| E067 | 'The extensions directory must not contain any files, and no sub-directories other than extension sub-directories.' | https://ocfl.io/draft/spec/#E067
| E068 | 'The specific structure and function of the extension, as well as a declaration of the registered extension name must be defined in one of the following locations: The OCFL Extensions repository OR The Storage Root, as a plain text document directly in the Storage Root.' | https://ocfl.io/draft/spec/#E068
| E069 | 'An OCFL Storage Root MUST contain a Root Conformance Declaration identifying it as such.' | https://ocfl.io/draft/spec/#E069
| E070 | 'If present, [the ocfl_layout.json document] MUST include the following two keys in the root JSON object: [key, description]' | https://ocfl.io/draft/spec/#E070
| E071 | 'The value of [the ocfl_layout.json key "key"] is not defined in the OCFL specification, but MUST correspond to a value given in an Extension.' | https://ocfl.io/draft/spec/#E071
| E072 | 'The directory hierarchy used to store OCFL Objects MUST NOT contain files that are not part of an OCFL Object.' | https://ocfl.io/draft/spec/#E072
| E073 | 'Empty directories MUST NOT appear under a storage root.' | https://ocfl.io/draft/spec/#E073
| E074 | 'Although implementations may require multiple OCFL Storage Roots - that is, several logical or physical volumes, or multiple "buckets" in an object store - each OCFL Storage Root MUST be independent.' | https://ocfl.io/draft/spec/#E074
Expand Down