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.

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

Improve sentences #556

Closed
PhillipTommerholt opened this issue Jul 10, 2019 · 2 comments
Closed

Improve sentences #556

PhillipTommerholt opened this issue Jul 10, 2019 · 2 comments
Assignees
Labels
enhancement Issues that are an enhancement needed to be evaluated and action decided

Comments

@PhillipTommerholt
Copy link
Contributor

PhillipTommerholt commented Jul 10, 2019

There are two sentences in 6.1.1 What is a Content Information Type Specification which might be improved:

"For example, the ERMS Content Information Type Specification does specific a method for referencing data (i.e. computer files) from descriptive metadata in ERMS format, to ensure the integrity of data and metadata."

"does a method" sounds odd - is this correct English?

"Stating these requirements in a general specification allows archival institutions receiving SIPs including ERMS extracts or whole systems to understand and validate potentially complex information packages."

" allows receiving" -> allows to receive?

@carlwilson
Copy link
Collaborator

I'll take these in reverse order (I'd have asked if that was OK but then I'd have to wait for a reply ;) ):

I think that the second issue is OK, to me this reads that the "allows" refers to "understand and validate...." later in the sentence, i.e. (to re-order & paraphrase) "the general specification allows institutions to understand complex SIPs they receive". It might be better written in that more direct form (with use of original terms)?

Regarding the first issue, I agree and am suggesting this patch which I'll PR and pull you in for review:

@@ -12,11 +12,11 @@ Content Information Types can be regarded as categories of Content Information,
 The following elements should be at the core of a Content Information Type Specification:

 - Required file formats for content data;
-- Specification of information package structure, i.e. specific sub-folders under the "Data" folder for particular categories of content data;
+- Specification of information package structure, i.e. specific sub-folders under the "data" folder for particular categories of content data;
 - Requirements for specific representation metadata that should be available in PREMIS for understanding and rendering the Content Data Object;
 - Details of specific (binary) documentation or other components (e.g. software, emulators, etc.) which must be available for rendering and understanding the Content Data Object.

-Pragmatically it may not be sufficient to deal only with the Information Object. For complex Content Information Types or large IPs it may be necessary to provide explicit requirements for other metadata (descriptive, administrative) relevant to the specific content type. For example, the ERMS Content Information Type Specification does specific a method for referencing data (i.e. computer files) from descriptive metadata in ERMS format, to ensure the integrity of data and metadata. Stating these requirements in a general specification allows archival institutions receiving SIPs including ERMS extracts or whole systems to understand and validate potentially complex information packages.
+Pragmatically it may not be sufficient to deal only with the Information Object. For complex Content Information Types or large IPs it may be necessary to provide explicit requirements for other metadata relevant to the specific content type. For example, the ERMS Content Information Type Specification prescribes a method for referencing data (i.e. computer files) from descriptive metadata in ERMS format, ensuring package integrity. Stating these requirements in a general specification allows archival institutions receiving SIPs including ERMS extracts or whole systems to understand and validate potentially complex information packages.

@carlwilson carlwilson self-assigned this Jul 21, 2019
@carlwilson carlwilson added this to the CSIP v2.0.4 milestone Apr 30, 2020
@carlwilson carlwilson added the enhancement Issues that are an enhancement needed to be evaluated and action decided label Apr 30, 2020
@carlwilson
Copy link
Collaborator

Done and ready to close

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Issues that are an enhancement needed to be evaluated and action decided
Projects
None yet
Development

No branches or pull requests

2 participants