Update the documentation about building the site.
Now using Forrest-0.7 version. git-svn-id: https://svn.apache.org/repos/asf/xml/commons/trunk@280508 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
crossley
parent
e32f0461a4
commit
3f0703188b
@ -17,13 +17,10 @@ The website update cronjob happens via user dims at 01:00 and 13:00 GMT.
|
|||||||
Step 1
|
Step 1
|
||||||
------
|
------
|
||||||
cd xml-commons
|
cd xml-commons
|
||||||
ant -projecthelp
|
forrest
|
||||||
... No point repeating the options here, but one hint:
|
|
||||||
site, validate, war, and webapp targets are part of Forrest.
|
|
||||||
|
|
||||||
ant all
|
ant all
|
||||||
- Builds the documentation, builds each sub-project, and packs the
|
... Builds each sub-project, and packs the distribution.
|
||||||
distribution.
|
|
||||||
|
|
||||||
------------------------------------------------------------------------
|
------------------------------------------------------------------------
|
||||||
Step 2
|
Step 2
|
||||||
|
|||||||
@ -1,6 +1,6 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
<!--
|
<!--
|
||||||
Copyright 2002-2004 The Apache Software Foundation
|
Copyright 2002-2005 The Apache Software Foundation
|
||||||
|
|
||||||
Licensed under the Apache License, Version 2.0 (the "License");
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
you may not use this file except in compliance with the License.
|
you may not use this file except in compliance with the License.
|
||||||
@ -17,22 +17,19 @@
|
|||||||
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "document-v12.dtd">
|
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "document-v12.dtd">
|
||||||
<document>
|
<document>
|
||||||
<header>
|
<header>
|
||||||
<title>How to produce xml-commons website with Forrest</title>
|
<title>How to produce xml-commons website with Apache Forrest</title>
|
||||||
<authors>
|
|
||||||
<person name="David Crossley" email="crossley@apache.org"/>
|
|
||||||
</authors>
|
|
||||||
</header>
|
</header>
|
||||||
<body>
|
<body>
|
||||||
<section id="overview">
|
<section id="overview">
|
||||||
<title>Overview</title>
|
<title>Overview</title>
|
||||||
<p>
|
<p>
|
||||||
This is the procedure for building the initial xml-commons website
|
This is the procedure for building the xml-commons website
|
||||||
with Forrest.
|
with Apache Forrest.
|
||||||
</p>
|
</p>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section id="install">
|
<section id="install">
|
||||||
<title>Install Forrest version 0.5.1 on localhost</title>
|
<title>Install Forrest version 0.7 on localhost</title>
|
||||||
<p>
|
<p>
|
||||||
Follow the document:
|
Follow the document:
|
||||||
<link href="site:forrest/your-project">Using
|
<link href="site:forrest/your-project">Using
|
||||||
@ -40,46 +37,25 @@
|
|||||||
</p>
|
</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
|
|
||||||
to CVS.
|
|
||||||
</p>
|
|
||||||
<source><![CDATA[
|
|
||||||
cd /usr/local/cvs/xml-commons
|
|
||||||
forrest seed
|
|
||||||
vi src/documentation/skinconf.xml
|
|
||||||
]]></source>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<section id="content">
|
<section id="content">
|
||||||
<title>Edit the content</title>
|
<title>Edit the content</title>
|
||||||
<source><![CDATA[
|
<source><![CDATA[
|
||||||
vi src/documentation/content/xdocs/*.xml
|
vi src/documentation/content/xdocs/*.xml
|
||||||
(DC already copied content from README.html and split it.)
|
|
||||||
]]></source>
|
]]></source>
|
||||||
<p>The xdocs source are now ready for anyone to enhance the content.</p>
|
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section id="build">
|
<section id="build">
|
||||||
<title>Build it and view it</title>
|
<title>Build it and view it</title>
|
||||||
<source><![CDATA[
|
<source><![CDATA[
|
||||||
cd /usr/local/cvs/xml-commons
|
cd xml-commons
|
||||||
ant
|
forrest
|
||||||
... this will build everything (website docs, javadocs, distribution)
|
|
||||||
mozilla file:///usr/local/cvs/xml-commons/build/site/index.html
|
|
||||||
]]></source>
|
]]></source>
|
||||||
<p>For better turnaround when developing docs, you can do
|
<p>which validates and builds the docs.
|
||||||
<code>'forrest'</code> which just validates and builds the docs.
|
|
||||||
If you want to only validate the xdocs then do
|
If you want to only validate the xdocs then do
|
||||||
<code>'forrest validate-xdocs'</code>. You can get even faster
|
<code>'forrest validate-xdocs'</code>. You can get even faster
|
||||||
turnaround with the targets <code>'forrest run'</code> and
|
turnaround for developing the docs by using <code>'forrest run'</code>
|
||||||
<code>'forrest backcopy'</code> (beware with that) to run a
|
to run a live forrest webapp. When finished, do
|
||||||
live forrest webapp.
|
<code>'forrest'</code> to build the full site.
|
||||||
Do <code>'forrest -projecthelp'</code> for more tips. Anyway, see the
|
|
||||||
<link href="site:forrest/your-project">Using Forrest</link>
|
|
||||||
document.
|
|
||||||
</p>
|
</p>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
@ -101,33 +77,15 @@ There are some other general notes at <code>xml-commons/readme-build.txt</code>
|
|||||||
|
|
||||||
<p>
|
<p>
|
||||||
A project sitemap has been added at
|
A project sitemap has been added at
|
||||||
<code>src/documentation/sitemap.xmap</code> of which we only use a small
|
<code>src/documentation/sitemap.xmap</code>
|
||||||
portion. This portion has been marked with comments to enable easier sync
|
|
||||||
with Forrest releases.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p>Try to keep our sitemap.xmap and skinconf.xml and forrest.properties
|
|
||||||
in sync with the Forrest "fresh-site" stuff.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
There is a hard-coded path in our sitemap to the DocBook XSL stylesheets.
|
There is a hard-coded path in our sitemap to the DocBook XSL stylesheets.
|
||||||
If that is different on your system, then tweak the sitemap.xmap to suit.
|
If that is different on your system, then tweak the sitemap.xmap to suit.
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p>Try to keep our skinconf.xml and forrest.properties
|
||||||
|
in sync with the Forrest "fresh-site" stuff.
|
||||||
</p>
|
</p>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
<section id="todo">
|
|
||||||
<title>Still to do</title>
|
|
||||||
<ul>
|
|
||||||
<li>Ask the '<code>forrestbot</code>' to build the xml-commons site.
|
|
||||||
See <link href="http://forrestbot.cocoondev.org/">http://forrestbot.cocoondev.org/</link> ... However, we need the DocBook stylesheets on moof.apache.org first.
|
|
||||||
</li>
|
|
||||||
<li>
|
|
||||||
Decide how to build the website to better combine the needs of the separate
|
|
||||||
components. See the isses listed on the
|
|
||||||
<link href="site:todo">To Do List</link>
|
|
||||||
</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
</body>
|
</body>
|
||||||
</document>
|
</document>
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user