[Nexus-developers] RE: CVS restructure Proposal

[Akeroyd, FA (Freddie)]

Joern,

That looks good - I guess NXdict would live under src/NXdict (or src/nxdict
as we seem
to be moving away from mixed case) ?

I think we may also need:

CVSROOT/nexus
  contrib   -  user contributed programs (if any) we decide to include
  examples  -  examples of using the API (in various languages)
  vms       -  like win32, a special build (and for HDF4 only)
  doc
      txt   -  plain text version of API documentation

"doc/templates" and "doc/definitions" - this may need 
a bit more thought as the class template/instrument definition documentation
could be 
embedded within the XML used to describe their structure, hence these will
be generated
from wherever the XML is stored. We may thus need to draw a distinction
between the documentation
of the API and the documentation of the class templates/instrument
definitions themselves - 
instrument editors would probably only want to work on the definition part
of the tree and
the NeXus API is useful as a stand-alone package. How about:

CVSROOT/nexus/definitions
  templates     -  XML templates for NeXus classes
      doc       -  documentation directory if docs not stored within xml 
  instruments   -  XML instrument definitions
      doc       -  documentation directory if docs not stored within xml 

If the documentation is part of the XML, the script used to make the various
install kits
will automatically extract it. As for where these "install kit builders"
should live,
I think Michael suggested CVSROOT/nexus/release

Re the web server: the web is both html and cgi scripts - maybe it would be
better to keep it
as a separate CVS entry and then automatically extract HTML from the web
when a release kit is built.

Regards,

Freddie

> -----Original Message-----
> From: Joern.Beckmann at frm2.tum.de [mailto:Joern.Beckmann at frm2.tum.de]
> Sent: 19 September 2003 16:12
> To: ROsborn at anl.gov; aivazis at cacr.caltech.edu; F.A.Akeroyd at rl.ac.uk
> Cc: Jens.Krueger at frm2.tum.de
> Subject: CVS restructure Proposal
> 
> 
> 
> After internal discussions Jens Krueger 
> (Jens.Krueger at frm2.tum.de) and I 
> propose the following structure:
> 
> CVSROOT/nexus
> 	include
> 	src
> 	bindings
> 		f77
> 		f90
> 		python
> 		java
> 		tcl
> 		...
> 		idl
> 	applications
> 	doc
> 		latex
> 		http
> 		man
> 		definitions
> 		templates
> 		howto
> 		ps
> 		pdf
> 	win32
> 	tests
> 	deb
> 
> The web pahge repository could be included in the doc/html 
> part if it is 
> seen as documentation of NeXus. If the webserver should be 
> kept separated 
> we propose:
> 
> CVSROOT/nexus-www
> 
> Please comment on this.
> 
> Joern Beckmann                      | Tel: (089) 289 14682
> Technische Universitaet Muenchen    | Fax: (089) 289 14666
> ZWE FRM-II                          |
> Lichtenbergstrasse 1, 85747 Garching| Email:Joern.Beckmann at frm2.tum.de
> 
>