This is an automated email from the ASF dual-hosted git repository.
lukaszlenart pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/struts-site.git
The following commit(s) were added to refs/heads/master by this push:
new 787a9f337 Clarifies hwo to use Velocity after moving support for it
into a plugin
787a9f337 is described below
commit 787a9f337b3b3464e4a319f65a1822b904a4e122
Author: Lukasz Lenart <lukaszlen...@apache.org>
AuthorDate: Mon Jun 27 07:52:07 2022 +0200
Clarifies hwo to use Velocity after moving support for it into a plugin
---
source/core-developers/velocity-result.md | 65 ++++---------------------------
source/plugins/velocity/index.md | 16 ++++++++
2 files changed, 24 insertions(+), 57 deletions(-)
diff --git a/source/core-developers/velocity-result.md
b/source/core-developers/velocity-result.md
index 05dd9cda9..562c8811b 100644
--- a/source/core-developers/velocity-result.md
+++ b/source/core-developers/velocity-result.md
@@ -5,71 +5,22 @@ title: Velocity Result
# Velocity Result
-
-
-{% comment %}start snippet
id=description|javadoc=true|url=org.apache.struts2.result.VelocityResult {%
endcomment %}
-<p>
-
- Using the Servlet container's {@link JspFactory}, this result mocks a JSP
-
- execution environment and then displays a Velocity template that will be
-
- streamed directly to the servlet output.
-
-
-</p>
-{% comment %}end snippet
id=description|javadoc=true|url=org.apache.struts2.result.VelocityResult {%
endcomment %}
+Using the Servlet container's {@link JspFactory}, this result mocks a JSP
execution environment and then displays
+a Velocity template that will be streamed directly to the servlet output.
## Parameters
+- location (default) - the location of the template to process.
+- parse (true by default) - if set to false, the location param will not be
parsed for Ognl expressions.
-
-{% comment %}start snippet
id=params|javadoc=true|url=org.apache.struts2.result.VelocityResult {%
endcomment %}
-<p>
-
- <ul>
-
-
-
- <li><b>location (default)</b> - the location of the template to process.</li>
-
-
-
- <li><b>parse</b> - true by default. If set to false, the location param will
-
- not be parsed for Ognl expressions.</li>
-
-
-
- </ul>
-
- <p>
-
- This result follows the same rules from {@link StrutsResultSupport}.
-
- </p>
-
-
-</p>
-{% comment %}end snippet
id=params|javadoc=true|url=org.apache.struts2.result.VelocityResult {%
endcomment %}
+This result follows the same rules from {@link StrutsResultSupport}.
## Examples
-
-
-{% comment %}start snippet
id=example|lang=xml|javadoc=true|url=org.apache.struts2.result.VelocityResult
{% endcomment %}
-
-
```xml
+<result name="success" type="velocity">
- <result name="success" type="velocity">
-
- <param name="location">foo.vm</param>
-
- </result>
-
+ <param name="location">foo.vm</param>
+</result>
```
-
-
-{% comment %}end snippet
id=example|lang=xml|javadoc=true|url=org.apache.struts2.result.VelocityResult
{% endcomment %}
diff --git a/source/plugins/velocity/index.md b/source/plugins/velocity/index.md
new file mode 100644
index 000000000..ae225bec6
--- /dev/null
+++ b/source/plugins/velocity/index.md
@@ -0,0 +1,16 @@
+---
+layout: default
+title: Velocity plugin
+parent:
+ url: index.html
+ title: Plugins
+---
+
+# Velocity Plugin
+
+The Velocity plugin provides integration with the
[Velocity](https://velocity.apache.org) a Java-based template engine.
+
+This plugin provides a dedicated
[Result](../../core-developers/velocity-result), all the [Struts
tags](../../tag-developers/velocity-tags)
+based on Velocity templates and all other Velocity related features.
+
+You must include this plugin in your `pom.xml` to use those features.
