XBN Java: Directory Structure

<< BACK

XBN Java: Directory Structure

Source directory structure

xbnjava
	etcetera
		announcements
		coding_standards
		dependencies
		javadoc
			xbn_doclet
		package_dependencies
		xdocs
	xbn
	xbn_examples
	xbn_junit

Destination (and other) directory structure

CLASSES
working
backup
xbnjava
	CODE
		[Complete copy of the source directory structure]
	coding_standards
	javadoc
	supplemental_docs
	log

Source directory structure

Directory Description
xbnjava The root directory. Files:

build.properties: The top of this file is the only thing you need to configure before building XBN Java on your machine.

build.xml: The heart of the build process. Go to this directory and type 'ant'.

gnu_general_public_license.txt: The full text of the license under which XBN Java is released.

xbnjava/etcetera If it's not the Java code for the main XBN packages, JUnit or example code, then it's in this directory. Files:

directory_structure.html: This file.

idx_redir_root_to_jvdc.html: A redirect page to put in the root of the build directory, which sends you to the main JavaDoc page.

xbnjava/etcetera/coding_standards Documentation on XBN coding standards, based upon Sun's coding standards. Sun's files are zipped up.
xbnjava/etcetera/dependencies Non-JVM, non-Ant archives and classes XBN Java is dependent on. Java and class files for custom Ant tasks are located here.
xbnjava/etcetera/javadoc Files needed by the JavaDoc process. Files:

css.txt: The Cascading Style Sheet used by JavaDoc.

doclet_class_map.txt: Configuration required by JavaDoc Link Codes.

java_sun_pkg_list.txt: If I could ever figure out the freaking linkoffline JavaDoc Ant task attribute, I could use this...

overview.html: The body of the overview-summary.html Javadoc page.

zBROKEN_LINKS.txt: A list of all known broken links existing throughout XBN documentation.

xbnjava/etcetera/javadoc/xbn_doclet XBN Doclet, integrating JavaDoc Link Codes into the standard doclet. The files in which (significant) changes are made are unexploded. The rest are zipped.
xbnjava/etcetera/package_dependencies Code and template to generate the listing of all packages that each xbn package is dependent on, and which packages depend on it. This contains the Java code to do the generating, as well as the template files.
xbnjava/xbn The xbn.* packages.
xbnjava/xbn_examples The xbn_example.* packages, containing all XBN Java example code.
xbnjava/xbn_junit The xbn_junit.* packages, containing all XBN Java JUnits.

Destination (and other) directory structure

Directory Description
CLASSES The directory outside of the build directory in which classes are compiled.
working The directory outside of the build directory in which things are stored for use over multiple builds.
backup The directory outside of the build directory in which the archived source code is backed up. Each archive is given a date-time stamp.
xbnjava The root directory for the build.
xbnjava/CODE The source directory is completely duplicated here, except the root directory is this ('CODE') instead of 'xbnjava'. This is the directory to which source code links should point.
Note: This Java code is different than the Java code existing in the source directory. In the source directory, the license text, version number (among other things) are only marked by replacement delimiters. When built, these delimiters are replaced with the actual license and version number. The Java code for building XBN Java exists in the download named xbnjava_build.zip.
xbnjava/coding_standards XBN Java coding standards.
xbnjava/javadoc XBN Java JavaDoc. Your browser should point to the overview-summary.html file in this directory.
xbnjava/supplemental_docs Where all logs, reports and secondary documentation resides.

Directory	Description
`xbnjava`	The root directory. Files: `build.properties`: The top of this file is the only thing you need to configure before building XBN Java on your machine. `build.xml`: The heart of the build process. Go to this directory and type 'ant'. `gnu_general_public_license.txt`: The full text of the license under which XBN Java is released.
`xbnjava`/etcetera	If it's not the Java code for the main XBN packages, JUnit or example code, then it's in this directory. Files: `directory_structure.html`: This file. `idx_redir_root_to_jvdc.html`: A redirect page to put in the root of the build directory, which sends you to the main JavaDoc page.
`xbnjava/etcetera/coding_standards`	Documentation on XBN coding standards, based upon Sun's coding standards. Sun's files are zipped up.
`xbnjava/etcetera/dependencies`	Non-JVM, non-Ant archives and classes XBN Java is dependent on. Java and class files for custom Ant tasks are located here.
`xbnjava/etcetera/javadoc`	Files needed by the JavaDoc process. Files: `css.txt`: The Cascading Style Sheet used by JavaDoc. `doclet_class_map.txt`: Configuration required by JavaDoc Link Codes. `java_sun_pkg_list.txt`: If I could ever figure out the freaking `linkoffline` JavaDoc Ant task attribute, I could use this... `overview.html`: The body of the overview-summary.html Javadoc page. `zBROKEN_LINKS.txt`: A list of all known broken links existing throughout XBN documentation.
`xbnjava/etcetera/javadoc/xbn_doclet`	XBN Doclet, integrating JavaDoc Link Codes into the standard doclet. The files in which (significant) changes are made are unexploded. The rest are zipped.
`xbnjava/etcetera/package_dependencies`	Code and template to generate the listing of all packages that each xbn package is dependent on, and which packages depend on it. This contains the Java code to do the generating, as well as the template files.
`xbnjava/xbn`	The `xbn.*` packages.
`xbnjava/xbn_examples`	The `xbn_example.*` packages, containing all XBN Java example code.
`xbnjava/xbn_junit`	The `xbn_junit.*` packages, containing all XBN Java JUnits.

Directory	Description
`CLASSES`	The directory outside of the build directory in which classes are compiled.
`working`	The directory outside of the build directory in which things are stored for use over multiple builds.
`backup`	The directory outside of the build directory in which the archived source code is backed up. Each archive is given a date-time stamp.
`xbnjava`	The root directory for the build.
`xbnjava/CODE`	The source directory is completely duplicated here, except the root directory is this ('CODE') instead of 'xbnjava'. This is the directory to which source code links should point. Note: This Java code is different than the Java code existing in the source directory. In the source directory, the license text, version number (among other things) are only marked by replacement delimiters. When built, these delimiters are replaced with the actual license and version number. The Java code for building XBN Java exists in the download named `xbnjava_build.zip`.
`xbnjava/coding_standards`	XBN Java coding standards.
`xbnjava/javadoc`	XBN Java JavaDoc. Your browser should point to the overview-summary.html file in this directory.
`xbnjava/supplemental_docs`	Where all logs, reports and secondary documentation resides.