mcconnell 2003/10/28 11:51:33
Added: site .cvsignore project.properties project.xml
site/xdocs download.xml index.xml navigation.xml usage.xml
Log:
Create maven based site generation.
Revision Changes Path
1.1 avalon-excalibur/site/.cvsignore
Index: .cvsignore
===================================================================
target
velocity.log
maven.log
1.1 avalon-excalibur/site/project.properties
Index: project.properties
===================================================================
#
# Banner background and foreground colors.
#
maven.ui.banner.background = #fff
maven.ui.banner.foreground = #000
#maven.xdoc.jsl = file:/${basedir}/../site/etc/site.jsl
maven.javadoc.stylesheet =${basedir}/../site/etc/stylesheet.css
maven.xdoc.poweredby.image=
#
# Declaration of the remote links to assign on javadoc generation.
# Link declarations can be overriden in the user's build.properties
# file.
#
sun.j2se.link = http://java.sun.com/j2se/1.4/docs/api/
avalon.framework.link = http://avalon.apache.org/framework/api/
maven.javadoc.links = ${sun.j2se.link},${avalon.framework.link}
1.1 avalon-excalibur/site/project.xml
Index: project.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<project>
<extend>${basedir}/../project.xml</extend>
<name>Avalon Excalibur</name>
<id>avalon-excalibur-docs</id>
<shortDescription>Avalon Excalibur Site</shortDescription>
<description>Avalon Excalibur Site</description>
</project>
1.1 avalon-excalibur/site/xdocs/download.xml
Index: download.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<author email="[EMAIL PROTECTED]">Stephen McConnell</author>
<title>Cornerstone</title>
</properties>
<body>
<section name="Download">
<subsection name="Instructions">
<p>PLACEHOLDER</p>
</subsection>
</section>
</body>
</document>
1.1 avalon-excalibur/site/xdocs/index.xml
Index: index.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<author email="[EMAIL PROTECTED]">Avalon Documentation Team</author>
<title>Excalibur i18n</title>
</properties>
<body>
<section name="Excalibur">
<subsection name="Overview">
<p>
The Excalibur Project contains a set of utilitiy projects
used in the development of container facilities and as
underlying system for cause-grain components such as the
Cornerstone suite.
</p>
</subsection>
<subsection name="Index">
<table>
<tr><th>Package</th><th>Description</th></tr>
<tr><td>Compatability</td><td></td></tr>
<tr><td>Component</td><td></td></tr>
<tr><td><a href="configuration/index.html">Configuration</a></td><td>
<p>
The Configuration package contains extensions to the Avalon Framework
supporting configuration management.
</p></td></tr>
<tr><td>Datasource</td><td></td></tr>
<tr><td>Event</td><td></td></tr>
<tr><td><a href="i18n/index.html">i18n</a></td><td>
<p>
Excalibur's Internationalization package is found in
<code>org.apache.avalon.excalibur.i18n</code>. Avalon
Excalibur includes a method of managing resources, and
an interface for specifying the resource. Support for
XML resource bundles are still under development.
</p></td></tr>
<tr><td>Instrumentation</td><td></td></tr>
<tr><td>Lifecycle</td><td></td></tr>
<tr><td>Monitor</td><td></td></tr>
<tr><td>Pool</td><td></td></tr>
<tr><td>Sourceresolver</td><td></td></tr>
<tr><td>Store</td><td></td></tr>
<tr><td>Thread</td><td></td></tr>
<tr><td>XMLUtil</td><td></td></tr>
</table>
</subsection>
</section>
</body>
</document>
1.1 avalon-excalibur/site/xdocs/navigation.xml
Index: navigation.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<project>
<title>Avalon Sandbox</title>
<body>
<links>
<item name="Apache" href="http://apache.org/"/>
<item name="Avalon" href="http://avalon.apache.org/"/>
<item name="Framework" href="http://avalon.apache.org/product/framework/"/>
<item name="Containers" href="http://avalon.apache.org/product/containers/"/>
<item name="Components" href="http://avalon.apache.org/product/components/"/>
</links>
<menu name="About Excalibur">
<item name="Overview" href="/index.html"/>
<item name="Download" href="http://avalon.apache.org/download.cgi"/>
</menu>
</body>
</project>
1.1 avalon-excalibur/site/xdocs/usage.xml
Index: usage.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<author email="[EMAIL PROTECTED]">Avalon Documentation Team</author>
<title>Excalibur i18n - Usage</title>
</properties>
<body>
<section name="Excalibur i18n">
<subsection name="Usage">
<p>
Using the i18n code is really straightforward; several
examples of internationalized applications exist within
the Avalon application family.
</p>
<p>
The following code is an example of the usage of the
i18n package.
</p>
<source>
// in a file called src/java/MyClass.java
import org.apache.avalon.excalibur.i18n.ResourceManager;
import org.apache.avalon.excalibur.i18n.Resources;
public class MyClass implements MyInterface
{
private static final Resources REZ =
ResourceManager.getPackageResources( MyClass.class );
public void doStuff( Object myArg ) throws Exception
{
// ...
final String stupidArgumentIdentifier = myArg.toString();
// ...
final String message =
REZ.getString( "myclass.error.dostuff.bad-argument",
stupidArgumentIdentifier );
m_logger.error( message );
throw new SomeException( message, myArg );
}
}
# in a file called src/java/Resources.properties
myclass.error.dostuff.bad-argument=the argument passed to the \
doStuff method is invalid; it is {0}, which is plain silly!
</source>
<p>
That's basically all there is to it. If you follow this
pattern consistently, it will be extremely easy to i18n
your application by just putting in place a different
Resources.properties.
</p>
<p>
This i18n package is, indeed, a trivial wrapper around
the built-in i18n features java has using ResourceBundles
and the like. See the java api docs for
<link
href="http://java.sun.com/j2se/1.4.1/docs/api/java/util/ResourceBundle.html";>ResourceBundle</link>
to learn more about i18n, and take a look at the javadoc
for Resources and ResourceManager to see which options
are available.
</p>
</subsection>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
