Element and Attribute Naming Rules

• CASE — All XML names originating in this Tag Set or in the Suite are to be in lower case. Such names include element names, attribute names, parameter entity names, notation names, and IDs. The casing and interior punctuation of element-type names, attribute names, and parameter entity names inherited from PUBLIC models (such as the XHTML Tables Module, the MathML Tag Set, or the OASIS CALS Exchange Table Model) are unchanged. That means that they occur in the case in which they were found in the original module, and so may be in mixed case or upper case (e.g., %Flow.mix;).
• TWO-WORD NAMES — When two or more words are concatenated into an element name, attribute name, or parameter entity name, a hyphen is placed between the words, for example, <verse-group> and <article-title>.
• WORD STANDARDIZATION — Abbreviations may be used when words are used in combination. When a word stands alone as a name, it is not abbreviated. Thus, the element <conference> uses the full word “conference”, but the conference combinations (such as <conf-theme> and <conf-num>) use the abbreviation “conf”. Abbreviations are standardized so that, for example, “figure” is always used as “fig” and group is not abbreviated (as in the elements <title-group>, <kwd-group>, and <fn-group>).
• The typographic emphasis elements are spelled out in full, for example, <bold> (rather than “ <b> ”), <italic>, and <underline> instead of being differentiated using attribute values on an element such as <emphasis>. Superscript and subscript are not considered to be purely typographic, and each is a separate element: <sub> and <sup>.

The following table contains a growing list of abbreviations/names to be used in combined tag names (element type names), attribute names, and parameter entity names. (Words in the list below that are not abbreviated are displayed in italics.)

ORIGINAL WORD	ABBREVIATION
acknowledgment	ack
abstract	abs
address	addr
affiliation	aff
alternate/alternative-something	alt
alternatives	alternatives
article	article
attribution	attrib
author	author
biography	bio
chemical	chem
communication	communication
conference	conf
contributor/contribution	contrib
corresponding	corresp
count	count
cross	x (no hyphen)
definition	def
description	desc
display	disp
editor	editor
end	end
equal	equal
external	ext
figure	fig
first	f (no hyphen; <fpage>)
footnote	fn
formula	formula
government	gov
graphic	graphic
group/grouping	group
heading/header	head
identifier/ID	id
inline	inline
institution	institution
item	item
journal	journal
keyword	kwd
last	l (no hyphen; <lpage>)
link	link
list	list
location	loc
material	material
metadata	meta
number	num
page	page
paragraph	p
prefix	prefix
proceedings	proceedings
publication	pub
publisher	publisher
quote	quote
reference	ref
related	related
section	sec
sequence/sequential	seq
series	series
size	size
standard	std
start	start
statement	statement
structure	struct
subject	subj
subscript	sub (note: not inferior)
suffix	suffix
superscript	sup (note: not superior)
supplement	supplement
supplementary	supplementary
table	table
title	title
translated/translator	trans
type	type
underline	underline
version	version
volume	vol
word	word
wrapper	wrap

File Naming Conventions

This Tag Library describes the components for the Article Authoring Tag Set. This Tag Set is described in a DTD, an XSD schema, and a RELAX NG schema. For the DTD, the base DTD module (delivered as the file articleauthoring.dtd) calls in all the other DTD fragment modules as external parameter entities. Each module specific to this Tag Set (therefore, not part of the Suite) takes the prefix “ articleauthcustom- ”. The same prefix has been followed in the other two constraint languages/schemas.

Each DTD and DTD fragment module has been assigned a unique formal public identifier (fpi). File names are never referenced directly in the comments in the DTD; the file is referred to by the name of the external parameter entity, which names the fpi and a system name for the file. The external parameter entity has been set to the initial delivery filename.

The Authoring DTD, the individual DTD-fragment modules of the DTD and the Suite, the XSD schema modules, and the RELAX NG schema modules have been given DOS/Windows 3-digit suffixes indicating their type:

In version NISO 0.4 and NLM 3.1, and in all subsequent NLM and NISO versions, the module filenames will reflect the major version number. For example, a module whose name in early versions of the NLM Tag Set was list.ent is now named JATS-list0.ent (to indicate that it is part of the JATS 0.4 release of the draft NISO Trial Use Standard). If the NISO Trial Use standard succeeds in becoming a NISO standard, this module will be renamed list1.ent. (Note: The parameter entity that references the file is still called &list.ent;, but it now references a file with the JATS- prefix and the version number embedded, namely JATS-list0.ent.)

The current plan is that future dot releases (1.0, 1.1, 1.2, etc.) will not be reflected in the filename (not list1-1.ent, list1-2.ent, etc.) but will remain named with a single digit (“1”) as list1.ent), which will not change until the next major release. The next major release 2.0 will be list2.ent.

While the Tag Set cannot dictate graphic file names, the comments do suggest that best practice for naming graphic files in documents tagged according to this Suite would be to limit the names and path names to these characters: letters (both upper and lower case), numbers, underscore, hyphen, and period. All such names will be assumed to be case sensitive. DOS-style file extensions may be used.