search

OCFL / spec

The Oxford Common File Layout (OCFL) specifications
https://ocfl.io
54 stars 14 forks source link

Implementation notes: a few typos #169

Closed tomwrobel closed 6 years ago

tomwrobel commented 6 years ago

Apologies, I'm reading the spec and noticed a few typos/bits I didn't understand. Feel free to discard.

Para 2: "Nor can these attributes be vaidated" = 'validated'

[note, not my place, but would the following not be better: "In addition, fixity checks cannot consistently validate these attributes."]

Para 3: OCFL preserves files and their content with directories serving as a useful organisational convention.

content = contents?

I don't want to sound like an idiot, but I'm really not sure what this means. Is it that OCFL is not directly concerned with file directories? It is concerned with the preservation of files and their contents, and as such directories provide a useful organisational paradigm, but empty directories on their own are merely filesystem metadata and, as such, are not preserved.

Para 10: The correct way to do this is to create a new object the excludes the offending file with a revised version history taking this into account.

"a new object that excludes the offending file"

Also para 10:

"the same identifer as the orignal object" = the same identifier as the original object [note identifier AND original]

awoods commented 6 years ago

@tomwrobel : Your editorial pull-requests would be warmly welcomed.

As for Para 3, I believe your interpretation is what was intended:

[OCFL] is concerned with the preservation of files and their contents, and as such directories provide a useful organisational paradigm, but empty directories on their own are merely filesystem metadata and, as such, are not preserved.

rosy1280 commented 6 years ago

@tomwrobel I believe all of your suggestions are fixed with PR #172 . Take a look and let me know.

tomwrobel commented 6 years ago

Line 275

"identifier" and "original"

Otherwise all taken care of!

Best wishes, and blue skies

Tom

Tom Wrobel Software Engineer - BDLSS thomas.wrobel@bodleian.ox.ac.uk / 01865 277608

From: Rosalyn Metz notifications@github.com Sent: 01 October 2018 16:00:25 To: OCFL/spec Cc: tomwrobel; Mention Subject: Re: [OCFL/spec] Implementation notes: a few typos (#169)

@tomwrobelhttps://github.com/tomwrobel I believe all of your suggestions are fixed with PR #172https://github.com/OCFL/spec/pull/172 . Take a look and let me know.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHubhttps://github.com/OCFL/spec/issues/169#issuecomment-425939960, or mute the threadhttps://github.com/notifications/unsubscribe-auth/AA-IR-tmpdERFfR4E9A1OmjJcjhH-6Rfks5ugi4JgaJpZM4W-ksP.

rosy1280 commented 6 years ago

fixed! and sorry, thought i got that. closing...