You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by se...@apache.org on 2007/05/02 18:36:26 UTC
svn commit: r534535 - in
/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs: ./ howto/ services/
Author: seade
Date: Wed May 2 09:36:24 2007
New Revision: 534535
URL: http://svn.apache.org/viewvc?view=rev&rev=534535
Log:
Documentation tweaks for 2.3.3-rc1.
Modified:
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/configuration-howto.xml
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/context-howto.xml
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/intake-howto.xml
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/jsp-howto.xml
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/python-howto.xml
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/velocity-site-howto.xml
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/velocityonlylayout-howto.xml
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/navigation.xml
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/index.xml
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/jsp-service.xml
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/localization-service.xml
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/resources-service.xml
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/scheduler-service.xml
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/security-service.xml
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/template-service.xml
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/torque-security-schema.xml
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/torque-security-service.xml
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/velocity-service.xml
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/xmlrpc-service.xml
jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/yaafi-component-service.xml
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/configuration-howto.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/configuration-howto.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/configuration-howto.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/configuration-howto.xml Wed May 2 09:36:24 2007
@@ -89,7 +89,7 @@
The TurbineConfiguration.xml file doesn't contain any configuration data itself, instead
it points at other files that may have configuration data. Turbine leverages Commons-Configuration's
ConfigurationFactory to access the data. For more information, look at
-<a href="http://jakarta.apache.org/commons/sandbox/configuration/">Configuration</a> homepage.
+<a href="http://jakarta.apache.org/commons/configuration/">Configuration</a> homepage.
</p>
<p>
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/context-howto.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/context-howto.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/context-howto.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/context-howto.xml Wed May 2 09:36:24 2007
@@ -474,7 +474,7 @@
<p>
where the two methods are public methods in the Book Object, in this case built
-by the <a href="torque.html">Torque Tool</a>. These methods would return;
+by the <a href="http://db.apache.org/torque/">Torque</a>. These methods would return;
</p>
<source test=""><![CDATA[
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/intake-howto.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/intake-howto.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/intake-howto.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/intake-howto.xml Wed May 2 09:36:24 2007
@@ -130,8 +130,7 @@
<p>
In order to use Turbine's Action event system, the submit buttons
must adhere to the naming specification defined by
- <a href="http://jakarta.apache.org/turbine/turbine-2/howto/action-event-howto.html">
- Turbine's Action event system</a>.
+ <a href="action-event-howto.html">Turbine's Action event system</a>.
</p>
<subsection name="*** IMPORTANT NOTE ***">
@@ -249,7 +248,7 @@
<p>
For a complete list of valid attributes of the group
element, please see the
- <a href="http://jakarta.apache.org/turbine/turbine-2/services/intake-service.html">
+ <a href="../services/intake-service.html">
intake-service document</a> on the Turbine web site.
</p>
</subsection>
@@ -330,7 +329,7 @@
<p>
For a complete list of valid attributes of the field
element, please see the
- <a href="http://jakarta.apache.org/turbine/turbine-2/services/intake-service.html">
+ <a href="../services/intake-service.html">
intake-service document</a> on the Turbine web site.
</p>
</subsection>
@@ -351,7 +350,7 @@
<p/>
<p>
For more info on the supported rules, please see the
- <a href="http://jakarta.apache.org/turbine/turbine-2/services/intake-service.html">
+ <a href="../services/intake-service.html">
intake-service document</a> on the Turbine web site:
</p>
</subsection>
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/jsp-howto.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/jsp-howto.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/jsp-howto.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/jsp-howto.xml Wed May 2 09:36:24 2007
@@ -37,7 +37,7 @@
document, if there are still errors in this configuration, <a
href="http://jakarta.apache.org/site/mail.html">please subscribe to the
Turbine Users list and let us know</a>. Also note that this file is
-checked into Turbine's CVS tree under xdocs/jsp-configuration.xml. We
+checked into Turbine's SVN tree under xdocs/jsp-configuration.xml. We
appreciate all <a
href="http://jakarta.apache.org/site/source.html">patches and
contributions</a> that improve this document.
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/python-howto.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/python-howto.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/python-howto.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/python-howto.xml Wed May 2 09:36:24 2007
@@ -29,7 +29,7 @@
<body>
<section name="Turbine Python Support">
<p>
- Turbine has support for creating assemblers (see the <a href="fsd.html">
+ Turbine has support for creating assemblers (see the <a href="../fsd.html">
specifications</a>) with Python, by making use of
<a href="http://www.jpython.org">JPython technology</a>.
</p>
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/velocity-site-howto.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/velocity-site-howto.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/velocity-site-howto.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/velocity-site-howto.xml Wed May 2 09:36:24 2007
@@ -31,7 +31,7 @@
<p>
In Turbine, we have excellent integration with the template tool
-<a href="http://jakarta.apache.org/velocity/">Velocity</a>,
+<a href="http://velocity.apache.org/engine/">Velocity</a>,
we call this VelocitySite building. The reason why we want to wrap Turbine
around Velocity instead of using it on its own is to provide a completely
MVC model for building web applications where the framework has control
@@ -49,7 +49,7 @@
Knowledge of how Velocity works and what a Velocity Context object is
are required for understanding this documentation. This documentation also
assumes that you are using a Servlet API 2.2 and higher serlvet engine
-such as <a href="http://jakarta.apache.org/tomcat/">Tomcat</a> because
+such as <a href="http://tomcat.apache.org/">Tomcat</a> because
we are now targeting towards using WAR archives. Although, this should
work with older servlet engines as well...it just may be slightly harder
for you to setup. You should also be familiar with the rest of the Turbine
@@ -161,7 +161,7 @@
The result will be a fully formed HTML document with the <em>$hello</em>
replaced with the value: "this is a test...". If you want to make the URI
above shorter or easier to read, you could simply re-write things using
-<a href="http://www.apache.org/docs/mod/mod_rewrite.html">mod_rewrite</a>.
+<a href="http://httpd.apache.org/docs/1.3/mod/mod_rewrite.html">mod_rewrite</a>.
For example, by removing the "<em>/servlet/Turbine/template</em>" portion
of the URI.
</p>
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/velocityonlylayout-howto.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/velocityonlylayout-howto.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/velocityonlylayout-howto.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/howto/velocityonlylayout-howto.xml Wed May 2 09:36:24 2007
@@ -31,9 +31,9 @@
<section name="Introduction">
<p>
- The VelocityECSLayout has been deprecated in Turbine 2.3. This document
- is intended to help you convert your application to use the
- VelocityOnlyLayout.
+ <strong>The VelocityECSLayout was deprecated in Turbine 2.3 (and removed in
+ 2.3.3).</strong> This document is intended to help you convert your
+ application to use the VelocityOnlyLayout.
</p>
<p>
The VelocityOnlyLayout does not use ECS to generate the HTML page for
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/navigation.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/navigation.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/navigation.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/navigation.xml Wed May 2 09:36:24 2007
@@ -46,7 +46,7 @@
<item name="Avalon Component Service" href="/services/avalon-component-service.html"/>
<item name="Crypto Service" href="/services/crypto-service.html"/>
<item name="Cache Service" href="/services/cache-service.html"/>
- <item name="Component Service" href="/services/component-service.html"/>
+ <!-- item name="Component Service" href="/services/component-service.html"/ -->
<item name="Factory Service" href="/services/factory-service.html"/>
<item name="Intake Service" href="/services/intake-service.html"/>
<item name="JSP Service" href="/services/jsp-service.html"/>
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/index.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/index.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/index.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/index.xml Wed May 2 09:36:24 2007
@@ -81,7 +81,8 @@
<a href="avalon-component-service.html">Avalon Component Service</a>
<br/>
Initializes external components which implement the Avalon lifecycle
-interface, e.g. Torque.
+interface, e.g. Torque. See also the <a href="yaafi-component-service.html">
+Yaafi Component Service</a>
</li>
<li>
@@ -97,14 +98,6 @@
</li>
<li>
-<a href="component-service.html">Component Service</a>
-<br/>
-Initializes external components which implement the Stratum lifecycle
-interface, e.g. Torque and Fulcrum. Any new components will use the
-Avalon lifecycle and thus the Avalon Component Service.
-</li>
-
-<li>
<a href="factory-service.html">Factory Service</a>
<br/>
A Service for the instantiation of objects with either the specified loaders or
@@ -240,7 +233,7 @@
<li>
<a href="velocity-service.html">Velocity Service</a>
<br/>
-<b>[TO DO]</b> The service for the processing of Velocity Templates from within
+The service for the processing of Velocity Templates from within
the Turbine Layout/Navigations and Screen structure.
</li>
@@ -254,6 +247,16 @@
<a href="xslt-service.html">XSLT Service</a>
<br/>
The service which is used to transform XML with an XSLT stylesheet.
+</li>
+
+<li>
+<a href="yaafi-component-service.html">Yaafi Component Service</a>
+<br/>
+The Yaafi Component service loads external modules which implement the
+<a href="http://avalon.apache.org/">Avalon</a> lifecycle interfaces. This is
+a bridge between the Turbine 2.3 we have today and the
+<a href="http://jakarta.apache.org/turbine/fulcrum/">Fulcrum</a> components
+that until now have only been available to Turbine 2.4 (yet to be released).
</li>
</ul>
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/jsp-service.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/jsp-service.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/jsp-service.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/jsp-service.xml Wed May 2 09:36:24 2007
@@ -41,7 +41,7 @@
<p>
While Turbine supports the use of many templating systems, we definitely
have our favorite system to use and recommend and that is <a
-href="http://jakarta.apache.org/velocity/">Velocity</a>.
+href="http://velocity.apache.org/engine/">Velocity</a>.
</p>
</section>
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/localization-service.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/localization-service.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/localization-service.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/localization-service.xml Wed May 2 09:36:24 2007
@@ -23,6 +23,7 @@
<properties>
<title>Turbine Services - Localization Service</title>
<author email="jvanzyl@apache.org">Jason van Zyl</author>
+ <author email="seade@backstagetech.com.au">Scott Eade</author>
</properties>
<body>
@@ -50,7 +51,7 @@
# To specify properties of a service use the following syntax:
# service.[name].[property]=[value]
-services.GlobalCacheService.classname=org.apache.turbine.services.cache.TurbineGlobalCacheService
+services.LocalizationService.classname=org.apache.turbine.services.localization.TurbineLocalizationService
.
.
.
@@ -58,13 +59,39 @@
</section>
-<section name="Usage">
+<section name="Resource Bundles">
+<p>
+Resource bundles are basically property files. You might have one for the "en"
+locale thus:
+</p>
+
+<source><![CDATA[
+LABEL_ORGANIZATION = organisation
+CURRENT_RECORD = Record {0} of {1}
+]]></source>
+
+<p>
+and another for the "en_US" locale thus:
+</p>
+
+<source><![CDATA[
+LABEL_ORGANIZATION = organization
+]]></source>
+
+<p>
+Please see the <em>java.util.ListResourceBundle</em> and
+<em>java.util.ResourceBundle</em> classes for more information.
+</p>
+
+</section>
+
+<section name="Usage">
<source><![CDATA[
TurbineServices.getInstance().getService(LocalizationService.LOCALIZATION)
- .getString("DISPLAYPROJECTS_TITLE");
+ .getString("LABEL_ORGANIZATION");
]]></source>
@@ -74,7 +101,7 @@
<source><![CDATA[
-Localization.getString("DISPLAYPROJECTS_TITLE");
+Localization.getString("LABEL_ORGANIZATION");
]]></source>
@@ -87,7 +114,7 @@
<source><![CDATA[
-Localization.getString(data, "DISPLAYPROJECTS_TITLE");
+Localization.getString(data, "LABEL_ORGANIZATION");
]]></source>
@@ -98,13 +125,46 @@
</p>
<p>
-For creating the file where you get the value of the String, please
-see the <em>java.util.ListResourceBundle</em> and
-<em>java.util.ResourceBundle</em> classes for more information.
-<a href="http://java.apache.org/jyve/">Jyve</a> also contains example usage
-of this code because that was the first place where this code was originally
-developed.
+Equivalents of the format() methods illustrated below are also available for
+handling localized strings with arguments defined as "{0}", "{1}", etc.
</p>
+
+</section>
+
+<section name="Usage from a template">
+
+<p>
+Turbine provides a <a href="../pullmodel-howto.html">Pull tool</a> to make it
+very easy to access localized text from within your templates. To configure
+this you need to add the following to your TrubineResouces.properties:
+</p>
+
+<source><![CDATA[
+tool.request.l10n = org.apache.turbine.services.localization.LocalizationTool
+]]></source>
+
+<p>
+You can then use it in your templates thus:
+</p>
+
+<source><![CDATA[
+$l10n.LABEL_ORGANIZATION
+]]></source>
+
+<p>
+A string with arguments can be used thus:
+</p>
+
+<source><![CDATA[
+// No arguments
+$l10n.LABEL_ORGANIZATION
+// One argument
+$l10n.format("STRING_KEY_ONE_ARG" "arg1")
+// Two arguments
+$l10n.format("CURRENT_RECORD" "1", "5")
+// Two arguments
+$l10n.format("STRING_KEY_3_OR_MORE_ARGS" ["arg1", "arg2", "arg3"])
+]]></source>
</section>
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/resources-service.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/resources-service.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/resources-service.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/resources-service.xml Wed May 2 09:36:24 2007
@@ -35,7 +35,7 @@
Within Turbine was a service for reading and accessing data in Property
files. The classes that accomplish this have been borrowed from the
Apache JServ project, moved many time and finally ended up in the <a
-href="http://jakarta.apache.org/commons/sandbox/configuration">commons-configuration</a>
+href="http://jakarta.apache.org/commons/configuration/">commons-configuration</a>
sub-project. So we removed the Service itself and now use commons-configuration everywhere.
</p>
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/scheduler-service.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/scheduler-service.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/scheduler-service.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/scheduler-service.xml Wed May 2 09:36:24 2007
@@ -24,6 +24,7 @@
<properties>
<title>Turbine Services - Scheduler Service</title>
<author email="jvanzyl@apache.org">Jason van Zyl</author>
+ <author email="seade@backstagetech.com.au">Scott Eade</author>
</properties>
<body>
@@ -58,6 +59,18 @@
Velocity template.
</li>
</ul>
+</p>
+
+<p>
+<strong>The Scheduler Service contains a bug whereby system time changes that
+move the clock backwards can result in all tasks scheduled for execution
+occurring twice (this happens at the end of DST here below the equator).</strong>
+</p>
+
+<p>
+<strong>As of Turbine 2.3.3 the Scheduler Service is deprecated. Please use the
+<a href="http://jakarta.apache.org/turbine/fulcrum/fulcrum-quartz/">Fulcrum
+Quartz</a> component instead.</strong>
</p>
</section>
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/security-service.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/security-service.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/security-service.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/security-service.xml Wed May 2 09:36:24 2007
@@ -44,6 +44,10 @@
configuration details.
</p>
+<p>
+As of Turbine 2.3.3 the DBSecurityService is deprecated.
+</p>
+
</section>
<section name="Configuration">
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/template-service.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/template-service.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/template-service.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/template-service.xml Wed May 2 09:36:24 2007
@@ -32,6 +32,7 @@
<section name="Template Service">
<p>
+The Service for the mapping of templates to their screens and actions.
</p>
</section>
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/torque-security-schema.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/torque-security-schema.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/torque-security-schema.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/torque-security-schema.xml Wed May 2 09:36:24 2007
@@ -31,7 +31,7 @@
<section name="Overview">
<p>
This is the Turbine included schema for generating Torque Peers for
-the <a href="/services/torque-security-service.html">Torque Security Service</a>:
+the <a href="torque-security-service.html">Torque Security Service</a>:
</p>
<table>
<tr>
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/torque-security-service.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/torque-security-service.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/torque-security-service.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/torque-security-service.xml Wed May 2 09:36:24 2007
@@ -149,7 +149,7 @@
<section name="Turbine supplied table schema">
<p>
The Peers and objects supplied with the Torque Security Service were generated
-from a Torque Schema. Its definition is <a href="/services/torque-security-schema.html">shown here</a>.
+from a Torque Schema. Its definition is <a href="torque-security-schema.html">shown here</a>.
</p>
<p>
Turbine uses the following configuration for accessing the Torque
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/velocity-service.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/velocity-service.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/velocity-service.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/velocity-service.xml Wed May 2 09:36:24 2007
@@ -31,6 +31,11 @@
<section name="Velocity Service">
<p>
+The Velocity Service is used to process
+<a href="http://velocity.apache.org/engine/">Velocity</a> templates from within
+a Turbine Screen. It is used in conjunction with the
+<a href="template-service.html">Template Service</a> as a Templating Engine for
+templates ending in "vm".
</p>
</section>
@@ -67,7 +72,7 @@
services.VelocityService.template.extension = vm
services.VelocityService.default.page = VelocityPage
services.VelocityService.default.screen = VelocityScreen
-services.VelocityService.default.layout = VelocityECSLayout
+services.VelocityService.default.layout = VelocityOnlyLayout
services.VelocityService.default.navigation = VelocityNavigation
services.VelocityService.default.error.screen = VelocityErrorScreen
services.VelocityService.default.layout.template = Default.vm
@@ -96,6 +101,14 @@
</section>
<section name="Usage">
+
+<p>
+The Velocity Service registers itself as translation engine with the Template
+Service and it gets accessed from there. After configuring it in your properties,
+it should never be necessary to call methods from this service directly. Please
+refer to the <a href="../howto/context-howto.html">Velocity Context Howto</a>
+for details of how to use this service.
+</p>
</section>
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/xmlrpc-service.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/xmlrpc-service.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/xmlrpc-service.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/xmlrpc-service.xml Wed May 2 09:36:24 2007
@@ -33,9 +33,6 @@
<p>
The XML-RPC service is the easiest way to add distributed
computing and B2B capabilities to your Turbine web application.
- The current implementation is based on the Helma XML-RPC
- package which can be found <a href="http://classic.helma.at/hannes/xmlrpc/">
- here</a>.
</p>
<p>
Modified: jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/yaafi-component-service.xml
URL: http://svn.apache.org/viewvc/jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/yaafi-component-service.xml?view=diff&rev=534535&r1=534534&r2=534535
==============================================================================
--- jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/yaafi-component-service.xml (original)
+++ jakarta/turbine/core/branches/TURBINE_2_3_BRANCH/xdocs/services/yaafi-component-service.xml Wed May 2 09:36:24 2007
@@ -1,256 +1,236 @@
-<?xml version="1.0"?>
-
-<!--
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-<document>
-
- <properties>
- <title>Turbine Services - Yaafi Component Service</title>
- <author email="seade@backstagetech.com.au">Scott Eade</author>
- </properties>
-
-<body>
-
-<section name="Avalon Component Service">
-<p>
-The Yaafi Component service loads external modules which implement the
-<a href="http://avalon.apache.org/">Avalon</a> lifecycle interfaces. This is
-a bridge between the Turbine 2.3 we have today and the
-<a href="http://jakarta.apache.org/turbine/fulcrum/">Fulcrum</a> components
-that until now have only been available to Turbine 2.4 (yet to be released).
-</p>
-
-<p>
-Most of the Fulcrum components should work using this service, however it is
-only being added in Turbine 2.3.3, so you should ensure that you perform your
-own testing to verify the desired behaviour of your application, though note
-that the author is successfully running <a href="http://db.apache.org/torque/">
-Torque</a>,
-<a href="http://jakarta.apache.org/turbine/fulcrum/fulcrum-quartz/index.html">
-Fulcrum Quartz</a> as well as making use for Yaafi's
-<a href="http://jakarta.apache.org/turbine/fulcrum/fulcrum-yaafi/services/servicemanagerservice.html">
-ServiceManager</a> and
-<a href="http://jakarta.apache.org/turbine/fulcrum/fulcrum-yaafi/services/systempropertyservice.html">
-SystemProperty</a> services - all under Turbine 2.3.
-</p>
-
-</section>
-
-<section name="Dependencies">
-
-<p>
-If you are using Yaafi Component Service you will need to add Yaafi as a
-dependency (the following is from a Maven 2 POM):
-</p>
-<source><![CDATA[
- <dependency>
- <groupId>fulcrum</groupId>
- <artifactId>fulcrum-yaafi</artifactId>
- <version>1.0.4</version>
- <type>jar</type>
- <scope>compile</scope>
- </dependency>
-]]></source>
-
-<p>
-If you are no longer using the <a href="avalon-component-service.html">
-Avalon Component Service</a> you can stop your build from including the
-Excalibur dependencies thus (again from a Maven 2 POM):
-</p>
-<source><![CDATA[
- <!--
- The following four dependencies are for the Turbine AvalonComponentService.
- They are not needed when using Yaafi Component Service as a replacement.
- -->
- <dependency>
- <groupId>excalibur-component</groupId>
- <artifactId>excalibur-component</artifactId>
- <version>2.1</version>
- <type>jar</type>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>excalibur-instrument</groupId>
- <artifactId>excalibur-instrument-api</artifactId>
- <version>2.1</version>
- <type>jar</type>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>excalibur-logger</groupId>
- <artifactId>excalibur-logger</artifactId>
- <version>2.1</version>
- <type>jar</type>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>excalibur-pool</groupId>
- <artifactId>excalibur-pool-api</artifactId>
- <version>2.1</version>
- <type>jar</type>
- <scope>provided</scope>
- </dependency>
-]]></source>
-
-<p>
-If you accessing Torque via the Yaafi Component Service (as opposed to the now
-very old <a href="component-service.html">TurbineComponentService</a>) you also
-no longer need <a href="http://jakarta.apache.org/turbine/stratum/index.html">
-Stratum</a> (once more from a Maven 2 POM):
-</p>
-<source><![CDATA[
- <!--
- Stratum is a dependency of turbine, however it is only required when the
- TurbineComponentService is used.
- -->
- <dependency>
- <groupId>stratum</groupId>
- <artifactId>stratum</artifactId>
- <version>1.0</version>
- <type>jar</type>
- <scope>provided</scope>
- </dependency>
-]]></source>
-
-<p>
-The above is based on the
-<a href="http://repo1.maven.org/maven2/turbine/turbine/2.3.2/turbine-2.3.2.pom">
-turbine-2.3.2 pom</a> that exists in the default maven 2 repository. Whether or
-not you need the above will depend on how these dependencies are declared in the
-final version of the Turbine 2.3 POM (just including Yaafi should be enough if
-they are all declared as optional).
-</p>
-</section>
-
-<section name="Configuration">
-
-<source><![CDATA[
-# -------------------------------------------------------------------
-#
-# S E R V I C E S
-#
-# -------------------------------------------------------------------
-# Classes for Turbine Services should be defined here.
-# Format: services.[name].classname=[implementing class]
-#
-# To specify properties of a service use the following syntax:
-# service.[name].[property]=[value]
-
-services.YaafiComponentService.classname=org.apache.turbine.services.avaloncomponent.ACSYaafiComponentService
-services.YaafiComponentService.earlyInit=true
-...
-
-# -------------------------------------------------------------------
-#
-# Y A A F I C O M P O N E N T S E R V I C E
-#
-# -------------------------------------------------------------------
-# Components implementing the avalon lifecycle interfaces can be
-# loaded, configured and initialized by Turbine
-# -------------------------------------------------------------------
-
-services.YaafiComponentService.containerConfiguration = /WEB-INF/conf/containerConfiguration.xml
-]]></source>
-<p>
-In /WEB-INF/conf you should provide containerConfiguration.xml:
-</p>
-<source><![CDATA[
-<fulcrum-yaafi>
- <componentRoles>
- <location>/WEB-INF/conf/componentRoles.xml</location>
- </componentRoles>
- <componentConfiguration>
- <location>/WEB-INF/conf/componentConfiguration.xml</location>
- </componentConfiguration>
-</fulcrum-yaafi>
-]]></source>
-<p>
-componentRoles.xml:
-</p>
-<source><![CDATA[
-<role-list>
- <role name="org.apache.fulcrum.yaafi.service.servicemanager.ServiceManagerService"
- default-class="org.apache.fulcrum.yaafi.service.servicemanager.ServiceManagerServiceImpl"/>
- <role name="org.apache.fulcrum.yaafi.service.systemproperty.SystemPropertyService"
- shorthand="SystemPropertyService"
- default-class="org.apache.fulcrum.yaafi.service.systemproperty.SystemPropertyServiceImpl"
- early-init="true"/>
- <role name="org.apache.torque.avalon.Torque"
- shorthand="torque"
- default-class="org.apache.torque.avalon.TorqueComponent"/>
- <!-- Details of other components and services you want to use. -->
-</role-list>]]></source>
-<p>
-and componentConfiguration.xml:
-</p>
-<source><![CDATA[
-<componentConfig>
- <SystemPropertyService>
- <property name="my.property">my property value</property>
- </SystemPropertyService>
-
- <torque>
- <configfile>WEB-INF/conf/Torque.properties</configfile>
- </torque>
-
- <!-- Configuration for other components and services. -->
-</componentConfig>
-]]></source>
-<p>
-No changes to torque.properties are required.
-</p>
-<p>
-If all goes well you should see the following in your log file when Turbine
-starts up (actual output will depend on your logging configuration):
-</p>
-<source><![CDATA[
-...INFO...services.BaseServiceBroker - Added Mapping for Service: ACSYaafiComponentService
-...INFO...services.BaseServiceBroker - Start Initializing service (early): ACSYaafiComponentService
-...INFO...avaloncomponent.ACSYaafiComponentService - Initializing ACSYaafiComponentService ...
-...
-...DEBUG...avalon - Incarnating the service org.apache.fulcrum.yaafi.service.servicemanager.ServiceManagerService
-...
-...DEBUG...avalon - Incarnating the service SystemPropertyService
-...
-...DEBUG...avalon - Incarnating the service torque
-...INFO...avalon - YAAFI Avalon Service Container is up and running
-...INFO...services.BaseServiceBroker - Finish Initializing service (early): ACSYaafiComponentService
-]]></source>
-
-</section>
-
-<section name="Usage">
-
-<p>
-If you plan to use the decoupled Torque in your application, you should leave
-the Yaafi Component Service configured at all times. It is started at early
-startup time. See the
-<a href="http://jakarta.apache.org/turbine/fulcrum/fulcrum-yaafi/index.html">
-Yaafi documentation</a> for more information and for details of the various
-<a href="http://jakarta.apache.org/turbine/fulcrum/fulcrum-yaafi/services/index.html">
-services</a> that it provides and the
-<a href="http://jakarta.apache.org/turbine/fulcrum/">Fulcrum site</a> for
-details of the other components that are available.
-</p>
-</section>
-
-</body>
-
-</document>
+<?xml version="1.0"?>
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<document>
+
+ <properties>
+ <title>Turbine Services - Yaafi Component Service</title>
+ <author email="seade@backstagetech.com.au">Scott Eade</author>
+ </properties>
+
+<body>
+
+<section name="Avalon Component Service">
+<p>
+The Yaafi Component service loads external modules which implement the
+<a href="http://avalon.apache.org/">Avalon</a> lifecycle interfaces. This is
+a bridge between the Turbine 2.3 we have today and the
+<a href="http://jakarta.apache.org/turbine/fulcrum/">Fulcrum</a> components
+that until now have only been available to Turbine 2.4 (yet to be released).
+</p>
+
+<p>
+Most of the Fulcrum components should work using this service, however it is
+only being added in Turbine 2.3.3, so you should ensure that you perform your
+own testing to verify the desired behaviour of your application, though note
+that the author is successfully running <a href="http://db.apache.org/torque/">
+Torque</a>,
+<a href="http://jakarta.apache.org/turbine/fulcrum/fulcrum-quartz/index.html">
+Fulcrum Quartz</a> as well as making use for Yaafi's
+<a href="http://jakarta.apache.org/turbine/fulcrum/fulcrum-yaafi/services/servicemanagerservice.html">
+ServiceManager</a> and
+<a href="http://jakarta.apache.org/turbine/fulcrum/fulcrum-yaafi/services/systempropertyservice.html">
+SystemProperty</a> services - all under Turbine 2.3.
+</p>
+
+</section>
+
+<section name="Dependencies">
+
+<p>
+If you are using Yaafi Component Service you will need to add Yaafi as a
+dependency (the following is from a Maven 2 POM):
+</p>
+<source><![CDATA[
+ <dependency>
+ <groupId>fulcrum</groupId>
+ <artifactId>fulcrum-yaafi</artifactId>
+ <version>1.0.4</version>
+ <type>jar</type>
+ <scope>compile</scope>
+ </dependency>
+]]></source>
+
+<p>
+If you are no longer using the <a href="avalon-component-service.html">
+Avalon Component Service</a> you can stop your build from including the
+Excalibur dependencies thus (again from a Maven 2 POM):
+</p>
+<source><![CDATA[
+ <!--
+ The following four dependencies are for the Turbine AvalonComponentService.
+ They are not needed when using Yaafi Component Service as a replacement.
+ -->
+ <dependency>
+ <groupId>excalibur-component</groupId>
+ <artifactId>excalibur-component</artifactId>
+ <version>2.1</version>
+ <type>jar</type>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>excalibur-instrument</groupId>
+ <artifactId>excalibur-instrument-api</artifactId>
+ <version>2.1</version>
+ <type>jar</type>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>excalibur-logger</groupId>
+ <artifactId>excalibur-logger</artifactId>
+ <version>2.1</version>
+ <type>jar</type>
+ <scope>provided</scope>
+ </dependency>
+ <dependency>
+ <groupId>excalibur-pool</groupId>
+ <artifactId>excalibur-pool-api</artifactId>
+ <version>2.1</version>
+ <type>jar</type>
+ <scope>provided</scope>
+ </dependency>
+]]></source>
+
+<p>
+The above is based on the
+<a href="http://repo1.maven.org/maven2/turbine/turbine/2.3.2/turbine-2.3.2.pom">
+turbine-2.3.2 pom</a> that exists in the default maven 2 repository. Whether or
+not you need the above will depend on how these dependencies are declared in the
+final version of the Turbine 2.3 POM (just including Yaafi should be enough if
+they are all declared as optional).
+</p>
+</section>
+
+<section name="Configuration">
+
+<source><![CDATA[
+# -------------------------------------------------------------------
+#
+# S E R V I C E S
+#
+# -------------------------------------------------------------------
+# Classes for Turbine Services should be defined here.
+# Format: services.[name].classname=[implementing class]
+#
+# To specify properties of a service use the following syntax:
+# service.[name].[property]=[value]
+
+services.YaafiComponentService.classname=org.apache.turbine.services.avaloncomponent.ACSYaafiComponentService
+services.YaafiComponentService.earlyInit=true
+...
+
+# -------------------------------------------------------------------
+#
+# Y A A F I C O M P O N E N T S E R V I C E
+#
+# -------------------------------------------------------------------
+# Components implementing the avalon lifecycle interfaces can be
+# loaded, configured and initialized by Turbine
+# -------------------------------------------------------------------
+
+services.YaafiComponentService.containerConfiguration = /WEB-INF/conf/containerConfiguration.xml
+]]></source>
+<p>
+In /WEB-INF/conf you should provide containerConfiguration.xml:
+</p>
+<source><![CDATA[
+<fulcrum-yaafi>
+ <componentRoles>
+ <location>/WEB-INF/conf/componentRoles.xml</location>
+ </componentRoles>
+ <componentConfiguration>
+ <location>/WEB-INF/conf/componentConfiguration.xml</location>
+ </componentConfiguration>
+</fulcrum-yaafi>
+]]></source>
+<p>
+componentRoles.xml:
+</p>
+<source><![CDATA[
+<role-list>
+ <role name="org.apache.fulcrum.yaafi.service.servicemanager.ServiceManagerService"
+ default-class="org.apache.fulcrum.yaafi.service.servicemanager.ServiceManagerServiceImpl"/>
+ <role name="org.apache.fulcrum.yaafi.service.systemproperty.SystemPropertyService"
+ shorthand="SystemPropertyService"
+ default-class="org.apache.fulcrum.yaafi.service.systemproperty.SystemPropertyServiceImpl"
+ early-init="true"/>
+ <role name="org.apache.torque.avalon.Torque"
+ shorthand="torque"
+ default-class="org.apache.torque.avalon.TorqueComponent"/>
+ <!-- Details of other components and services you want to use. -->
+</role-list>]]></source>
+<p>
+and componentConfiguration.xml:
+</p>
+<source><![CDATA[
+<componentConfig>
+ <SystemPropertyService>
+ <property name="my.property">my property value</property>
+ </SystemPropertyService>
+
+ <torque>
+ <configfile>WEB-INF/conf/Torque.properties</configfile>
+ </torque>
+
+ <!-- Configuration for other components and services. -->
+</componentConfig>
+]]></source>
+<p>
+No changes to torque.properties are required.
+</p>
+<p>
+If all goes well you should see the following in your log file when Turbine
+starts up (actual output will depend on your logging configuration):
+</p>
+<source><![CDATA[
+...INFO...services.BaseServiceBroker - Added Mapping for Service: ACSYaafiComponentService
+...INFO...services.BaseServiceBroker - Start Initializing service (early): ACSYaafiComponentService
+...INFO...avaloncomponent.ACSYaafiComponentService - Initializing ACSYaafiComponentService ...
+...
+...DEBUG...avalon - Incarnating the service org.apache.fulcrum.yaafi.service.servicemanager.ServiceManagerService
+...
+...DEBUG...avalon - Incarnating the service SystemPropertyService
+...
+...DEBUG...avalon - Incarnating the service torque
+...INFO...avalon - YAAFI Avalon Service Container is up and running
+...INFO...services.BaseServiceBroker - Finish Initializing service (early): ACSYaafiComponentService
+]]></source>
+
+</section>
+
+<section name="Usage">
+
+<p>
+If you plan to use the decoupled Torque in your application, you should leave
+the Yaafi Component Service configured at all times. It is started at early
+startup time. See the
+<a href="http://jakarta.apache.org/turbine/fulcrum/fulcrum-yaafi/index.html">
+Yaafi documentation</a> for more information and for details of the various
+<a href="http://jakarta.apache.org/turbine/fulcrum/fulcrum-yaafi/services/index.html">
+services</a> that it provides and the
+<a href="http://jakarta.apache.org/turbine/fulcrum/">Fulcrum site</a> for
+details of the other components that are available.
+</p>
+</section>
+
+</body>
+
+</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: turbine-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: turbine-dev-help@jakarta.apache.org