Skip to content

Commit

Permalink
Fixed: Logical paths clarification (#423)
Browse files Browse the repository at this point in the history
* Fixed: Logical paths clarification

Clarify that logical paths must not start with reserved characters. Also adds 'and path' in the definition of logical paths.

* Another kick at the logical path can

Updated based on @zimeon's original text.

* Fixed: Change SHOULD to MUST

* Fixed: Improved wording based on review
  • Loading branch information
ahankinson authored Mar 4, 2020
1 parent ccbf704 commit b102430
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion draft/spec/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -296,7 +296,8 @@ <h2>Terminology</h2>
</dt>
<dd>
A path that represents a file's location in the <a>logical state</a> of an object. Logical paths are
used in conjunction with a digest to represent the file name for a given bitstream at a given version.
used in conjunction with a digest to represent the file name and path for a given bitstream at a given
version.
</dd>
<dt>
<dfn>Logical State</dfn>:
Expand Down Expand Up @@ -699,6 +700,15 @@ <h2>Version</h2>
containing <a>logical path</a> names of files in the OCFL Object state that have
content with the given digest.
</p>
<p>
<a href="#logical-path">Logical paths</a> present the structure of an OCFL Object at a
given version. This is given as an array of values, with the following restrictions to
provide for path safety in the common case of the logical path value representing a file
path. The logical path MUST be interpreted as a set of one or more path elements joined by
a <code>/</code> path separator. Path elements MUST NOT be <code>.</code>, <code>..</code>,
or empty (<code>//</code>). Additionally, a logical path MUST NOT begin with a leading
<code>/</code>.
</p>
<blockquote class="informative">
<p>
Non-normative note: The <a>logical state</a> of the object uses content-addressing
Expand Down

0 comments on commit b102430

Please sign in to comment.