Attached is a text file documenting all the efforts so far to improve
the jakarta-taglibs build process.

Regards,

Glenn
 
----------------------------------------------------------------------
Glenn Nielsen             [EMAIL PROTECTED] | /* Spelin donut madder    |
MOREnet System Programming               |  * if iz ina coment.      |
Missouri Research and Education Network  |  */                       |
----------------------------------------------------------------------
I have been looking at all the mechanisms for building jakarta-taglibs site,
building individual taglibs, and generating documentation for a taglib.

The following individual efforts have helped a great deal to improve the
process:

Use of XML and XSL to build the Jakarta-Taglibs site and individual tag
library site pages done by Justyna.

Development of the taglib release process and updating the Jakarta-Taglibs
site with news contributed by Morgan.

Streamlining and standardizing individual tag library builds using common.xml
contributed by James Strachan.

Use of XML and XSL to build individual tag library tld and documentation
contributed by Scott Stirling.

Overall Jakarta project directory layout guidelines by Ceki.
http://jakarta.apache.org/site/dirlayout.html

Thanks!

Glenn


Here is the current structure of jakarta-taglibs and an individual taglib or
ctlx tool.  Please let me know if I have missed anything.  Later I will
make a proposal for merging all these together and restructuring the layout
and build process. Please let me know if you have any comments or 
suggestions for improving any of the below.


Current directory layout for jakarta-taglibs
============================================

Text Files
----------

HOWTO-RELEASE - Morgans great document for how to release a taglib
LICENSE - Apache License
README - Readme about using and building taglibs

Build Files
-----------

build.bat - Windows build script
build.sh - Unix build script
build.xml - Overall taglibs Ant build config
common.properties - common properties for building a taglib
common.xml - common Ant config for building a taglib

Jakarta Site static documents
-----------------------------

doc/
doc/binarydist.html - http:/jakarta.apache.org/taglibs/binarydist.html
doc/sourcedist.html - http:/jakarta.apache.org/taglibs/sourcedist.html
doc/tutorial.html - http:/jakarta.apache.org/taglibs/tutorial.html

Jakarta Site generated documents source
---------------------------------------

src/doc/index.xml - http:/jakarta.apache.org/taglibs/index.html
src/doc/project.xml - http:/jakarta.apache.org/taglibs/index.html (Menu)
src/doc/taglibs_docs.dtd - DTD for use with index.html and taglib intro.xml
src/doc/images/jakarta-logo.gif - The Jakarta logo
src/doc/images/taglibs.gif - The Jakarta-Taglibs logo
src/doc/stylesheets/taglibs.xsl - Transform index.xml & project.xml into index.html

Template files for individual taglib documentation
--------------------------------------------------

taglib-doc-kit/
taglib-doc-kit/README.txt - All about dynamically generating your taglib docs
taglib-doc-kit/taglib-doc-build.xml - A sample build file for taglib
taglib-doc-kit/xml/footer.xsl - Footer for taglib documenation
taglib-doc-kit/xml/jndi-tags.xml - Example taglib XML data file for JNDI taglib
taglib-doc-kit/xml/taglib-doc.xsl - Transform jndi-tags.xml into the taglib index.html 
doc
taglib-doc-kit/xml/taglib-template-tags_xml - Template for taglib XML data
taglib-doc-kit/xml/taglib.css - CSS for use with taglib index.html doc
taglib-doc-kit/xml/tld.xsl - Transform jndi-tags.xml into a JSP 1.1 TLD file

Custom Tag Libraries
--------------------

<taglib>/ - Source for a custom tag library

Custom Tag Library Extensions (CTLX)
------------------------------------

tools/<tool>/<version>/ - Source for a publishing tool JSP taglib extension

Generated files from taglib build process
-----------------------------------------

../build/taglibs/ - Where all the taglibs go when you build them
../build/taglibs/doc/ - Where the jakarta site documentation goes when you use the ant 
target "compile.documentation"
../dist/taglibs/ - Where all the taglibs go when you build a binary distribution


Current Directory Layout for a taglib
=====================================

Jakarta Site generated document source
--------------------------------------

<taglib>/doc/web/intro.xml - Taglib Jakarta site XML data file, transformed by 
src/doc/stylesheets/taglibs.xsl

Build Files
-----------

<taglib>/build.bat - Windows build script (Not needed if using common.xml based build)
<taglib>/build.sh - Unix build script (Not needed if using common.xml based build)
<taglib>/build.xml - Ant build file for taglib

Static Configuration and Documentation Files (Original)
-------------------------------------------------------

<taglib>/conf/<taglib>.tld - TLD for taglib
<taglib>/doc/conf/web.xml - web.xml for <taglib>-doc.war
<taglib>/doc/web/changes.html - Taglib change history for site docs and 
<taglib>-doc.war
<taglib>/doc/web/index.html - Taglib documentation for site docs and <taglib>-doc.war

Configuration Files (taglib-doc-kit)
------------------------------------

<taglib>/xml/<taglib>-tags.xml - Taglib and tag XML data transformed by 
taglib-doc-kit/xml/taglib-doc.xsl into the taglib index.html documentation and by 
taglib-doc-kit/xml/tld.xsl into the <taglib>.tld

Examples web application
------------------------

examples/conf/web.xml - web.xml for <taglib>-examples.war
examples/web/index.html - Static root document for <taglib>-examples.war
examples/web/*.html - Additional static documents for <taglib>-examples,war
examples/web/*.jsp - One or more static example jsp pages for <taglib>-examples.war

Taglib java source
------------------

<taglib>/src/ - taglib java source in package org.apache.taglibs

Generated files from taglib build process
-----------------------------------------

../build/taglibs/<taglib> - Compiled java class files
../build/taglibs/<taglib>-doc - Taglib documentation web app directories and files
../build/taglibs/<taglib>-examples - Taglib examples web app directories and files
../dist/taglibs/<taglib>/<taglib>-doc.war - Taglib documentation war file
../dist/taglibs/<taglib>/<taglib>-examples.war - Taglib examples war file.
../dist/taglibs/<taglib>/<taglib>.jar - Taglib jar file
../dist/taglibs/<taglib>/<taglib>.tld - Taglib TLD file

Reply via email to