search

JATS4R / JATS4R-Participant-Hub

The hub for all JATS4R meeting notes, examples, draft recommendations, documents, and issues.
http://jats4r.org
17 stars 20 forks source link

Should we require @dtd-version? #113

Closed Klortho closed 8 years ago

Klortho commented 8 years ago

See http://jatspan.org/niso/publishing-1.1d3/#p=attr-dtd-version.

This attribute is defined as "FIXED", which means:

It's a nice attribute, because it enables consumers (bots) to determine the version of the schema that the document conforms to, without having to read the doctype declaration or any processing instructions. OTOH, making this attribute required by JATS4R would put an extra burden on the content providers. Then again, it's best practice, and I'd guess that most of them are doing it anyway.

jats-laura commented 8 years ago

I'd guess that most of them are doing it anyway

I don't think they are, actually. PMC gets very little data with the attribute explicitly stated.

hubgit commented 8 years ago

Presumably the intention is that the value is read from the DTD rather than the XML file, so there's no reason to add it to the XML.

However, if we're encouraging re-use in environments that don't use the DTD, it might make sense to require it. It would have to be accurate, though…

FWIW, PeerJ's articles do have this attribute set.

Klortho commented 8 years ago

I think it's a good best practice. What if we made it a warning if the attribute is not present?

Klortho commented 8 years ago

It came up in the call just now, that we can use @dtd-version in the Schematron, to determine which license rules to apply (see #50). That would simplify things quite a bit for us. And using the test that "what's good for us is good for reuse", suggests that we should require it.

ahamelers commented 8 years ago

There seemed to be widespread support to require it on the call. Can anyone think of any compelling reason not to require it?

On Thu, Oct 15, 2015 at 3:03 PM, Chris Maloney notifications@github.com wrote:

It came up in the call just now, that we can use @dtd-version in the Schematron, to determine which license rules to apply (see #50 https://github.com/JATS4R/JATS4R-Participant-Hub/issues/50). That would simplify things quite a bit for us. And using the test that "what's good for us is good for reuse", suggests that we should require it.

— Reply to this email directly or view it on GitHub https://github.com/JATS4R/JATS4R-Participant-Hub/issues/113#issuecomment-148395893 .

Klortho commented 8 years ago

This is a warning if it is not there.