org.xwiki.platform:xwiki-platform-rendering-macro-velocityXWiki Platform - Rendering - Macro - Velocityjar00.0

XWiki Platform - Rendering - Macro - Velocity

Executes [[Velocity>>http://velocity.apache.org/]] on the content of the macro. = Usage = {{code language="none"}} {{velocity filter="..." output="..." wiki="..."}} ...content here... {{/velocity}} {{/code}} What's important to understand is that the Velocity engine will execute first on the content and then only, if ##wiki## is ##true## (which is the default) , the resulting content will be parsed using a wiki content parser. {{warning}} Since Velocity executes first, if you put an {{{{{include}}}}} macro inside the {{{{{velocity}}}}} macro you will not be able to use any Velocity macro/variable defined in the included page because the include is done after Velocity is executed. Thus, take care of putting the {{{{{include}}}}} macro outside of the {{{{{Velocity}}}}} macro or use the defined macro/variable in a separate {{{{{velocity}}}}} macro, as in:((( {{code language="none"}} {{velocity}} ## Note: The included page defines a $var variable in this example {{include reference="somepage"/}} ## Note: Calling $var here won't work since it would be executed before the include is done {{/velocity}} {{velocity}} $var {{/velocity}} {{/code}} ))) {{/warning}} == Parameters definition == Velocity macro extends [[Script Macro]] and support all its parameters (except the ##language## selection which is always ##velocity##). Following are Velocity macro specific parameters: |=Name|=Optional|=Allowed values|=Default value|=Description |filter|yes|none/html/indent|indent|Indicate a filter to apply on velocity content before and after script execution. The default filter (##indent##) remove all first whites spaces of lines to support code indentation. See [[Velocity Macro Filter]] for more details. == Example1 == {{code language="velocity"}} {{velocity}} #set($words = ["Some", "velocity", "code"]) #foreach($word in $words) $word ## #end {{/velocity}} {{/code}} Result: {{code language="none"}} Some velocity code {{/code}} == Example2 == Shows how to do some dynamic include. {{code language="velocity"}} {{velocity}} #if (... some condition...) #set ($ref = "page1") #else #set ($ref = "page2") #end {{include reference="$ref"/}} {{/velocity}} {{/code}} This will include ##page1## or ##page2## depending on the condition. = XWiki Standard Velocity Macros = [[Velocity Macros (a.k.a Velocimacros)>>https://velocity.apache.org/engine/devel/user-guide.html#velocimacros]] are a feature of the Velocity engine. XWiki provides several of them inside the ##macros.vm## template file, that you can use in your wiki pages or template files. {{display reference="Extension.Velocity Macro.Macros.WebHome"/}}GNU Lesser General Public License 2.1http://extensions.xwiki.org/xwiki/bin/view/Extension/Velocity%20MacroXWiki Development Teamhttps://xwiki.org/xwiki/bin/view/XWiki/XWikiTeamgitgit://github.com/xwiki/xwiki-platform.git/xwiki-platform-core/xwiki-platform-rendering/xwiki-platform-rendering-macros/xwiki-platform-rendering-macro-velocitygitgit@github.com:xwiki/xwiki-platform.git/xwiki-platform-core/xwiki-platform-rendering/xwiki-platform-rendering-macros/xwiki-platform-rendering-macro-velocityhttps://github.com/xwiki/xwiki-platform/tree/master/xwiki-platform-core/xwiki-platform-rendering/xwiki-platform-rendering-macros/xwiki-platform-rendering-macro-velocity/jirahttps://jira.xwiki.org/browse/XWIKIfalsemaven.groupidorg.xwiki.platformmaven.artifactidxwiki-platform-rendering-macro-velocitymaven.Modelorg.xwiki.platform:xwiki-platform-rendering-macro-velocity:jar:18.7.0xwiki.extension.recommendedVersions.commonsorg.xwiki.commons:.*/[18.7.0]xwiki.extension.recommendedVersions.platformorg.xwiki.commons:.*/[18.7.0], org.xwiki.rendering:.*/[18.7.0], org.xwiki.platform:.*/[18.7.0]xwiki.extension.recommendedVersionsorg.xwiki.commons:.*/[18.7.0], org.xwiki.rendering:.*/[18.7.0], org.xwiki.platform:.*/[18.7.0]4.4maven-xwikihttps://nexus.xwiki.org/nexus/content/groups/publicmaven