DITA 2.0 RNG files

[Kristen James Eberlein <kris@eberleinconsulting.com>]

Dawn Stevens brought a point up during her stage three review of the "Indexing changes" proposal that I want to get on the radar for the TC.

The DITA 1.3 RNG files contain <a:documentation> elements that typically contain the element long name, the element short description and other text, for example:

<div>
ÂÂÂÂÂÂÂ <a:documentation>LONG NAME: Note</a:documentation>
ÂÂÂÂÂÂÂ ...
ÂÂÂÂÂÂÂÂÂ <element name="note" dita:longName="Note">
ÂÂÂÂÂÂÂÂÂÂÂ <a:documentation>A &lt;note> element contains information, differentiated from the main text, which expands on or calls attention to a particular point. Category: Body elements</a:documentation>
ÂÂÂÂÂÂÂÂÂÂÂ ...
</div>

While I would hope that the RNG for all new DITA 2.0 elements contain the <a:documentation> element that defines the long name, the other <a:documentation> element contains the content of the short description and the "category" by which the element is grouped in the specification. Obviously, that will change in many cases between DITA 1.3 and DITA 2.0, so do not be concerned if a stage three proposal contains only the same <a:documentation> elements that were present in the DITA 1.3 RNG.

Kudos to Dawn for her close reading of the stage three proposal!

--
Best,
Kris

Kristen James Eberlein
Chair, OASIS DITA Technical Committee
Principal consultant, Eberlein Consulting
www.eberleinconsulting.com
+1 919 622-1501; kriseberlein (skype)