VRTP Distribution Directory Structure            1 June 1999
   
   http://www.web3D.org/WorkingGroups/vrtp/DirectoryStructure.txt

===========================================================================

Notes:

- Makefiles are kept as local as possible.  The top-level Makefile links
  to other Makefiles.  We will be examining the Bamboo way of doing this.

- PATH		/jdk1.2.1/bin;vrtp/bin;

- CLASSPATH	.;vrtp/;

- other ENVIRONMENT variables:  to be determined (tbd).  none so far.

- installation automation & ENVIRONMENT/registry changes:  tbd

- CVS or other configuration control system:  tbd

- 8.3 naming convention for directories is NOT preferred to proper names
  standard Java/VRML naming conventions:  TypicalClassName, someObject

- no whitespace in directories or filenames to avoid URL serving problems
  and to encourage successful URL-ization by mail readers

- Separate installs for
  Netscape, (Internet Explorer?), CosmoPlayer, Java JRE's, MBone tools

- Optional developer installs for
  Cygwin/GNU gcc/g++ tools, JDK 1.2.1, Java3D, JMF, Java documentation, ACE

===========================================================================

vrtp/					# top-level install directory

# everything else is beneath vrtp except top-level html pages
# and top-level Makefile.  Relative URLs whenever possible.

# Goals for consolidated package structure:  minimally complex CLASSPATH,
#   different distributions have javadoc subdirectories to avoid autofile clobbering.

vrtp/					# top-level & shared files, kept to a minimum
					# for clarity

vrtp/apache/				# top level.  or use "standard" install directories?
vrtp/bamboo/				# top level.  or use "standard" install directories?

# Goal for consolidated common executables:  minimally complex PATH
vrtp/bin/				# common executables (can be OS-specific symbolic links)

vrtp/com/				# commercial domain Java classes
vrtp/com/ibm/xml4j/			# XML parser
vrtp/com/sun/

vrtp/demo/				# prefer demos separate from packages to ensure that
vrtp/demo/auv
vrtp/demo/dabp
vrtp/demo/gimbals
vrtp/demo/helicopter
vrtp/demo/packageName			# they are independent of relative package location

vrtp/dabp				# dial-a-behavior protocol for dynamic packet payload
					#    definition and parsing; distribution-specific stuff
vrtp/dabp/images
vrtp/dabp/meetings
vrtp/dabp/protocols			# contains example protocols defined using XML
vrtp/dabp/apps				#
vrtp/dabp/
vrtp/dabp/

vrtp/dis-java-vrml/			# various top-level pages for that project.  unclutters
					# vrtp top-level directory, coexists with other projects.
vrtp/dis-java-vrml/images/
vrtp/dis-java-vrml/meetings/
vrtp/dis-java-vrml/build.date.dis-java-vrml.txt	# date of installed dis-java-vrml distribution

vrtp/images/				# vrtp-only directory.  distribution images stay local
					#   in respective package subdirectories

vrtp/javadoc/				# top level, no distribution's autogenerated javadoc goes here
vrtp/javadoc/dis-java-vrml/		# dis-java-vrml distribution's top-level javadoc
vrtp/javadoc/dial-a-behavior/		# dial-a-behavior distribution's top-level javadoc
vrtp/javadoc/rra/			#  RRA distribution's top-level javadoc
vrtp/javadoc/vrtp/			# vrtp distribution's top-level javadoc

vrtp/mil/navy/nps/			# NPS-produced Java packages
vrtp/mil/navy/nps/dis/			# DIS package
vrtp/mil/navy/nps/disEnumerations/	# disEnumerations package, etc.
vrtp/mil/navy/nps/rra/			# Recursive Ray Acoustics classes

vrtp/org/web3d/vrtp/			# vrtp Java classes, especially for streaming stack
vrtp/org/web3d/vrtp/bamboo/		# bamboo plugin interface
vrtp/org/web3d/vrtp/dabp/		# dial-a-behavior protocol (dabp)
vrtp/org/web3d/vrtp/datatypes/		# datatype extensions to Java (e.g. unsigned types)
vrtp/org/web3d/vrtp/rtp/		# Francisco Afonso's Java Media Framework (JMF) 2.0 rtpMonitor
vrtp/org/web3d/vrtp/util/		# software-oriented utilities (e.g. IDL types)
vrtp/org/web3d/vrtp/net/		# network utilities (currently unused)
vrtp/org/web3d/vrtp/snmp/		# simple network monitoring protocol (currently unused)

vrtp/rra/				# Recursive Ray Acoustics distribution
vrtp/rra/build.date.rra.txt		# date of installed dis-java-vrml build

vrtp/rtpMonitor/			# Francisco Afonso's Java Media Framework (JMF) 2.0 rtpMonitor


other directories of interest:		# to be determined...

vrtp/ntp/				# or "standard" ntp install directories?  to be determined...
vrtp/ntp/nistime			# NIST's ntp client for windows