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

Fixed: Clarify Namaste requirements #263

Merged
merged 2 commits into from
Dec 9, 2018
Merged

Fixed: Clarify Namaste requirements #263

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a9eca1
Fixed: Clarify Namaste requirements
ahankinson Nov 7, 2018
838648e
Fixed: Typos in Namaste requirements
ahankinson Dec 5, 2018
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
19 changes: 10 additions & 9 deletions draft/spec/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,11 +349,12 @@ <h2>Object Structure</h2>
<section id="object-conformance-declaration">
<h2>Object Conformance Declaration</h2>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on the updated text, it would seem that the section title should now become: "Storage Root Conformance Declaration".

<p>
The version declaration MUST be formatted according to the [[!NAMASTE]] specification. It MUST be an empty
file in the base directory of the object giving the OCFL Object version in the filename. The filename MUST
be constructed with a leading zero-equals (<code>0=</code>) string, the string <code>ocfl_object_</code>,
followed by the OCFL specification version number. For example <code>0=ocfl_object_1.0</code> for version
1.0 of this specification.
The version declaration MUST be formatted according to the [[!NAMASTE]] specification. It MUST be an
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

an -> a

file in the base directory of the <a>OCFL Storage Root</a> giving the OCFL version in the filename.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given the current section title, "Object Conformance Declaration", I would suggest not changing "base directory of the object" to "base directory of the OCFL Storage Root".
...unless we are no longer specifying the inclusion of a NAMASTE file in the object base.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is just a simple error, should be "OCFL Object" not "OCFL Storage Root"

The filename MUST conform to the pattern <code>T=dvalue</code>, where <code>T</code> MUST be 0, and
<code>dvalue</code> MUST be <code>ocfl_object_</code>, followed by the OCFL specification version number.
The text contents of the file MUST be the same as <code>dvalue</code>, followed by a newline
(<code>\n</code>).
</p>
</section>

Expand Down Expand Up @@ -765,10 +766,10 @@ <h2>Root Structure</h2>
<h2>Root Conformance Declaration</h2>
<p>
The OCFL version declaration MUST be formatted according to the [[!NAMASTE]] specification. It MUST be an
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

an -> a

empty file in the base directory of the <a>OCFL Storage Root</a> giving the OCFL version in the filename.
The filename MUST be constructed with a leading zero-equals (<code>0=</code>) string, the string
<code>ocfl_</code>, followed by the OCFL specification version number. For example <code>0=ocfl_1.0</code>
for version 1.0 of this specification.
file in the base directory of the <a>OCFL Storage Root</a> giving the OCFL version in the filename.
The filename MUST conform to the pattern <code>T=dvalue</code>, where <code>T</code> MUST be 0, and
<code>dvalue</code> MUST be <code>ocfl_</code>, followed by the OCFL specification version number. The
text contents of the file MUST be the same as <code>dvalue</code>, followed by a newline (<code>\n</code>).
</p>
<p>
Root conformance indicates that the OCFL Storage Root conforms to this section (i.e. the OCFL Storage Root
Expand Down