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

Harmonise language for which header fields are permitted in which records #73

Open
JustAnotherArchivist opened this issue Jul 4, 2021 · 0 comments

Comments

@JustAnotherArchivist
Copy link

Currently, a few different phrases are used:

  • All records shall have a WARC-Record-ID field.
  • The WARC-IP-Address field may be used on ‘response’, ‘resource’, ‘request’, ‘metadata’, and ‘revisit’ records, but shall not be used on ‘warcinfo’, ‘conversion’ or ‘continuation’ records.
  • The WARC-Profile field is mandatory on ‘revisit’ type records and undefined for other record types.
  • (From WARC-Segment-Number:) In the first segment of any record that is completed in one or more later ‘continuation’ WARC records, this parameter is mandatory. [...]

One additional minor quirk: sometimes, fields may be used on and sometimes in records.

The WARC-Profile one are arguably the most problematic one: 'undefined' can mean either 'shall not be used' (which is surely the intent?) or 'its meaning if present is undefined'.

I think it would be beneficial to use the same language everywhere.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants