ceki 01/03/14 15:22:44
Modified: xdocs/site dirlayout.xml
docs/site dirlayout.html
Log:
Changed the src/language requirement from "should" to "may". Half the Jakarta
projects use
src/language and the other half doesn't. I think it's best to leave it open for now.
Corrected the -kb option comment to fit reality. The comment could be removed
altogether.
Changed href references to real and correct values.
Revision Changes Path
1.5 +12 -11 jakarta-site2/xdocs/site/dirlayout.xml
Index: dirlayout.xml
===================================================================
RCS file: /home/cvs/jakarta-site2/xdocs/site/dirlayout.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- dirlayout.xml 2001/03/14 16:39:03 1.4
+++ dirlayout.xml 2001/03/14 23:22:40 1.5
@@ -53,12 +53,12 @@
<td>src/</td>
<td>Source code.</td>
- <td>The code should be placed into separate source code directories by
+ <td>The code may be placed into separate source code directories by
language, as in src/java/ and src/php/ for
source code in the java and PHP languages respectively. If the source
is the Java language, then it should follow a package structure that is
defined like this: org.apache.PROJECT. For example, for
- the <a href="/velocity/">Velocity</a> project, it is
+ the <a href="http://jakarta.apache.org/velocity/">Velocity</a> project, it is
org.apache.velocity.
</td>
<td>YES</td>
@@ -108,11 +108,11 @@
<td>Placing the API documenation under docs/api/ makes it slightly
easier for other documentation files under docs/ to reference API
- documentation and vice versa. It is not recommended to check this into
- CVS. At some point, we will have the <a
- href="/alexandria/">Alexandria</a> project building the documentation
- for all of the Jakarta Projects and making the API documentation
- available that way.
+ documentation and vice versa. It is not recommended to check this
+ into CVS. At some point, we will have the <a
+ href="http://jakarta.apache.org/alexandria/">Alexandria</a> project
+ building the documentation for all of the Jakarta Projects and making
+ the API documentation available that way.
</td>
<td>NO</td>
</tr>
@@ -141,7 +141,7 @@
<tr>
- <td>build/build.sh (or .bat)</td>
+ <td>build/build.sh build/build.bat</td>
<td>Shell scripts for Unix and DOS environments to bootstrap the ANT
build process.</td>
@@ -158,9 +158,10 @@
<td>Binary jar files required in building the sub-project.</td>
<td>The jar files are added to the classpath by the bootstrapping
- shell scripts before invoking ANT. <em>Do not forget the -kb option when
- adding binary files to CVS control.</em> Note, it is allowable to place
- the .jar files at the top level /lib directory.
+ shell scripts before invoking ANT. The -kb option is automatically
+ added when placing common binary types under CVS control. See the
+ <code>CVSROOT/cvswrappers</code> file for the exact types. Note, it
+ is allowable to place the .jar files at the top level /lib directory.
</td>
<td>YES</td>
</tr>
1.6 +202 -181 jakarta-site2/docs/site/dirlayout.html
Index: dirlayout.html
===================================================================
RCS file: /home/cvs/jakarta-site2/docs/site/dirlayout.html,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- dirlayout.html 2001/03/14 16:39:07 1.5
+++ dirlayout.html 2001/03/14 23:22:42 1.6
@@ -184,114 +184,125 @@
<tr>
<td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top"
align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- LICENSE.txt
-
- </font>
+
+ LICENSE.txt
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- A copy of the Apache Public License
-
- </font>
+
+ A copy of the Apache Public License
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- The LICENSE.txt should be placed at a prominent location.
+
+ The LICENSE.txt should be placed at a prominent location.
This file should have the suffix .txt so that it can be opened
easily on platforms that use suffix mappings.
-
- </font>
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- YES
-
- </font>
+
+ YES
+ </font>
</td>
</tr>
<tr>
<td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top"
align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- src/
-
- </font>
+
+ src/
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Source code.
-
- </font>
+
+ Source code.
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- The code should be placed into separate source code directories by
+
+ The code may be placed into separate source code directories by
language, as in src/java/ and src/php/ for
source code in the java and PHP languages respectively. If the source
is the Java language, then it should follow a package structure that is
defined like this: org.apache.PROJECT. For example, for
- the project, it is
+ the
+ <a
+ href="http://jakarta.apache.org/velocity/"
+ >
+ Velocity
+ </a>
+ project, it is
org.apache.velocity.
- <a href="/velocity/">Velocity</a>
-
- </font>
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- YES
-
- </font>
+
+ YES
+ </font>
</td>
</tr>
<tr>
<td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top"
align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- xdocs/
-
- </font>
+
+ xdocs/
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Documentation file in XML format.
-
- </font>
+
+ Documentation file in XML format.
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- The Jakarta site uses Velocity/Anakia to transform dcumentation
+
+ The Jakarta site uses Velocity/Anakia to transform dcumentation
files in XML into HTML. The generated HTML files automatically inherit
- the Jakarta look-and-feel. Documentation is .
+ the Jakarta look-and-feel. Documentation is
+ <a
+ href="./jakarta-site2.html"
+ >
+ available
+ </a>
+ .
- <a href="./jakarta-site2.html">available</a>
-
- </font>
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- YES
-
- </font>
+
+ YES
+ </font>
</td>
</tr>
<tr>
<td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top"
align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- docs/
-
- </font>
+
+ docs/
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Documentation files intended for the end user.
-
- </font>
+
+ Documentation files intended for the end user.
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- The docs/ directory contain most of the documentation for the
+
+ The docs/ directory contain most of the documentation for the
Jakarta sub-project. This includes Velocity/Anakia generated HTML
files. This directory may also contain other documentation files.
Generally, all documentation is stored in the xdocs directory and then
@@ -299,321 +310,330 @@
checked out of CVS on the live website. This can serve a dual purpose
of being the documentation for a project as well as the website.
-
- </font>
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- YES
-
- </font>
+
+ YES
+ </font>
</td>
</tr>
<tr>
<td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top"
align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- docs/index.html
-
- </font>
+
+ docs/index.html
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Starting point for browsing the documentation.
-
- </font>
+
+ Starting point for browsing the documentation.
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Browsing the documentation locally should yield the same results
+
+ Browsing the documentation locally should yield the same results
as browsing the documentation on the sub-project home page on the
Jakarta web site.
-
- </font>
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- YES
-
- </font>
+
+ YES
+ </font>
</td>
</tr>
<tr>
<td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top"
align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- docs/api/
-
- </font>
+
+ docs/api/
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- API documentation as generated by the Javadoc tool.
-
- </font>
+
+ API documentation as generated by the Javadoc tool.
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Placing the API documenation under docs/api/ makes it slightly
+
+ Placing the API documenation under docs/api/ makes it slightly
easier for other documentation files under docs/ to reference API
- documentation and vice versa. It is not recommended to check this into
- CVS. At some point, we will have the project building the documentation
- for all of the Jakarta Projects and making the API documentation
- available that way.
+ documentation and vice versa. It is not recommended to check this
+ into CVS. At some point, we will have the
+ <a
+ href="http://jakarta.apache.org/alexandria/"
+ >
+ Alexandria
+ </a>
+ project
+ building the documentation for all of the Jakarta Projects and making
+ the API documentation available that way.
- <a href="/alexandria/">Alexandria</a>
-
- </font>
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- NO
-
- </font>
+
+ NO
+ </font>
</td>
</tr>
<tr>
<td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top"
align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- build/
-
- </font>
+
+ build/
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Files required for building the sub-project.
-
- </font>
+
+ Files required for building the sub-project.
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Building includes compiling source code, generating javadoc
+
+ Building includes compiling source code, generating javadoc
documentation, the creation of jar files and the distribution files
in tar.gz or zip formats.
-
- </font>
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- YES
-
- </font>
+
+ YES
+ </font>
</td>
</tr>
<tr>
<td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top"
align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- build/build.xml
-
- </font>
+
+ build/build.xml
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- The ANT build script.
-
- </font>
+
+ The ANT build script.
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- All Jakarta projects are required to use ANT as their build tool.
+
+ All Jakarta projects are required to use ANT as their build tool.
Note, it is allowable to place this file at the top level directory
structure.
-
- </font>
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- YES
-
- </font>
+
+ YES
+ </font>
</td>
</tr>
<tr>
<td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top"
align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- build/build.sh (or .bat)
-
- </font>
+
+ build/build.sh build/build.bat
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Shell scripts for Unix and DOS environments to bootstrap the ANT
+
+ Shell scripts for Unix and DOS environments to bootstrap the ANT
build process.
-
- </font>
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- The existence of these files implies the existence of binary jar
+
+ The existence of these files implies the existence of binary jar
files, such as ant.jar and xerces.jar under CVS control
Note, it is allowable to place the shell scripts at the top level
directory structure.
-
- </font>
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- YES
-
- </font>
+
+ YES
+ </font>
</td>
</tr>
<tr>
<td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top"
align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- build/lib/
-
- </font>
+
+ build/lib/
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Binary jar files required in building the sub-project.
-
- </font>
+
+ Binary jar files required in building the sub-project.
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- The jar files are added to the classpath by the bootstrapping
- shell scripts before invoking ANT. Note, it is allowable to place
- the .jar files at the top level /lib directory.
+
+ The jar files are added to the classpath by the bootstrapping
+ shell scripts before invoking ANT. The -kb option is automatically
+ added when placing common binary types under CVS control. See the
- <em>Do not forget the -kb option when
- adding binary files to CVS control.</em>
-
- </font>
+ <code
+ >
+ CVSROOT/cvswrappers
+ </code>
+ file for the exact types. Note, it
+ is allowable to place the .jar files at the top level /lib directory.
+
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- YES
-
- </font>
+
+ YES
+ </font>
</td>
</tr>
<tr>
<td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top"
align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- dist/
-
- </font>
+
+ dist/
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Generated jar files and other sub-project binaries.
-
- </font>
+
+ Generated jar files and other sub-project binaries.
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- This directory contains jar files for the
+
+ This directory contains jar files for the
sub-project. Distribution binaries in .tar.gz and .zip formats should
also be placed in this directory.
-
- </font>
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- NO
-
- </font>
+
+ NO
+ </font>
</td>
</tr>
<tr>
<td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top"
align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- dist/classes/
-
- </font>
+
+ dist/classes/
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Class files generated from the source code contained in the src/
+
+ Class files generated from the source code contained in the src/
directory.
-
- </font>
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Other binary files such as icons and images should also be placed
+
+ Other binary files such as icons and images should also be placed
under dist/classes/. In other words, when the project is built, the
output directory should be this directory.
-
- </font>
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- NO
-
- </font>
+
+ NO
+ </font>
</td>
</tr>
<tr>
<td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top"
align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- contribs/
-
- </font>
+
+ contribs/
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Contributions not officially part of the sub-project.
-
- </font>
+
+ Contributions not officially part of the sub-project.
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Some projects use other names such as whiteboard/ or proposals/.
+
+ Some projects use other names such as whiteboard/ or proposals/.
-
- </font>
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- YES
-
- </font>
+
+ YES
+ </font>
</td>
</tr>
<tr>
<td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top"
align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- lib/
-
- </font>
+
+ lib/
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- .jar or other library files that the project depends on.
-
- </font>
+
+ .jar or other library files that the project depends on.
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- This directory and the build/lib/ directories
+
+ This directory and the build/lib/ directories
are used to store library files that the project depends on. It is
allowable to choose to store files in one or both directories.
-
- </font>
+ </font>
</td>
<td bgcolor="#a0ddf0" colspan="" rowspan=""
valign="top" align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
- YES
-
- </font>
+
+ YES
+ </font>
</td>
</tr>
@@ -651,6 +671,7 @@
</body>
</html>
<!-- end the processing -->
+
