[NeXus-definitions-tickets] [NeXusDefinitions] #120: complete the NeXus manual for NXDL 1.0

[NeXus Base Classes and Instrument Definitions]

#120: complete the NeXus manual for NXDL 1.0
-------------------------+--------------------------------------------------
 Reporter:  Pete Jemian  |       Owner:  Pete Jemian     
     Type:  task         |      Status:  assigned        
 Priority:  major        |   Milestone:  release NXDL 1.0
Component:  general      |    Keywords:                  
-------------------------+--------------------------------------------------

Old description:

> ||item||status||assigned to||description of task||
> ||1||done||Peterson||revise graphics in manual to match name:type usage||
> ||2||done||Jemian||NXDL.xml:            TODO: Edit content from Trac
> ticket #65||
> ||3||done||Jemian||NXDL.xml:   #134     <!-- TODO: make a better
> description of the NXDL and how to use it -->||
> ||4||done||Jemian||NXDL.xml:        <!-- TODO: describe and make tables
> of the stuff in nxdlTypes.xsd -->||
> ||5||||Peterson||validation.xml:            <!-- TODO: Will we describe
> how validation code can check to see if it is ||
> ||6||||Freddie||validation.xml:            <!-- TODO: describe what is
> and is not being validated -->||
> ||7||||Jemian||validation.xml:                to validate any NXDL file.
> Here's an example using <code>xmllint</code>: <!-- TODO: check this
> command -->||
> ||8||||Peterson||validation.xml:                UNIX/Linux command line
> tools <!-- TODO: check this command -->||
> ||9||not now||Jemian||validation.xml:                <!-- TODO: Care to
> give an example of validating an XSLT using xmllint or saxon? -->||
> ||10||done||Jemian||design.xml:            <!-- TODO Is the previous line
> OK? -->||
> ||11||done||Jemian||design.xml:                TODO Need a better writeup
> (about dimensions) than this!||
> ||12||done||BenWatts||design.xml:                            TODO Comment
> about strings||
> ||13||done||BenWatts||design.xml:                            TODO Comment
> about binary data||
> ||14||done||BenWatts||design.xml:                            TODO Comment
> about images||
> ||15||||Jemian||impatient.xml:  TODO This could be rewritten from the
> ground up.||
> ||16||||Jemian||impatient.xml:      <!-- TODO and what about types? -->||
> ||17||||BenWatts||introduction.xml:                <!-- TODO write about
> the Scientific Community or leave it out--> and promote on main WWW
> page||
> ||18||||Jemian||introduction.xml:                <!-- TODO also refer to
> later section-->||
> ||19||||Jemian||introduction.xml:                <!-- TODO: build NAPI-
> based read example from Ray's LRMECS data.||
> ||19a||done||Jemian||introduction.xml:                <!-- TODO: build
> h5py-based write and read example from APS USAXS data.||
> ||20||done||Jemian||preface.xml:        <!-- TODO -er-, will be (need
> more examples) --> ||
> ||21||done||Mark||TRAC ticket #115: rewrite manual section for NeXus
> Coordinate System||
> ||22||||Freddie||TRAC ticket #87: provide documentation how NXDL is
> converted into Schematron||
> ||23||done||Jemian||TRAC ticket #101: documentation: introduction.xml||
> ||24||done||Stuart||TRAC ticket #106: documentation: utilities.xml||
> ||25||||Stuart||TRAC ticket #122: 2010NIAC: revise Utilities section of
> manual||
> ||26||||Jemian||TRAC ticket #120: complete the NeXus manual for NXDL 1.0
> (Hey!  That's ''this'' ticket.)||
> ||27||done||Jemian||TRAC ticket #121: generate wiki pages from manual||
> ||28||done||Jemian||NXdata.nxdl.xml:  <!-- TODO: confirm this addition
> from NIAC2010 -->||
> ||29||done||Peterson||NXdata.nxdl.xml:  <dim index="1" value="i"/><!-\-
> How can this be right?  TODO -\->||
> ||30||done||Jemian||design.xml:  resolve the note in the "rastering"
> section, keep note, make a warning to pad data or use unlimited
> dimensions to avoid data loss||
> ||31||||Freddie||NIAC.xml: update per NIAC2010 changes to constitution||
> ||32||done||Jemian||orphans.xml: reposition this content that was pulled
> from the introduction||
> ||33||||Peterson||update the NeXus history for recent years||
> ||34||||Tech-Committee||review the manual content||

New description:

 ||item||status||assigned to||description of task||
 ||1||done||Peterson||revise graphics in manual to match name:type usage||
 ||2||done||Jemian||NXDL.xml:            TODO: Edit content from Trac
 ticket #65||
 ||3||done||Jemian||NXDL.xml:   #134     <!-- TODO: make a better
 description of the NXDL and how to use it -->||
 ||4||done||Jemian||NXDL.xml:        <!-- TODO: describe and make tables of
 the stuff in nxdlTypes.xsd -->||
 ||5||||Peterson||validation.xml:            <!-- TODO: Will we describe
 how validation code can check to see if it is ||
 ||6||||Freddie||validation.xml:            <!-- TODO: describe what is and
 is not being validated -->||
 ||7||||Jemian||validation.xml:                to validate any NXDL file.
 Here's an example using <code>xmllint</code>: <!-- TODO: check this
 command -->||
 ||8||||Peterson||validation.xml:                UNIX/Linux command line
 tools <!-- TODO: check this command -->||
 ||9||not now||Jemian||validation.xml:                <!-- TODO: Care to
 give an example of validating an XSLT using xmllint or saxon? -->||
 ||10||done||Jemian||design.xml:            <!-- TODO Is the previous line
 OK? -->||
 ||11||done||Jemian||design.xml:                TODO Need a better writeup
 (about dimensions) than this!||
 ||12||done||BenWatts||design.xml:                            TODO Comment
 about strings||
 ||13||done||BenWatts||design.xml:                            TODO Comment
 about binary data||
 ||14||done||BenWatts||design.xml:                            TODO Comment
 about images||
 ||15||||Jemian||impatient.xml:  TODO This could be rewritten from the
 ground up.||
 ||16||||Jemian||impatient.xml:      <!-- TODO and what about types? -->||
 ||17||||BenWatts||introduction.xml:                <!-- TODO write about
 the Scientific Community or leave it out--> and promote on main WWW page||
 ||18||done||Jemian||introduction.xml:                <!-- TODO also refer
 to later section-->||
 ||19||done||Jemian||introduction.xml:                <!-- TODO: build
 NAPI-based read example from Ray's LRMECS data.||
 ||19a||done||Jemian||introduction.xml:                <!-- TODO: build
 h5py-based write and read example from APS USAXS data.||
 ||20||done||Jemian||preface.xml:        <!-- TODO -er-, will be (need more
 examples) --> ||
 ||21||done||Mark||TRAC ticket #115: rewrite manual section for NeXus
 Coordinate System||
 ||22||||Freddie||TRAC ticket #87: provide documentation how NXDL is
 converted into Schematron||
 ||23||done||Jemian||TRAC ticket #101: documentation: introduction.xml||
 ||24||done||Stuart||TRAC ticket #106: documentation: utilities.xml||
 ||25||||Stuart||TRAC ticket #122: 2010NIAC: revise Utilities section of
 manual||
 ||26||||Jemian||TRAC ticket #120: complete the NeXus manual for NXDL 1.0
 (Hey!  That's ''this'' ticket.)||
 ||27||done||Jemian||TRAC ticket #121: generate wiki pages from manual||
 ||28||done||Jemian||NXdata.nxdl.xml:  <!-- TODO: confirm this addition
 from NIAC2010 -->||
 ||29||done||Peterson||NXdata.nxdl.xml:  <dim index="1" value="i"/><!-\-
 How can this be right?  TODO -\->||
 ||30||done||Jemian||design.xml:  resolve the note in the "rastering"
 section, keep note, make a warning to pad data or use unlimited dimensions
 to avoid data loss||
 ||31||||Freddie||NIAC.xml: update per NIAC2010 changes to constitution||
 ||32||done||Jemian||orphans.xml: reposition this content that was pulled
 from the introduction||
 ||33||||Peterson||update the NeXus history for recent years||
 ||34||||Tech-Committee||review the manual content||

--

Comment(by Pete Jemian):

 completed items 18 and 19 with [819]

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