[NeXus-definitions-tickets] [NeXusDefinitions] #174: review and revise NeXus manual sections: II - 3. NeXus classes

[NeXus Base Classes and Instrument Definitions]

#174: review and revise NeXus manual sections: II - 3. NeXus classes
-------------------------+--------------------------------------------------
 Reporter:  Pete Jemian  |       Owner:  Mark Koennecke  
     Type:  task         |      Status:  new             
 Priority:  major        |   Milestone:  release NXDL 1.0
Component:  general      |    Keywords:                  
-------------------------+--------------------------------------------------

Old description:

> related to TRAC ticket #142
>
> Check that the introduction to the chapter describes what will be shown
> and provides information useful to interpreting what will be shown.
>
> This looks like a big job but it can be simplified since most of this
> chapter is autogenerated from the NXDL class files.  The intent of this
> ticket is to review and revise the '''format''' in which that content is
> shown in the manual.  Check that all essential information from the NXDL
> ({{{*.nxdl.xml}}}) files is represented.
>
> In many cases, an NXDL file will specify the fields of a base class group
> to be used.  That content, shown in a separate table might be confusing.
>
> To make each class start on a fresh page of the manual will require
> manipulation of the DocBook style files.  While desirable, this might not
> get done (and should not be a requirement to closing this ticket).  It
> has its own ticket anyway: #142.

New description:

 related to TRAC ticket #142

 Check that the introduction to the chapter describes what will be shown
 and provides information useful to interpreting what will be shown.

 This looks like a big job but it can be simplified since most of this
 chapter is autogenerated from the NXDL class files.  The intent of this
 ticket is to review and revise the '''format''' in which that content is
 shown in the manual.  Check that all essential information from the NXDL
 ({{{*.nxdl.xml}}}) files is represented.

 In many cases, an NXDL file will specify the fields of a base class group
 to be used.  That content, shown in a separate table might be confusing.

 To make each class start on a fresh page of the manual will require
 manipulation of the DocBook style files.  While desirable, this might not
 get done (and should not be a requirement to closing this ticket).  It has
 its own ticket anyway: #142.

--

Comment(by Pete Jemian):

 review the class definitions for consistent and appropriate terminology
 (such as '''analyze''' vs. '''analyse''' or an attribute that is not only
 integer, but always a positive integer))

-- 
Ticket URL: <http://trac.nexusformat.org/definitions/ticket/174#comment:1>
NeXus Base Classes and Instrument Definitions <http://www.nexusformat.org/>
NeXus Base Classes and Instrument Definitions