Bommels05/commons-xml
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add some more procedure notes.

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/xml/commons/trunk@226108 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
crossley 2003-09-06 08:26:54 +00:00
parent 50a54c0a9f
commit 243cd8d1d5
1 changed files with 35 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
src/documentation/content/xdocs/howto-forrest.xml
View File

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "document-v12.dtd">
<document>
<header>
<title>How to produce xml-commons website with Forrest</title>
@ -8,24 +8,24 @@
</authors>
</header>
<body>
<section>
<section id="overview">
<title>Overview</title>
<p>
This is the procedure that i followed to build the initial xml-commons
website with Forrest.
This is the procedure for building the initial xml-commons website
with Forrest.
</p>
</section>
<section>
<section id="install">
<title>Install Forrest on localhost</title>
<p>
Followed the document:
<link href="http://xml.apache.org/forrest/your-project.html">Using
Follow the document:
<link href="site:forrest/your-project">Using
Forrest</link>
</p>
</section>
<section>
<section id="seed">
<title>Seed the new website</title>
<p>
This only needed to be done to start and it is done now and committed
@ -38,15 +38,16 @@ vi src/documentation/skinconf.xml
]]></source>
</section>
<section>
<section id="content">
<title>Edit the content</title>
<source><![CDATA[
vi src/documentation/content/xdocs/*.xml
(DC already copied content from README.html and split it.)
]]></source>
<p>The xdocs source are now ready for anyone to enhance the content.</p>
</section>
<section>
<section id="build">
<title>Build it and view it</title>
<source><![CDATA[
cd /usr/local/cvs/xml-commons
@ -54,14 +55,33 @@ ant
... this will build everything (website docs, javadocs, distribution)
mozilla file:///usr/local/cvs/xml-commons/build/site/index.html
]]></source>
<p>For better turnaround when developing docs, you can do
<code>'forrest'</code> which just validates and builds the docs.
If you want to only validate the xdocs then do
<code>'forrest validate-xdocs'</code>. You can get even faster
turnaround with the targets <code>'forrest run'</code> and
<code>'forrest backcopy'</code> (beware with that) to run a
live forrest webapp.
Do <code>'forrest -projecthelp'</code> for more tips. Anyway, see the
<link href="site:forrest/your-project">Using Forrest</link>
document.
</p>
</section>
<section>
<section id="xml-site">
<title>Updating the website</title>
<p>Copy everything in <code>./build/site</code> over to the xml-site
repository at <code>xml-site/targets/commons</code> and commit.
</p>
</section>
<section id="other">
<title>Other notes</title>
<p>
A project sitemap has been added at
<code>src/documentation/sitemap.xmap</code> of which we only use a small
portion. This portion has been marked with comments.
portion. This portion has been marked with comments to enable easier sync
with Forrest releases.
</p>
<p>
@ -70,7 +90,7 @@ If that is different on your system, then tweak the sitemap.xmap to suit.
</p>
</section>
<section>
<section id="todo">
<title>Still to do</title>
<ul>
<li>Ask the '<code>forrestbot</code>' to build the xml-commons site.