You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by he...@apache.org on 2006/11/21 22:52:24 UTC
svn commit: r477914 [25/26] - in /jakarta/velocity/tools/trunk: ./ docs/
docs/generic/ docs/javadoc/ docs/javadoc/org/apache/velocity/tools/generic/
docs/javadoc/org/apache/velocity/tools/generic/log/
docs/javadoc/org/apache/velocity/tools/struts/ docs...
Modified: jakarta/velocity/tools/trunk/xdocs/site.dvsl
URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/xdocs/site.dvsl?view=diff&rev=477914&r1=477913&r2=477914
==============================================================================
--- jakarta/velocity/tools/trunk/xdocs/site.dvsl (original)
+++ jakarta/velocity/tools/trunk/xdocs/site.dvsl Tue Nov 21 13:52:11 2006
@@ -1,19 +1,19 @@
-## Copyright 2003-2004 The Apache Software Foundation.
-##
-## Licensed 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.
-##
-## $Id$
-
+## 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.
## DVSL style sheet for velocity-tools project
##
Modified: jakarta/velocity/tools/trunk/xdocs/struts/ActionMessagesTool.xml
URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/xdocs/struts/ActionMessagesTool.xml?view=diff&rev=477914&r1=477913&r2=477914
==============================================================================
--- jakarta/velocity/tools/trunk/xdocs/struts/ActionMessagesTool.xml (original)
+++ jakarta/velocity/tools/trunk/xdocs/struts/ActionMessagesTool.xml Tue Nov 21 13:52:11 2006
@@ -1,21 +1,24 @@
<?xml version="1.0"?>
-<!--
- Copyright 2004 The Apache Software Foundation.
-
- Licensed 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
+<!--
+ 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
- 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.
+ http://www.apache.org/licenses/LICENSE-2.0
- $Id$
+ 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>
Modified: jakarta/velocity/tools/trunk/xdocs/struts/ErrorsTool.xml
URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/xdocs/struts/ErrorsTool.xml?view=diff&rev=477914&r1=477913&r2=477914
==============================================================================
--- jakarta/velocity/tools/trunk/xdocs/struts/ErrorsTool.xml (original)
+++ jakarta/velocity/tools/trunk/xdocs/struts/ErrorsTool.xml Tue Nov 21 13:52:11 2006
@@ -1,21 +1,24 @@
<?xml version="1.0"?>
-<!--
- Copyright 2003-2004 The Apache Software Foundation.
-
- Licensed 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
+<!--
+ 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
- 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.
+ http://www.apache.org/licenses/LICENSE-2.0
- $Id$
+ 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>
Modified: jakarta/velocity/tools/trunk/xdocs/struts/FormTool.xml
URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/xdocs/struts/FormTool.xml?view=diff&rev=477914&r1=477913&r2=477914
==============================================================================
--- jakarta/velocity/tools/trunk/xdocs/struts/FormTool.xml (original)
+++ jakarta/velocity/tools/trunk/xdocs/struts/FormTool.xml Tue Nov 21 13:52:11 2006
@@ -1,21 +1,24 @@
<?xml version="1.0"?>
-<!--
- Copyright 2003-2005 The Apache Software Foundation.
-
- Licensed 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.
- $Id$
+<!--
+ 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>
@@ -31,12 +34,12 @@
<p>Struts has support to parse incoming HTTP requests and populate a Java bean
with the submitted request parameters. The same Java bean is used to populate
- forms with initial values. Additionally, a hook allows the application developer
- to include automatic form validation code.</p>
+ forms with initial values. Additionally, a hook allows the application developer
+ to include automatic form validation code.</p>
<p>FormTool provides miscellaneous methods to work with forms and form bean in
the context of Struts applications.</p>
-
+
<toolinfo>
<version>@@@version@@@, @@@date@@@</version>
<clazz>org.apache.velocity.tools.struts.FormTool</clazz>
@@ -55,29 +58,29 @@
<section name="getBean()">
<method name="getBean()">
-
+
<abstract>
Retrieve and return the form bean associated with this request.
</abstract>
-
+
<signature>
ActionForm getBean()
</signature>
-
+
<returns>
- The <code>ActionForm</code> associated with this request/session or
+ The <code>ActionForm</code> associated with this request/session or
<code>null</code> if there is no form bean associated with this mapping.
</returns>
-
+
<description>
- <p>This is a convenience method. The form bean is automatically
- available in the Velocity context under the name defined in the
- Struts configuration.</p>
-
- <p>If the form bean is used repeatedly, it is recommended to create a
+ <p>This is a convenience method. The form bean is automatically
+ available in the Velocity context under the name defined in the
+ Struts configuration.</p>
+
+ <p>If the form bean is used repeatedly, it is recommended to create a
local variable referencing the bean rather than calling getBean()
multiple times.</p>
-
+
<sourcecode>## Populating an input field with a default value
<input type="text" name="username" value="$form.getBean().username">
@@ -85,38 +88,38 @@
<input type="text" name="username" value="$form.bean.username">
## For repeated use create a local reference
-#set ($defaults = $form.bean)
+#set ($defaults = $form.bean)
<input type="text" name="username" value="$defaults.username">
## Accessing the form using the form name defined in struts-config.xml
## Velocity searches the request and session attributes for loginForm
<input type="text" name="username" value="$loginForm.username"></sourcecode>
</description>
-
+
</method>
</section>
<section name="getCancelName()">
<method name="getCancelName()">
-
+
<abstract>
- Returns the query parameter name under which a cancel button press
+ Returns the query parameter name under which a cancel button press
must be reported if form validation is to be skipped.
</abstract>
-
+
<signature>
String getCancelName()
</signature>
-
+
<returns>
The value of <code>org.apache.struts.taglib.html.Constants.CANCEL_PROPERTY</code>
</returns>
-
+
<description>
<p>If a request contains a request parameter with key equal to the return value
of this method, then automatic form validation is skipped. A typical application
case is to use this magic string for the name attribute of a cancel button in a form.
- If this button is pressed, automatic form validation is skipped. If automatic form
+ If this button is pressed, automatic form validation is skipped. If automatic form
validation is not used, this magic string is irrelevant.</p>
<sourcecode>## A cancel button
@@ -137,15 +140,15 @@
<section name="getName()">
<method name="getName()">
-
+
<abstract>
Returns the form bean name associated with this action mapping.
</abstract>
-
+
<signature>
String getName()
</signature>
-
+
<returns>
The name of the ActionForm associated with this request or
<code>null</code> if there is no form bean associated with this mapping.
@@ -156,21 +159,21 @@
<section name="getToken()">
<method name="getToken()">
-
+
<abstract>
Retrieves and returns the transaction control token for this session.
</abstract>
-
+
<signature>
String getToken()
</signature>
-
+
<returns>
The token <code>String</code> or <code>null</code> if no token exists.
</returns>
<see>
- Method <a href="#getTokenName()"><code>getTokenName()</code></a> for examples.
+ Method <a href="#getTokenName()"><code>getTokenName()</code></a> for examples.
</see>
</method>
@@ -178,28 +181,28 @@
<section name="getTokenName()">
<method name="getTokenName()">
-
+
<abstract>
Returns the query parameter name under which a transaction token
must be reported.
</abstract>
-
+
<signature>
int getTokenName()
</signature>
-
+
<returns>
The value of <code>org.apache.struts.taglib.html.Constants.TOKEN_KEY</code>
</returns>
<see>
<a href="http://jakarta.apache.org/struts/api/org/apache/struts/action/Action.html">
- JavaDoc of class <code>org.apache.struts.action.Action</code></a> for more information on the
+ JavaDoc of class <code>org.apache.struts.action.Action</code></a> for more information on the
transaction token mechanism (I don't know of any better documentation of this Struts
feature).
</see>
-
+
<description>
<sourcecode>## A hidden form field with the transaction token
<input type="hidden" name="$form.getTokenName()"
@@ -211,7 +214,7 @@
<p>This produces output similar to:</p>
-<sourcecode><input type="hidden" name="org.apache.struts.taglib.html.TOKEN"
+<sourcecode><input type="hidden" name="org.apache.struts.taglib.html.TOKEN"
value="84c29b4dea56ecf69524ef6b965c5e80"></sourcecode>
</description>
@@ -219,4 +222,4 @@
</section>
</body>
-</document>
\ No newline at end of file
+</document>
Modified: jakarta/velocity/tools/trunk/xdocs/struts/MessageTool.xml
URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/xdocs/struts/MessageTool.xml?view=diff&rev=477914&r1=477913&r2=477914
==============================================================================
--- jakarta/velocity/tools/trunk/xdocs/struts/MessageTool.xml (original)
+++ jakarta/velocity/tools/trunk/xdocs/struts/MessageTool.xml Tue Nov 21 13:52:11 2006
@@ -1,21 +1,24 @@
<?xml version="1.0"?>
-<!--
- Copyright 2003-2005 The Apache Software Foundation.
-
- Licensed 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
+<!--
+ 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
- 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.
+ http://www.apache.org/licenses/LICENSE-2.0
- $Id$
+ 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>
Modified: jakarta/velocity/tools/trunk/xdocs/struts/SecureLinkTool.xml
URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/xdocs/struts/SecureLinkTool.xml?view=diff&rev=477914&r1=477913&r2=477914
==============================================================================
--- jakarta/velocity/tools/trunk/xdocs/struts/SecureLinkTool.xml (original)
+++ jakarta/velocity/tools/trunk/xdocs/struts/SecureLinkTool.xml Tue Nov 21 13:52:11 2006
@@ -1,21 +1,24 @@
<?xml version="1.0"?>
-<!--
- Copyright 2004 The Apache Software Foundation.
-
- Licensed 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
+<!--
+ 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
- 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.
+ http://www.apache.org/licenses/LICENSE-2.0
- $Id: SecureLinkTool.xml,v 1.4 2004/02/18 20:22:36 nbubna Exp $
+ 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>
Modified: jakarta/velocity/tools/trunk/xdocs/struts/StrutsLinkTool.xml
URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/xdocs/struts/StrutsLinkTool.xml?view=diff&rev=477914&r1=477913&r2=477914
==============================================================================
--- jakarta/velocity/tools/trunk/xdocs/struts/StrutsLinkTool.xml (original)
+++ jakarta/velocity/tools/trunk/xdocs/struts/StrutsLinkTool.xml Tue Nov 21 13:52:11 2006
@@ -1,21 +1,24 @@
<?xml version="1.0"?>
-<!--
- Copyright 2003-2004 The Apache Software Foundation.
-
- Licensed 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.
-
- $Id: StrutsLinkTool.xml,v 1.2 2004/02/18 20:22:36 nbubna Exp $
+<!--
+ 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>
@@ -28,15 +31,15 @@
<section name="StrutsLinkTool Reference Documentation">
- <p>The StrutsLinkTool extends the standard
- <a href="../view/LinkTool.html">LinkTool</a> to add methods
+ <p>The StrutsLinkTool extends the standard
+ <a href="../view/LinkTool.html">LinkTool</a> to add methods
for working with Struts' Actions and Forwards:</p>
<ul>
<li>translate logical names (Struts forwards, actions ) to URI references, see
methods <a href="#setAction()">setAction()</a> and <a href="#setForward()">
setForward()</a></li>
</ul>
-
+
<toolinfo>
<version>@@@version@@@, @@@date@@@</version>
<clazz>org.apache.velocity.tools.struts.StrutsLinkTool</clazz>
@@ -56,29 +59,29 @@
<section name="setAction()">
<method name="setAction()">
-
+
<abstract>
Returns a copy of this StrutsLinkTool instance with the given action path
converted into a server-relative URI reference.
</abstract>
-
+
<signature>
StrutsLinkTool setAction(String action)
</signature>
-
+
<parameters>
<parameter name="action">
An action path as defined in struts-config.xml, e.g. <code>/logon</code>.
</parameter>
</parameters>
-
+
<returns>
- A new instance of <code>StrutsLinkTool</code>.
+ A new instance of <code>StrutsLinkTool</code>.
</returns>
-
+
<description>
- <p>The action name is translated into a server-relative URI reference. The method does
- not check if the specified action has been defined. It will overwrite any
+ <p>The action name is translated into a server-relative URI reference. The method does
+ not check if the specified action has been defined. It will overwrite any
previously set URI reference but will copy the query string.</p>
</description>
@@ -88,37 +91,37 @@
<p>Produces something like:</p>
<sourcecode><form name="form1" action="/myapp/demo.do"></sourcecode>
-
+
</method>
</section>
<section name="setForward()">
<method name="setForward()">
-
+
<abstract>
- Returns a copy of this StrutsLinkTool instance with the given global
+ Returns a copy of this StrutsLinkTool instance with the given global
forward name converted into a server-relative URI reference.
</abstract>
-
+
<signature>
StrutsLinkTool setForward(String forward)
</signature>
-
+
<parameters>
<parameter name="forward">
The name of a global forward as defined in struts-config.xml.
</parameter>
</parameters>
-
+
<returns>
- A new instance of <code>StrutsLinkTool</code> or <code>null</code> if the
+ A new instance of <code>StrutsLinkTool</code> or <code>null</code> if the
parameter does not map to a valid forward.
</returns>
-
+
<description>
- <p>The global forward name is translated into a server-relative
- URI reference. This method will overwrite any previously set URI
+ <p>The global forward name is translated into a server-relative
+ URI reference. This method will overwrite any previously set URI
reference but will copy the query string.</p>
</description>
@@ -130,7 +133,7 @@
<sourcecode><a href="/myapp/templates/index.vm?key=val+1">My Link</a></sourcecode>
-
+
</method>
</section>
Modified: jakarta/velocity/tools/trunk/xdocs/struts/StrutsTools.xml
URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/xdocs/struts/StrutsTools.xml?view=diff&rev=477914&r1=477913&r2=477914
==============================================================================
--- jakarta/velocity/tools/trunk/xdocs/struts/StrutsTools.xml (original)
+++ jakarta/velocity/tools/trunk/xdocs/struts/StrutsTools.xml Tue Nov 21 13:52:11 2006
@@ -1,21 +1,24 @@
<?xml version="1.0"?>
-<!--
- Copyright 2004 The Apache Software Foundation.
-
- Licensed 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
+<!--
+ 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
- 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.
+ http://www.apache.org/licenses/LICENSE-2.0
- $Id: StrutsTools.xml,v 1.5 2004/02/18 20:22:36 nbubna Exp $
+ 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>
Modified: jakarta/velocity/tools/trunk/xdocs/struts/TilesTool.xml
URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/xdocs/struts/TilesTool.xml?view=diff&rev=477914&r1=477913&r2=477914
==============================================================================
--- jakarta/velocity/tools/trunk/xdocs/struts/TilesTool.xml (original)
+++ jakarta/velocity/tools/trunk/xdocs/struts/TilesTool.xml Tue Nov 21 13:52:11 2006
@@ -1,21 +1,24 @@
<?xml version="1.0"?>
-<!--
- Copyright 2004 The Apache Software Foundation.
-
- Licensed 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
+<!--
+ 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
- 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.
+ http://www.apache.org/licenses/LICENSE-2.0
- $Id: TilesTool.xml,v 1.2 2004/02/20 13:36:33 marino Exp $
+ 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>
Modified: jakarta/velocity/tools/trunk/xdocs/struts/ValidatorTool.xml
URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/xdocs/struts/ValidatorTool.xml?view=diff&rev=477914&r1=477913&r2=477914
==============================================================================
--- jakarta/velocity/tools/trunk/xdocs/struts/ValidatorTool.xml (original)
+++ jakarta/velocity/tools/trunk/xdocs/struts/ValidatorTool.xml Tue Nov 21 13:52:11 2006
@@ -1,21 +1,24 @@
<?xml version="1.0"?>
-<!--
- Copyright 2004 The Apache Software Foundation.
-
- Licensed 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
+<!--
+ 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
- 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.
+ http://www.apache.org/licenses/LICENSE-2.0
- $Id: ValidatorTool.xml,v 1.2 2004/02/20 13:36:33 marino Exp $
+ 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>
Modified: jakarta/velocity/tools/trunk/xdocs/struts/index.xml
URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/xdocs/struts/index.xml?view=diff&rev=477914&r1=477913&r2=477914
==============================================================================
--- jakarta/velocity/tools/trunk/xdocs/struts/index.xml (original)
+++ jakarta/velocity/tools/trunk/xdocs/struts/index.xml Tue Nov 21 13:52:11 2006
@@ -1,110 +1,113 @@
<?xml version= "1.0"?>
-<!--
- Copyright 2003-2005 The Apache Software Foundation.
-
- Licensed 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.
-
- $Id$
+<!--
+ 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>Overview</title>
+ <title>Overview</title>
<author email="sidler@apache.org">Gabriel Sidler</author>
<author email="tcolson@cisco.com">Tim Colson</author>
<author email="nbubna@apache.org">Nathan Bubna</author>
<projectfile>xdocs/struts/menu.xml</projectfile>
</properties>
- <body>
+ <body>
- <section name="Overview">
+ <section name="Overview">
- <p>The VelocityStruts sub-project integrates Velocity with the
- <a href="http://struts.apache.org/">Apache Struts</a>
- web application framework and enables the use of Velocity templates
+ <p>The VelocityStruts sub-project integrates Velocity with the
+ <a href="http://struts.apache.org/">Apache Struts</a>
+ web application framework and enables the use of Velocity templates
interchangeably with JSP pages for the view layer.</p>
-
- <p>Various other
- <a href="http://wiki.apache.org/jakarta-velocity/PoweredByVelocity">web application frameworks</a>
- offer built-in support for Velocity templates. This project
- provides the minimal glue necessary to give Struts developers
+
+ <p>Various other
+ <a href="http://wiki.apache.org/jakarta-velocity/PoweredByVelocity">web application frameworks</a>
+ offer built-in support for Velocity templates. This project
+ provides the minimal glue necessary to give Struts developers
an alternative to JSP. </p>
-
+
<p><img src="../images/velstruts_diag1.png" border="0"/></p>
- <p><strong>Diagram 1.</strong> Comparison of JSP and Velocity for
- the view layer in a Struts application.</p>
+ <p><strong>Diagram 1.</strong> Comparison of JSP and Velocity for
+ the view layer in a Struts application.</p>
- <p>As we follow the typical Struts process flow in Diagram 1,
- notice how there is relatively little change except for the addition
- of Velocity. The velocity-struts.jar leverages a standalone Velocity
- servlet to process template files (specifically, the jar file is
- velocity-tools-x.x.jar) and uses some drop-in tools to provide
- transparent access to Struts specific objects (ex. message resources,
- form beans, errors, links). The action mapping file will simply contain
- ActionForwards that send control to a Velocity-based View layer instead
+ <p>As we follow the typical Struts process flow in Diagram 1,
+ notice how there is relatively little change except for the addition
+ of Velocity. The velocity-struts.jar leverages a standalone Velocity
+ servlet to process template files (specifically, the jar file is
+ velocity-tools-x.x.jar) and uses some drop-in tools to provide
+ transparent access to Struts specific objects (ex. message resources,
+ form beans, errors, links). The action mapping file will simply contain
+ ActionForwards that send control to a Velocity-based View layer instead
of sending to a JSP. </p>
- <p>Also notable is that Velocity and JSP are <strong>not</strong>
- mutually exclusive. Both technologies can be used in the same
- application without any problems. This allows developers the option
+ <p>Also notable is that Velocity and JSP are <strong>not</strong>
+ mutually exclusive. Both technologies can be used in the same
+ application without any problems. This allows developers the option
of trying Velocity without heavy modification to existing applications.</p>
<p>We're convinced that once you give Velocity a try, you'll really like it.</p>
</section>
-
+
<section name="Benefits">
- <p>There are many different reasons why people are choosing Velocity
+ <p>There are many different reasons why people are choosing Velocity
technology for the view layer. Here are some:</p>
<p>
<ul>
- <li>Velocity helps enforce a clean separation between the view
- layer and the model/control layers. This leads to clean application
- design and a clear separation of concerns between View Designers
+ <li>Velocity helps enforce a clean separation between the view
+ layer and the model/control layers. This leads to clean application
+ design and a clear separation of concerns between View Designers
and back-end Developers.</li>
<li><a href="http://jakarta.apache.org/velocity/vtl-reference-guide.html">Velocity Template Language (VTL)</a>
- has few directives and is simple and easy to learn. Most
+ has few directives and is simple and easy to learn. Most
people report being productive within a day.</li>
- <li>Velocity is easy to extend with <i>Tools</i> which are simply
+ <li>Velocity is easy to extend with <i>Tools</i> which are simply
any class which has public methods. These are typically much cleaner
and easier to develop than JSP custom tag libraries.</li>
-
+
<li>Using the new TilesTool it is now possible
to mix Velocity and JSP tiles in the same page/layout. For those
using Tiles, this makes gradual migration between or integration of
the two view technologies trivially easy!</li>
- <li>Velocity 'macros' are a powerful tool for the View Designer.
- They enable the creation of reusable snippets of markup, often
- eliminating what would have been a need to develop a custom tag
+ <li>Velocity 'macros' are a powerful tool for the View Designer.
+ They enable the creation of reusable snippets of markup, often
+ eliminating what would have been a need to develop a custom tag
library or other server-side tool.</li>
- <li>Velocity templates are <strong>not</strong> limited to HTML
- and can be used to produce any type of text output including XML,
+ <li>Velocity templates are <strong>not</strong> limited to HTML
+ and can be used to produce any type of text output including XML,
SQL, ASCII, PostScript, etc.</li>
- <li>Velocity enables easy access to dynamic data
+ <li>Velocity enables easy access to dynamic data
that Web Designers can understand.</li>
- <li>Velocity being interpreted, enables a simple development cycle
+ <li>Velocity being interpreted, enables a simple development cycle
where template errors can quickly be localized and debugged.</li>
- <li>Velocity, which caches templates for speed, has been reported
+ <li>Velocity, which caches templates for speed, has been reported
to have performance comparable or better than JSP.</li>
- <li>Velocity is <strong>supported</strong> by an active and helpful
+ <li>Velocity is <strong>supported</strong> by an active and helpful
community of users and developers.</li>
</ul>
</p>
@@ -122,14 +125,14 @@
<p>"<i>One of the nicest things it enforces is the separation of presentation
layer and business logic. It removes the desire to 'fix' problems by
just putting a small change into the JSP via scriptlets. It also makes
- the code a <strong>lot</strong> more readable which also reduces the
+ the code a <strong>lot</strong> more readable which also reduces the
development time.</i>"</p>
- <p>"<i>Struts is a solid framework and Velocity makes it
- even better.</i>"</p>
- <p>"<i>I find that the Velocity Tools for Struts works as well, or better, with
- Struts than another other presentation technology, bar none. In fact,
- most of the tools work just as well with any other framework you might
- care to name.</i>"
+ <p>"<i>Struts is a solid framework and Velocity makes it
+ even better.</i>"</p>
+ <p>"<i>I find that the Velocity Tools for Struts works as well, or better, with
+ Struts than another other presentation technology, bar none. In fact,
+ most of the tools work just as well with any other framework you might
+ care to name.</i>"
--<a href="http://marc.theaimsgroup.com/?l=velocity-user&m=106520662105461&w=25">Ted Husted</a>
(author of <a href="http://husted.com/struts/book.html">Struts in Action</a>)</p>
</blockquote>
@@ -137,7 +140,7 @@
</section>
<section name="License">
- <p>This software is licensed under the
+ <p>This software is licensed under the
<a href="http://jakarta.apache.org/velocity/license.html">Apache Software License 2.0</a></p>
</section>
</body>
Modified: jakarta/velocity/tools/trunk/xdocs/struts/menu.xml
URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/xdocs/struts/menu.xml?view=diff&rev=477914&r1=477913&r2=477914
==============================================================================
--- jakarta/velocity/tools/trunk/xdocs/struts/menu.xml (original)
+++ jakarta/velocity/tools/trunk/xdocs/struts/menu.xml Tue Nov 21 13:52:11 2006
@@ -1,21 +1,24 @@
<?xml version="1.0"?>
-<!--
- Copyright 2003-2005 The Apache Software Foundation.
-
- Licensed 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
+<!--
+ 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
- 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.
+ http://www.apache.org/licenses/LICENSE-2.0
- $Id$
+ 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.
-->
+
<project href="index.html">
<title>VelocityStruts</title>
Modified: jakarta/velocity/tools/trunk/xdocs/struts/userguide.xml
URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/xdocs/struts/userguide.xml?view=diff&rev=477914&r1=477913&r2=477914
==============================================================================
--- jakarta/velocity/tools/trunk/xdocs/struts/userguide.xml (original)
+++ jakarta/velocity/tools/trunk/xdocs/struts/userguide.xml Tue Nov 21 13:52:11 2006
@@ -1,21 +1,24 @@
<?xml version="1.0"?>
-<!--
- Copyright 2003-2005 The Apache Software Foundation.
-
- Licensed 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.
-
- $Id$
+<!--
+ 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>
@@ -327,7 +330,7 @@
</p>
<p>There is a heirarchy to the objects exposed to the template designer.
- For instance, if you have set an attribute "foo" in both the session and
+ For instance, if you have set an attribute "foo" in both the session and
the request,</p>
<sourcecode>request.setAttribute("foo", "request foo");
session.setAttribute("foo", "session foo");</sourcecode>
Modified: jakarta/velocity/tools/trunk/xdocs/toolbox.props
URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/xdocs/toolbox.props?view=diff&rev=477914&r1=477913&r2=477914
==============================================================================
--- jakarta/velocity/tools/trunk/xdocs/toolbox.props (original)
+++ jakarta/velocity/tools/trunk/xdocs/toolbox.props Tue Nov 21 13:52:11 2006
@@ -1,2 +1,18 @@
+# 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.
toolbox.contextname = toolbox
-toolbox.string.mystring = Hello there!
\ No newline at end of file
+toolbox.string.mystring = Hello there!
Modified: jakarta/velocity/tools/trunk/xdocs/view/CookieTool.xml
URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/xdocs/view/CookieTool.xml?view=diff&rev=477914&r1=477913&r2=477914
==============================================================================
--- jakarta/velocity/tools/trunk/xdocs/view/CookieTool.xml (original)
+++ jakarta/velocity/tools/trunk/xdocs/view/CookieTool.xml Tue Nov 21 13:52:11 2006
@@ -1,5 +1,24 @@
<?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>
Modified: jakarta/velocity/tools/trunk/xdocs/view/ImportTool.xml
URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/xdocs/view/ImportTool.xml?view=diff&rev=477914&r1=477913&r2=477914
==============================================================================
--- jakarta/velocity/tools/trunk/xdocs/view/ImportTool.xml (original)
+++ jakarta/velocity/tools/trunk/xdocs/view/ImportTool.xml Tue Nov 21 13:52:11 2006
@@ -1,5 +1,24 @@
<?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>
Modified: jakarta/velocity/tools/trunk/xdocs/view/LinkTool.xml
URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/xdocs/view/LinkTool.xml?view=diff&rev=477914&r1=477913&r2=477914
==============================================================================
--- jakarta/velocity/tools/trunk/xdocs/view/LinkTool.xml (original)
+++ jakarta/velocity/tools/trunk/xdocs/view/LinkTool.xml Tue Nov 21 13:52:11 2006
@@ -1,21 +1,24 @@
<?xml version="1.0"?>
-<!--
- Copyright 2003 The Apache Software Foundation.
-
- Licensed 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.
-
- $Id: LinkTool.xml,v 1.5 2004/02/18 20:21:49 nbubna Exp $
+<!--
+ 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>
@@ -40,35 +43,35 @@
setAnchor()</a></li>
<li>encode session ID into URL, see method <a href="#toString()">toString()</a></li>
<li>retrieve server, port and path info for the current request, see methods
- <a href="#getURI()">getURI()</a>, <a href="#getContextURL()">getContextURL()</a>,
- <a href="#getContextPath()">getContextPath()</a> and
+ <a href="#getURI()">getURI()</a>, <a href="#getContextURL()">getContextURL()</a>,
+ <a href="#getContextPath()">getContextPath()</a> and
<a href="#getBaseRef()">getBaseRef()</a></li>
</ul>
<p>The LinkTool is somewhat special in that many of its methods return
a new instance of LinkTool. This facilitates greatly the repeated use
- of the LinkTool in Velocity and leads to an elegant syntax.</p>
+ of the LinkTool in Velocity and leads to an elegant syntax.</p>
<p>I've been struggling a bit to find the right terminology for the things
- that this tool works with. Based on document
+ that this tool works with. Based on document
<a href="http://www.w3.org/Architecture/Terms">http://www.w3.org/Architecture/Terms</a>,
I have used:</p>
-
+
<dl>
<dt>URI</dt>
<dd>To refer to the full, absolute address of web resources, e.g. static documents
- or abstract resources like dynamically generated content.
+ or abstract resources like dynamically generated content.
Example: <code>http://myserver.org/myapp/templates/index.html</code></dd>
<dt>URI Reference</dt>
- <dd>To refer to partial and relative URIs that reference a URI. Example:
+ <dd>To refer to partial and relative URIs that reference a URI. Example:
<code>templates/index.html</code>. </dd>
<dt>URL</dt>
<dd>Not used here.</dd>
</dl>
-
+
<toolinfo>
<version>@@@version@@@, @@@date@@@</version>
<clazz>org.apache.velocity.tools.view.tools.LinkTool</clazz>
@@ -89,35 +92,35 @@
<section name="setURI()">
<method name="setURI()">
-
+
<abstract>
Returns a copy of this LinkTool instance with the given URI reference.
</abstract>
-
+
<signature>
LinkTool setURI(String uri)
</signature>
-
+
<parameters>
<parameter name="uri">
- URI reference to set. The URI reference can be absolute
+ URI reference to set. The URI reference can be absolute
(<code>http://www.mydomain.com/myapp/templates/index.html</code>),
- server-relative (<code>/myapp/templates/index.html</code>),
- relative (<code>templates/index.html</code>)
+ server-relative (<code>/myapp/templates/index.html</code>),
+ relative (<code>templates/index.html</code>)
and may contain query strings (<code>templates/index.html?key1=value1&key2=value2</code>).
</parameter>
</parameters>
-
+
<returns>
- A new instance of <code>LinkTool</code>.
+ A new instance of <code>LinkTool</code>.
</returns>
-
+
<description>
- <p>No conversions are applied to the given URI reference. This method will
- overwrite any previously set URI reference but will copy query
+ <p>No conversions are applied to the given URI reference. This method will
+ overwrite any previously set URI reference but will copy query
data set with method <code>setQueryData()</code>.</p>
</description>
-
+
<sourcecode>## a relative reference
$link.setURI("index.html").addQueryData("key1","val 1")
@@ -136,7 +139,7 @@
<p>This produces:</p>
<sourcecode>index.vm/key1=val+1
-
+
/myapp/index.vm/key1=val+1
http://myserver.org/myapp/index.vm?key1=val+1
@@ -148,31 +151,31 @@
<section name="setRelative()">
<method name="setRelative()">
-
+
<abstract>
Returns a copy of this LinkTool instance with the specified context-relative
URI reference converted to a server-relative URI reference.
</abstract>
-
+
<signature>
LinkTool setRelative(String uri)
</signature>
-
+
<parameters>
<parameter name="uri">
A context-relative URI reference, i.e. a URI reference that is relative to the URI
used to address this web application.
</parameter>
</parameters>
-
+
<returns>
- A new instance of <code>LinkTool</code>.
+ A new instance of <code>LinkTool</code>.
</returns>
-
+
<description>
<p>The specified context-relative URI reference is converted to a server-relative URI reference.
This method will overwrite any previously set URI reference but will copy the query string.</p>
-
+
<sourcecode>
## a context-relative hyperlink
<a href="$link.setRelative("templates/index.vm").addQueryData("key1","val 1")">My Link</a>
@@ -181,109 +184,109 @@
<p>Produces something like:</p>
<sourcecode><a href="/myapp/templates/index.vm?key=val+1">My Link</a></sourcecode>
-
+
</description>
-
+
</method>
</section>
<section name="addQueryData()">
<method name="addQueryData()">
-
+
<abstract>
Adds a key=value pair to the URI reference.
</abstract>
-
+
<signature>
LinkTool addQueryData(String key, Object value)
</signature>
-
+
<parameters>
<parameter name="key">
Key (name) of query parameter.
</parameter>
<parameter name="value">
- Value of the query parameter. The string representation of this object is
+ Value of the query parameter. The string representation of this object is
added to the query data.
</parameter>
</parameters>
-
+
<returns>
- A new instance of <code>LinkTool</code>.
+ A new instance of <code>LinkTool</code>.
</returns>
-
+
<description>
- <p>Adds a key=value pair to the query data. This returns a new LinkTool
+ <p>Adds a key=value pair to the query data. This returns a new LinkTool
containing both a copy of this LinkTool's query data and the new data.
This makes repeated use in Velocity templates easy. Query data is
URL-encoded before it is appended.</p>
-
+
<p>See <a href="#setURI()">method setURI()</a> for examples.</p>
</description>
-
+
</method>
</section>
<section name="setAnchor()">
<method name="setAnchor()">
-
+
<abstract>
Sets an internal document reference to append to this link (e.g. #foo).
</abstract>
-
+
<signature>
LinkTool setAnchor(String anchor)
</signature>
-
+
<parameters>
<parameter name="anchor">
The internal document reference to append to this link
</parameter>
</parameters>
-
+
<returns>
- A new instance of <code>LinkTool</code>.
+ A new instance of <code>LinkTool</code>.
</returns>
-
+
<description>
- <p>Returns a copy of the link with the specified anchor to be
- added to the end of the generated hyperlink. This returns a new LinkTool
+ <p>Returns a copy of the link with the specified anchor to be
+ added to the end of the generated hyperlink. This returns a new LinkTool
containing both a copy of this LinkTool's data and the new anchor value.
This makes repeated use in Velocity templates easy. The anchor value
is url encoded before being rendered.</p>
</description>
-
+
</method>
</section>
<section name="getURI()">
<method name="getURI()">
-
+
<abstract>
Returns the current URI reference.
</abstract>
-
+
<signature>
LinkTool getURI()
</signature>
-
+
<returns>
- Returns the current URI reference as set by one of the methods
- setURI() or setRelative(). Any conversions
+ Returns the current URI reference as set by one of the methods
+ setURI() or setRelative(). Any conversions
have been applied. The returned URI reference does not included query data that was
added with method addQueryData().
</returns>
-
+
<see>
Method <a href="#getQueryData()"><code>getQueryData()</code></a> to retrieve
- query data only. Method <a href="#toString()"><code>toString()</code></a> to
+ query data only. Method <a href="#toString()"><code>toString()</code></a> to
retrieve the URI reference including all query data.
</see>
-
+
<description>
<sourcecode>#set ($l = $link.setForward("start").addQueryData("key1","val 1"))
<a href="$l.getURI()">My Link</a></sourcecode>
@@ -299,17 +302,17 @@
<section name="getQueryData()">
<method name="getQueryData()">
-
+
<abstract>
Returns this instance's query data.
</abstract>
-
+
<signature>
String getQueryData()
</signature>
-
+
<returns>
- This instance's query data as set by the method
+ This instance's query data as set by the method
<a href="#setQueryData()"><code>setQueryData()</code></a>. The
returned String is URL-encoded, e.g. "key=value&foo=this+is+encoded".
</returns>
@@ -322,7 +325,7 @@
<sourcecode>key1=val+1</sourcecode>
</description>
-
+
</method>
</section>
@@ -330,22 +333,22 @@
<section name="getContextURL()">
<method name="getContextURL()">
-
+
<abstract>
Returns the URI that addresses this web application.
</abstract>
-
+
<signature>
String getContextURL()
</signature>
-
+
<returns>
- Returns the URI reference that addresses this web application, e.g.
+ Returns the URI reference that addresses this web application, e.g.
"http://myserver.net/myapp". This string does not end with a "/".
</returns>
-
+
<description>
- <p>Note! This will not represent the URI reference or
+ <p>Note! This will not represent the URI reference or
query data set for this LinkTool instance.</p>
<sourcecode>$link.getContextURL()</sourcecode>
@@ -355,7 +358,7 @@
<sourcecode>http://myserver.net/myapp</sourcecode>
</description>
-
+
</method>
</section>
@@ -363,23 +366,23 @@
<section name="getContextPath()">
<method name="getContextPath()">
-
+
<abstract>
Returns the context path that addresses this web application.
</abstract>
-
+
<signature>
String getContextPath()
</signature>
-
+
<returns>
- The context path that addresses this web application, e.g.
- <code>"/myapp"</code>. This string starts with a "/" but does
+ The context path that addresses this web application, e.g.
+ <code>"/myapp"</code>. This string starts with a "/" but does
not end with a "/".
</returns>
-
+
<description>
- <p> Note! This will not represent the URI reference or query
+ <p> Note! This will not represent the URI reference or query
data set for this LinkTool instance.</p>
<sourcecode>$link.getContextPath()</sourcecode>
@@ -389,7 +392,7 @@
<sourcecode>/myapp</sourcecode>
</description>
-
+
</method>
</section>
@@ -397,23 +400,23 @@
<section name="getBaseRef()">
<method name="getBaseRef()">
-
+
<abstract>
Returns the full URI of this template.
</abstract>
-
+
<signature>
String getBaseRef()
</signature>
-
+
<returns>
The full URI of this template without any query data.
e.g. <code>http://myserver.net/myapp/templates/View.vm</code>.
</returns>
-
+
<description>
- <p>Note! The returned String will not represent the URI reference or query
- data set for this LinkTool instance. A typical application of this method
+ <p>Note! The returned String will not represent the URI reference or query
+ data set for this LinkTool instance. A typical application of this method
is with the HTML base tag.</p>
<sourcecode>## a base tag
@@ -424,7 +427,7 @@
<sourcecode><base href="http://myserver.net/myapp/templates/index.vm"></sourcecode>
</description>
-
+
</method>
</section>
@@ -433,24 +436,24 @@
<section name="toString()">
<method name="toString()">
-
+
<abstract>
Returns the full URI that has been constructed. The session ID
is encoded into the URL if cookies are not supported by the web client.
</abstract>
-
+
<signature>
String toString()
</signature>
-
+
<returns>
The full URI that has been built with this tool
e.g. <code>/myapp/stuff/View.vm?id=42&type=blue#foobar</code>.
</returns>
-
+
<description>
<p>Typically it is not necessary to call this method explicitly.
- Velocity will call the toString() method automatically to
+ Velocity will call the toString() method automatically to
obtain a representable version of objects.</p>
<sourcecode><a href="$link.setRelative("demo").addQueryString("key1", "val 1")">
@@ -460,8 +463,8 @@
<sourcecode><a href="/myapp/demo.do?key1=val+1">My Link</a></sourcecode>
-<p>If sessions are used and the web client does not support cookies, the
-<code>toString()</code> method automatically encodes the session ID into the
+<p>If sessions are used and the web client does not support cookies, the
+<code>toString()</code> method automatically encodes the session ID into the
returned URI. The above example would then produce something like: </p>
<sourcecode><a href="/myapp/demo.do;jsessionid=aaaaaaanisPWVYEY01?key1=val+1">
@@ -475,24 +478,24 @@
<p>URI encoding is about encoding the session ID into the URI string. This
section briefly explains the reasoning behind it and how it works.</p>
-<p>Many web applications use sessions to associate an application state
+<p>Many web applications use sessions to associate an application state
with a particualar user. For example, a session might be used to maintain
the state of a shopping cart while the user is browsing the online shop.</p>
-<p>The Servlet API has forseen two mechanisms to identify HTTP requests that
+<p>The Servlet API has forseen two mechanisms to identify HTTP requests that
belong to a particular session.</p>
<ul>
<li><strong>Cookies</strong>: A new cookie containing the session ID is sent
- to the client at the beginning of a session. The client returns this cookie
- with every request.</li>
+ to the client at the beginning of a session. The client returns this cookie
+ with every request.</li>
<li><strong>URI Encoding</strong>: The session ID is encoded into the
URI string. The server parses the URI of requests to detect the presence
of an encoded session ID.</li>
</ul>
-<p>Most developers prefer to use cookies to identify sessions. The cookie-based
-mechanism is easier to work with because it does not require the
+<p>Most developers prefer to use cookies to identify sessions. The cookie-based
+mechanism is easier to work with because it does not require the
encoding of every URI. However,
for reasons of security and privacy some users choose to disable cookie
support in their browsers. If session management relies on cookies only,
@@ -514,7 +517,7 @@
Therefore, if all URIs within an application are produced with the LinkTool, the application
is able to work properly with or without cookie support of the client.</p>
-<p>The following examples show the output of the <code>toString()</code> method if
+<p>The following examples show the output of the <code>toString()</code> method if
cookies are enabled and disabled.</p>
<sourcecode><a href="$link.setURI("MyPage.vm").addQueryData("key1","val 1")">
@@ -535,11 +538,11 @@
<sourcecode><a href="MyPage.vm;jsessionid=E9833012F7B2F8570963B137?key1=val+1">
My Link</a>
-<form name="MyForm" method="post"
+<form name="MyForm" method="post"
action="MyPage.vm;jsessionid=E9833012F7B20857096F37743B137"></sourcecode>
</description>
-
+
</method>
</section>
Modified: jakarta/velocity/tools/trunk/xdocs/view/ParameterParser.xml
URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/xdocs/view/ParameterParser.xml?view=diff&rev=477914&r1=477913&r2=477914
==============================================================================
--- jakarta/velocity/tools/trunk/xdocs/view/ParameterParser.xml (original)
+++ jakarta/velocity/tools/trunk/xdocs/view/ParameterParser.xml Tue Nov 21 13:52:11 2006
@@ -1,21 +1,24 @@
<?xml version="1.0"?>
-<!--
- Copyright 2003-2005 The Apache Software Foundation.
-
- Licensed 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.
-
- $Id$
+<!--
+ 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>
@@ -29,7 +32,7 @@
<section name="ParameterParser Reference Documentation">
<p>View tool for easy parsing of ServletRequest parameters.</p>
-
+
<toolinfo>
<version>@@@version@@@, @@@date@@@</version>
@@ -53,65 +56,65 @@
<section name="exists()">
<method name="exists()">
-
+
<abstract>
Returns <code>true</code> if a parameter for the specified key exists.
</abstract>
-
+
<signature>
boolean exists(String key)
</signature>
-
+
<parameters>
<parameter name="key">
The key of the parameter in question
</parameter>
</parameters>
-
+
<returns>
<code>true</code> if a parameter for the specified key exists or
<code>false</code> if this parameter is not present or has no value.
</returns>
-
+
</method>
</section>
<section name="getString()">
<method name="getString()">
-
+
<abstract>
Returns the specified servlet request parameter as a String
</abstract>
-
+
<signature>
String get(String key)
</signature>
-
+
<signature>
String getString(String key)
</signature>
-
+
<signature>
String getString(String key, String alternate)
</signature>
-
+
<parameters>
<parameter name="key">
The key of the desired string parameter
</parameter>
-
+
<parameter name="alternate">
An alternate value
</parameter>
</parameters>
-
+
<returns>
- The value of the parameter matching the specified key or the
+ The value of the parameter matching the specified key or the
specified alternate String if there is no matching parameter.
A value of <code>null</code> is returned if no alternate value
is defined and the desired parameter is not found.
</returns>
-
+
</method>
</section>
@@ -119,20 +122,20 @@
<section name="getBoolean()">
<method name="getBoolean()">
-
+
<abstract>
Returns the specified servlet request parameter as a Boolean object or
a boolean primitive type
</abstract>
-
+
<signature>
Boolean getBoolean(String key)
</signature>
-
+
<signature>
Boolean getBoolean(String key, Boolean alternate)
</signature>
-
+
<signature>
boolean getBoolean(String key, boolean alternate)
</signature>
@@ -141,20 +144,20 @@
<parameter name="key">
The key of the desired string parameter
</parameter>
-
+
<parameter name="alternate">
An alternate value
</parameter>
</parameters>
-
+
<returns>
- A Boolean object or boolean primitive type that represents the
- value of the servlet request parameter matching the specified key
+ A Boolean object or boolean primitive type that represents the
+ value of the servlet request parameter matching the specified key
or the specified alternate boolean if there is no matching parameter.
A value of <code>null</code> is returned if no alternate value
is defined and the desired parameter is not found.
</returns>
-
+
</method>
</section>
@@ -163,15 +166,15 @@
<section name="getNumber()">
<method name="getNumber()">
-
+
<abstract>
Returns the specified servlet request parameter as a Number object
</abstract>
-
+
<signature>
Number getNumber(String key)
</signature>
-
+
<signature>
Number getNumber(String key, Number alternate)
</signature>
@@ -180,20 +183,20 @@
<parameter name="key">
The key of the desired string parameter
</parameter>
-
+
<parameter name="alternate">
An alternate value
</parameter>
</parameters>
-
+
<returns>
- A <code>java.lang.Number</code> object that represents the
- value of the servlet request parameter matching the specified key
+ A <code>java.lang.Number</code> object that represents the
+ value of the servlet request parameter matching the specified key
or the specified alternate Number if there is no matching parameter.
A value of <code>null</code> is returned if no alternate value
is defined and the desired parameter is not found.
</returns>
-
+
</method>
</section>
@@ -201,11 +204,11 @@
<section name="getInt()">
<method name="getInt()">
-
+
<abstract>
Returns the specified servlet request parameter as an integer
</abstract>
-
+
<signature>
int getInt(String key, int alternate)
</signature>
@@ -214,18 +217,18 @@
<parameter name="key">
The key of the desired string parameter
</parameter>
-
+
<parameter name="alternate">
An alternate value
</parameter>
</parameters>
-
+
<returns>
- An integer that represents the
- value of the servlet request parameter matching the specified key
+ An integer that represents the
+ value of the servlet request parameter matching the specified key
or the specified alternate value if there is no matching parameter.
</returns>
-
+
</method>
</section>
@@ -234,11 +237,11 @@
<section name="getDouble()">
<method name="getDouble()">
-
+
<abstract>
Returns the specified servlet request parameter as a double
</abstract>
-
+
<signature>
double getDouble(String key, double alternate)
</signature>
@@ -247,18 +250,18 @@
<parameter name="key">
The key of the desired string parameter
</parameter>
-
+
<parameter name="alternate">
An alternate value
</parameter>
</parameters>
-
+
<returns>
- An double that represents the
- value of the servlet request parameter matching the specified key
+ An double that represents the
+ value of the servlet request parameter matching the specified key
or the specified alternate value if there is no matching parameter.
</returns>
-
+
</method>
</section>
@@ -266,29 +269,29 @@
<section name="getStrings()">
<method name="getStrings()">
-
+
<abstract>
- Returns an array of Strings of all the values of the specified servlet
+ Returns an array of Strings of all the values of the specified servlet
request parameter
</abstract>
-
+
<signature>
String[] getStrings(String key)
</signature>
-
+
<parameters>
<parameter name="key">
The key of the desired string parameter
</parameter>
-
+
</parameters>
-
+
<returns>
A array of Strings that represent all the values of the desired
request parameter or <code>null</code> if the parameter does not
exist.
</returns>
-
+
</method>
</section>
@@ -297,29 +300,29 @@
<section name="getBooleans()">
<method name="getBooleans()">
-
+
<abstract>
- Returns an array of Booleans of all the values of the specified servlet
+ Returns an array of Booleans of all the values of the specified servlet
request parameter
</abstract>
-
+
<signature>
Boolean[] getBooleans(String key)
</signature>
-
+
<parameters>
<parameter name="key">
The key of the desired string parameter
</parameter>
-
+
</parameters>
-
+
<returns>
- A array of <code>java.lang.Boolean</code> that represent all the
- values of the desired request parameter or <code>null</code> if
+ A array of <code>java.lang.Boolean</code> that represent all the
+ values of the desired request parameter or <code>null</code> if
the parameter does not exist.
</returns>
-
+
</method>
</section>
@@ -328,29 +331,29 @@
<section name="getNumbers()">
<method name="getNumbers()">
-
+
<abstract>
- Returns an array of Numbers of all the values of the specified servlet
+ Returns an array of Numbers of all the values of the specified servlet
request parameter
</abstract>
-
+
<signature>
Number[] getNumbers(String key)
</signature>
-
+
<parameters>
<parameter name="key">
The key of the desired string parameter
</parameter>
-
+
</parameters>
-
+
<returns>
- A array of <code>java.lang.Number</code> that represent all the
- values of the desired request parameter or <code>null</code> if
+ A array of <code>java.lang.Number</code> that represent all the
+ values of the desired request parameter or <code>null</code> if
the parameter does not exist.
</returns>
-
+
</method>
</section>
@@ -359,29 +362,29 @@
<section name="getInts()">
<method name="getInts()">
-
+
<abstract>
- Returns an array of integers of all the values of the specified servlet
+ Returns an array of integers of all the values of the specified servlet
request parameter
</abstract>
-
+
<signature>
int[] getInts(String key)
</signature>
-
+
<parameters>
<parameter name="key">
The key of the desired string parameter
</parameter>
-
+
</parameters>
-
+
<returns>
- A array of integer primitive types that represent all the
- values of the desired request parameter or <code>null</code> if
+ A array of integer primitive types that represent all the
+ values of the desired request parameter or <code>null</code> if
the parameter does not exist.
</returns>
-
+
</method>
</section>
@@ -390,29 +393,29 @@
<section name="getDoubles()">
<method name="getDoubles()">
-
+
<abstract>
- Returns an array of doubles of all the values of the specified servlet
+ Returns an array of doubles of all the values of the specified servlet
request parameter
</abstract>
-
+
<signature>
double[] getDoubles(String key)
</signature>
-
+
<parameters>
<parameter name="key">
The key of the desired string parameter
</parameter>
-
+
</parameters>
-
+
<returns>
- A array of double primitive types that represent all the
- values of the desired request parameter or <code>null</code> if
+ A array of double primitive types that represent all the
+ values of the desired request parameter or <code>null</code> if
the parameter does not exist.
</returns>
-
+
</method>
</section>
Modified: jakarta/velocity/tools/trunk/xdocs/view/ViewRenderTool.xml
URL: http://svn.apache.org/viewvc/jakarta/velocity/tools/trunk/xdocs/view/ViewRenderTool.xml?view=diff&rev=477914&r1=477913&r2=477914
==============================================================================
--- jakarta/velocity/tools/trunk/xdocs/view/ViewRenderTool.xml (original)
+++ jakarta/velocity/tools/trunk/xdocs/view/ViewRenderTool.xml Tue Nov 21 13:52:11 2006
@@ -1,5 +1,24 @@
<?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>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@velocity.apache.org
For additional commands, e-mail: dev-help@velocity.apache.org