You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-cvs@jakarta.apache.org by jo...@apache.org on 2001/02/05 23:42:34 UTC
cvs commit: jakarta-site2/xdocs/site jakarta-site2.xml
jon 01/02/05 14:42:34
Modified: docs/site jakarta-site2.html
xdocs/site jakarta-site2.xml
Log:
added some more documentation about the project.xml
fixed a broken example property.
-jon
Revision Changes Path
1.10 +22 -6 jakarta-site2/docs/site/jakarta-site2.html
Index: jakarta-site2.html
===================================================================
RCS file: /home/cvs/jakarta-site2/docs/site/jakarta-site2.html,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- jakarta-site2.html 2001/01/31 20:40:50 1.9
+++ jakarta-site2.html 2001/02/05 22:42:34 1.10
@@ -315,7 +315,12 @@
</div>
<p>
Copy the project.xml file from the jakarta-site2/xdocs/stylesheets/ directory
-into your jakarta-myproject/xdocs/stylesheets/ directory.
+into your jakarta-myproject/xdocs/stylesheets/ directory and modify it as
+needed to reflect the navigation needs of your project. If you are going to
+provide links to other projects within the Jakarta project, make sure to
+make their href attribute based on the "document root". For example, if
+your project links to the Ant project, then the href should be something
+like this: href="/ant/index.html"
</p>
<p>
You will need to make a copy of the velocity.properties file from the jakarta-
@@ -336,7 +341,7 @@
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>
-template.loader.1.template.path = ../jakarta-site2/xdocs/stylesheets
+resource.loader.1.resource.path = ../jakarta-site2/xdocs/stylesheets
</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
@@ -352,10 +357,21 @@
for your project, you should then be able to copy/paste the appropriate targets
from the jakarta-site2/build.xml file into your own build.xml file for your
project. You will need to make sure that the jar files in the jakarta-site2/lib
-directory are also added into your classpath for your build.sh script. Below is
-the stuff you should add to your build.xml file. Please note that the path to
-the docs.src and docs.dest would be relative to the directory where the build.sh
-script is run from.
+directory are also added into your classpath in your build.sh script. The
+reason is that Ant does not have a way (that I know of) to add files
+to the classpath based on a conditional set of requirements. In other words,
+you want to allow people to build the rest of your project, but you do not
+want to require your users to have the jakarta-site2 module checked out in
+order to do so. You only want them to have to check out the jakarta-site2
+module if they are going to build their documentation. Unfortunately, this
+isn't currently possible with Ant, therefore you need to specify the
+jakarta-site2 .jar files in the build.sh classpath using the examples
+below...
+</p>
+ <p>
+Below is the stuff you should add to your build.xml file. Please note that
+the path to the docs.src and docs.dest would be relative to the directory
+where the build.sh script is run from.
</p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
1.4 +23 -6 jakarta-site2/xdocs/site/jakarta-site2.xml
Index: jakarta-site2.xml
===================================================================
RCS file: /home/cvs/jakarta-site2/xdocs/site/jakarta-site2.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- jakarta-site2.xml 2001/01/31 20:40:49 1.3
+++ jakarta-site2.xml 2001/02/05 22:42:34 1.4
@@ -137,7 +137,12 @@
<p>
Copy the project.xml file from the jakarta-site2/xdocs/stylesheets/ directory
-into your jakarta-myproject/xdocs/stylesheets/ directory.
+into your jakarta-myproject/xdocs/stylesheets/ directory and modify it as
+needed to reflect the navigation needs of your project. If you are going to
+provide links to other projects within the Jakarta project, make sure to
+make their href attribute based on the "document root". For example, if
+your project links to the Ant project, then the href should be something
+like this: href="/ant/index.html"
</p>
<p>
@@ -151,7 +156,7 @@
</p>
<source>
-template.loader.1.template.path = ../jakarta-site2/xdocs/stylesheets
+resource.loader.1.resource.path = ../jakarta-site2/xdocs/stylesheets
</source>
<p>
@@ -159,10 +164,22 @@
for your project, you should then be able to copy/paste the appropriate targets
from the jakarta-site2/build.xml file into your own build.xml file for your
project. You will need to make sure that the jar files in the jakarta-site2/lib
-directory are also added into your classpath for your build.sh script. Below is
-the stuff you should add to your build.xml file. Please note that the path to
-the docs.src and docs.dest would be relative to the directory where the build.sh
-script is run from.
+directory are also added into your classpath in your build.sh script. The
+reason is that Ant does not have a way (that I know of) to add files
+to the classpath based on a conditional set of requirements. In other words,
+you want to allow people to build the rest of your project, but you do not
+want to require your users to have the jakarta-site2 module checked out in
+order to do so. You only want them to have to check out the jakarta-site2
+module if they are going to build their documentation. Unfortunately, this
+isn't currently possible with Ant, therefore you need to specify the
+jakarta-site2 .jar files in the build.sh classpath using the examples
+below...
+</p>
+
+<p>
+Below is the stuff you should add to your build.xml file. Please note that
+the path to the docs.src and docs.dest would be relative to the directory
+where the build.sh script is run from.
</p>
<source><![CDATA[