Initial outline of Maven site documentation.

This commit is contained in:
Luke Taylor 2004-06-28 18:02:31 +00:00
parent ab3dc26d07
commit 23ef0a55a4
7 changed files with 247 additions and 0 deletions

49
xdocs/faq.xml Executable file
View File

@ -0,0 +1,49 @@
<?xml version="1.0"?>
<document>
<properties>
<title>Acegi FAQ</title>
</properties>
<body>
<section name="Frequently Asked Questions">
<p>
This document attempts to answer some of the more frequently asked
questions regarding various aspects of JBoss. These questions are
typically asked over and over again on the mailing lists and forums. As a
courtesy to the developers, we ask that you read this document
before posting to the mailing lists.
</p>
<p>
<strong>General</strong>
</p>
<ol>
<li>
<a href="#what-is-acegi">
What is Acegi?
</a>
</li>
</ol>
<p>
<strong>More FAQs ...</strong>
</p>
<section name="General">
<dl>
<dt>
<a name="what-is-acegi">
What is Acegi?
</a>
</dt>
<dd>
...
</dd>
</dl>
</section>
</section>
</body>
</document>

30
xdocs/index.xml Executable file
View File

@ -0,0 +1,30 @@
<?xml version="1.0"?>
<document>
<properties>
<title>Acegi Security System for Spring</title>
<author>Luke</author>
</properties>
<body>
<section name="Acegi Security System for Spring">
<p>
This is the Maven generated site for the Acegi-Security project. It is generated as part of an
automated daily build. We intend to expand the information on Acegi which is available here but for
the moment, your best starting point for documentation is Ben Alex's
original <a href="/ref/index.html">reference guide</a>
which provides a comprehensive overview.
</p>
<p>
For more information on running the build with Maven, see the
<a href="./start/build.html">build</a> section of the getting started guide.
</p>
<p>
The main other area of interest at the moment is the <a href="./maven-reports.html">generated reports</a> section.
These are produced by the build on a daily basis and include complete Javadoc and source cross-reference.
</p>
</section>
</body>
</document>

28
xdocs/navigation.xml Executable file
View File

@ -0,0 +1,28 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="Maven">
<title>Acegi Security System for Spring</title>
<body>
<menu name="Overview">
<!-- <item name="Goals" href="/goals.html"/>
<item name="Features" href="/features.html"/> -->
<item name="News and Status" href="/status.html"/>
<item name="Getting Started" href="/start/index.html" collapse="true">
<item name="Download" href="/start/download.html"/>
<item name="Build" href="/start/build.html"/>
</item>
<item name="Reference" href="/reference/index.html" collapse="true">
<item name="User Guide" href="/ref/index.html"/>
<!-- item name="Developer Guide" href="/reference/developer-guide.html"/ -->
<!-- item name="FAQ" href="/faq.html"/ -->
</item>
</menu>
<!--
<menu name="Misc">
<item name="Wiki" href=""/>
<item name="Glossary" href="/glossary.html"/>
<item name="Articles" href="/articles.html"/>
</menu>
-->
</body>
</project>

33
xdocs/reference/index.xml Executable file
View File

@ -0,0 +1,33 @@
<?xml version="1.0"?>
<document>
<properties>
<title>Reference Documentation</title>
</properties>
<body>
<section name="Reference Documentation">
<subsection name="Overview of the Reference Documentation">
<table>
<tr><th>Document</th><th>Description</th></tr>
<tr><td><a href="../ref/index.html">Reference Guide</a></td>
<td>
The original docbook-generated reference. This is a good place to start if you want
to use the Acegi System to secure your applications.
</td>
</tr>
<!-- <tr><td><a href="developer-guide.html">Developer Guide</a></td>
<td>
The Developer Guide is intended to help developers get
acquainted with the project.
</td>
</tr>
-->
</table>
</subsection>
</section>
</body>
</document>

38
xdocs/start/build.xml Executable file
View File

@ -0,0 +1,38 @@
<?xml version="1.0"?>
<document>
<properties>
<title>Building Acegi</title>
</properties>
<body>
<section name="Building Acegi">
<p>
TODO: Checkout the source from Sourceforge...
</p>
<subsection name="Maven Build">
<p>
The first thing to do if you want to use Maven is download and install it.
The build has been tested with version 1-rc3 so use this or a later version if possible.
</p>
<p>
One of the main differences between Maven and plain ant is that Maven manages
external dependencies for your projects and (at least in theory) you should no
longer have to store third-party jar files in your CVS tree. It maintains a local repository of
versioned libraries and shares them between your Maven projects. If it can't find the necessary
files there it will attempt to download them from the main Maven repository at www.ibiblio.org/maven.
So to use the Maven build, you need to have a network connection available for the inital download of
the project dependencies (and any others that Maven itself requires).
</p>
<p>
Once you have Maven installed, building the project should be as simple as typing "maven jar"
from the command line. Providing there are no failures in the test suite, this will create the
project jar files in the "target" directory. For more information on using Maven, have a look at the
<a href="http://maven.apache.org/">Maven web site</a>.
</p>
</subsection>
</section>
</body>
</document>

26
xdocs/start/index.xml Executable file
View File

@ -0,0 +1,26 @@
<?xml version="1.0"?>
<document>
<properties>
<title>Getting Started with Acegi</title>
</properties>
<body>
<section name="Getting Started with Acegi">
<subsection name="Overview of the Getting Started Documentation">
<table>
<tr><th>Document</th><th>Description</th></tr>
<tr><td><a href="download.html">Download</a></td>
<td>
Before you can start using Acegi, you'll have
to download the distribution to your system (unless
you plan on building the project from source). This document
provides links to the various distributions available.
</td>
</tr>
</table>
</subsection>
</section>
</body>
</document>

43
xdocs/status.xml Executable file
View File

@ -0,0 +1,43 @@
<?xml version="1.0"?>
<document>
<properties>
<title>News and Status</title>
</properties>
<body>
<section name="News and Status">
<subsection name="Current Status">
<p>
The next release of Acegi will be version 0.6.
</p>
</subsection>
<subsection name="5th June 2004">
<p>
Version 0.51 released.
</p>
</subsection>
<subsection name="28th April 2004">
<p>
Version 0.5 released.
</p>
</subsection>
<subsection name="3rd April 2004">
<p>
Version 0.4 released.
</p>
</subsection>
<subsection name="18th March 2004">
<p>
Version 0.3 released.
</p>
</subsection>
</section>
</body>
</document>