RE: [jats-list] <code> and @language documentation (1.1d1)

Subject: RE: [jats-list] <code> and @language documentation (1.1d1)
From: "Lizzi, Vincent" <Vincent.Lizzi@xxxxxxxxxxxxxxxxxxxx>
Date: Fri, 28 Feb 2014 21:11:35 +0000
Hi Debbie,

>> I think this is a very good suggestion. We are in the middle of cleaning up
a lot of the examples.

If I may make a suggestion for the documentation: remove abbreviations in
*-type attributes in favor of using the actual word to improve clarity.
Certain abbreviations are well recognized and save a lot of typing, such as
"toc" for Table of Contents and "doi" for Digital Object Identifier. Some
other abbreviations are not as easy to understand.

For example, in the description of <institution> this example is given:

<named-content content-type="dept">

Where "dept" probably means "department". <named-content
content-type="department"> is more clear and not many more characters.

Another example is "rev-recd" in the list of suggested values for the
date-type attribute. "revision-received" or (more simply) "revised" is more
clear.

Most element and attribute names in JATS are spelled out, so avoiding
abbreviations seems to be in theme for JATS. I realize that the *-type
attribute values in the documentation are suggestions only, and people are
free to define attribute values they find make sense, but many people go by
the suggestions.

Thanks,
Vincent


-----------------------------------------------------------------------------
---------------------------------------------------------------



The information contained in this email message may be confidential. If you
are not the intended recipient, any use, interference with, disclosure or
copying of this material is unauthorised and prohibited. Although this message
and any attachments are believed to be free of viruses, no responsibility is
accepted by Informa for any loss or damage arising in any way from receipt or
use thereof. Messages to and from the company are monitored for operational
reasons and in accordance with lawful business practices.
If you have received this message in error, please notify us by return and
delete the message and any attachments. Further enquiries/returns can be sent
to postmaster@xxxxxxxxxxx

Current Thread