[NeXus-definitions-tickets] [NeXusDefinitions] #181: generate condensed view of fields and groups in each NXDL

[NeXus Base Classes and Instrument Definitions]

#181: generate condensed view of fields and groups in each NXDL
-------------------------+--------------------------------------------------
 Reporter:  Pete Jemian  |       Owner:  Pete Jemian     
     Type:  enhancement  |      Status:  new             
 Priority:  major        |   Milestone:  release NXDL 1.0
Component:  NXDL syntax  |    Keywords:                  
-------------------------+--------------------------------------------------
Description changed by Pete Jemian:

Old description:

> The additional specifications NXDL files make it hard to see the data
> fields and group structure.  Make an XSLT stylesheet for base classes,
> and application & contributed definitions to render an indented list,
> similar to the output format for data files.
>
> Add this to the NXDL Chapter in NeXusRefDoc (volume II).
>
> Here's an example:
> {{{
> NXarchive:NXentry (application definition, version 1.0b)
>   collection_description:NX_CHAR
>   collection_identifier:NX_CHAR
>   collection_time:NX_FLOAT
>   definition:NX_CHAR
>   duration:NX_FLOAT
>   end_time:NX_DATE_TIME
>   entry_identifier:NX_CHAR
>   experiment_description:NX_CHAR
>   experiment_identifer:NX_CHAR
>   program:NX_CHAR
>   release_date:NX_CHAR
>   revision:NX_CHAR
>   run_cycle:NX_CHAR
>   start_time:NX_DATE_TIME
>   title:NX_CHAR
>   instrument:NXinstrument
>     description:NX_CHAR
>     name:NX_CHAR
>     NXsource
>       name:NX_CHAR
>       probe:NX_CHAR
>       type:NX_CHAR
>   sample:NXsample
>     chemical_formula:NX_CHAR
>     description:NX_CHAR
>     electric_field:NX_FLOAT
>     magnetic_field:NX_FLOAT
>     name:NX_CHAR
>     preparation_date:NX_CHAR
>     pressure:NX_FLOAT
>     sample_id:NX_CHAR
>     situation:NX_CHAR
>     stress_field:NX_FLOAT
>     temperature:NX_FLOAT
>     type:NX_CHAR
>   user:NXuser
>     facility_user_id:NX_CHAR
>     name:NX_CHAR
>     role:NX_CHAR
> }}}

New description:

 The many specifications in NXDL files make it hard to see the data fields
 and group structure.  Make an XSLT stylesheet for base classes, and
 application & contributed definitions to render an indented list, similar
 to the output format for data files.

 Add this to the NXDL Chapter in NeXusRefDoc (volume II).

 Here's an example:
 {{{
 NXarchive:NXentry (application definition, version 1.0b)
   collection_description:NX_CHAR
   collection_identifier:NX_CHAR
   collection_time:NX_FLOAT
   definition:NX_CHAR
   duration:NX_FLOAT
   end_time:NX_DATE_TIME
   entry_identifier:NX_CHAR
   experiment_description:NX_CHAR
   experiment_identifer:NX_CHAR
   program:NX_CHAR
   release_date:NX_CHAR
   revision:NX_CHAR
   run_cycle:NX_CHAR
   start_time:NX_DATE_TIME
   title:NX_CHAR
   instrument:NXinstrument
     description:NX_CHAR
     name:NX_CHAR
     NXsource
       name:NX_CHAR
       probe:NX_CHAR
       type:NX_CHAR
   sample:NXsample
     chemical_formula:NX_CHAR
     description:NX_CHAR
     electric_field:NX_FLOAT
     magnetic_field:NX_FLOAT
     name:NX_CHAR
     preparation_date:NX_CHAR
     pressure:NX_FLOAT
     sample_id:NX_CHAR
     situation:NX_CHAR
     stress_field:NX_FLOAT
     temperature:NX_FLOAT
     type:NX_CHAR
   user:NXuser
     facility_user_id:NX_CHAR
     name:NX_CHAR
     role:NX_CHAR
 }}}

--

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