Full category name.

In response to Pete:

For each NXDL, the Category should be one of these (spelled out completely):

base class
application definition
contributed definition
Don't render XML comments.

In response to Pete:

When rendering NXDL specifications, XML comments should not be rendered.

Such as, in NXmirror, do not render this comment (even though it is a worthy thing to be repaired in the NXDL file):

change:
(geometry): NXgeometry
<!– TODO explain what this group means –>

to:
(geometry): NXgeometry

--

Note however that there are also <doc> entries like
"TODO: documentation needed". Those are still rendered.
Render symbol names in Symbols listing in boldface.

In reponse to Pete:

When a NXDL declares a symbol table, the symbols should be rendered with some distinction from the descriptive text. Suggest using monospace font.

Prefer however boldface over monospace for typographic parsimony.
Old version also had boldface.
Removed trailing periods.

In response to Pete:

When the NXDL are rendered, the metadata often end with a period. These are not complete sentences and the period is not appropriate. In some cases, it makes the information correct. Such as:

Groups cited: NXdata, NXentry, NXinstrument, NXparameters, NXprocess, NXsample, NXsource.
History: Introduced in NeXus version 1.0b.
Source: Automatically generated from https://github.com/nexusformat/definitions/blob/master/applications/NXsqom.nxdl.xml.
2.4.15 NXtas
Category: application.
Description:
This is an application definition for a triple axis spectrometer. It is for the trademark scan of the TAS, the
Q-E scan. For your alignment scans use the rules in NXscan.
Extends: NXobject.

Of these, the trailing period should be removed from Groups cited, Source, Category, Extends
Revert "History" to "Version"; compact "Status" field as first metadata.

E.g.:

Status:

    base class, extends NXobject, version 1.0

In reponse to Pete (but avoiding a table, mainly for typographic parsimony):

For each NXDL, the version (/definition/@version attribute) is described incorrectly as History.

change:
History: Introduced in NeXus version 1.0b.

to:
Version: 1.0b

and place this as one of the first metadata about the NXDL.

It is clearer, more systematic, and more compact to render these first metadata items in a table:

====================== ======== =======
Category Extends Version
====================== ======== =======
application definition NXobject 1.0b
====================== ======== =======
No longer distinguish between NX_CHAR and (NX_CHAR).

In response to Pete:

Since NX_CHAR is the default type when not specified for a NXDL field, it is not necessary to use the word "untyped" when rendering fields of this type. The parentheses around the data type indicate that a default choice has been provided.

For example, in NXarchive, change:

definition: untyped (NX_CHAR)

to

definition: (NX_CHAR)

--

Since there is a clear rule that NX_CHAR is the default type,
there is no good reason to render the difference between
type=default and type=NC_CHAR at all.
Its only information content is about the laziness of person
who edited the NXDL page.
Enumeration in-line only if the resulting line is short.

As per this arbitrary criterion: not len( oneliner )>60.
Can be further modified according to taste.

In response to Pete:

When rendering NXDL enumeration elements such as this from NXarchive:

        <enumeration>
          <item value="Spallation Neutron Source"/>
          <item value="Pulsed Reactor Neutron Source"/>
          <item value="Reactor Neutron Source"/>
          <item value="Synchrotron X-Ray Source"/>
          <item value="Pulsed Muon Source"/>
          <item value="Rotating Anode X-Ray"/>
          <item value="Fixed Tube X-Ray"/>
        </enumeration>

is it clearer to represent the item elements in a list rather than a continuous string delimited by vertical bars.

Change the rendering from:

Any of these values: Spallation Neutron Source | Pulsed Reactor Neu-
tron Source | Reactor Neutron Source | Synchrotron X-Ray Source |
Pulsed Muon Source | Rotating Anode X-Ray | Fixed Tube X-Ray.

to:

Any of these values:

    Spallation Neutron Source
    Pulsed Reactor Neutron Source
    Reactor Neutron Source
    Synchrotron X-Ray Source
    Pulsed Muon Source
    Rotating Anode X-Ray
    Fixed Tube X-Ray