| <!doctype html> |
| <!-- Generated by FreeMarker/Docgen from DocBook --> |
| <html lang="en" class="page-type-section"> |
| <head prefix="og: http://ogp.me/ns#"> |
| <meta charset="utf-8"> |
| <title>Transform directive - FreeMarker Manual</title> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| <meta name="format-detection" content="telephone=no"> |
| <meta property="og:site_name" content="FreeMarker Manual"> |
| <meta property="og:title" content="Transform directive"> |
| <meta property="og:locale" content="en_US"> |
| <meta property="og:url" content="http://example.com/ref_depr_transform.html"> |
| <link rel="canonical" href="http://example.com/ref_depr_transform.html"> |
| <link rel="icon" href="favicon.png" type="image/png"> |
| <link rel="stylesheet" type="text/css" href="docgen-resources/docgen.min.css?1594338517553"> |
| </head> |
| <body itemscope itemtype="https://schema.org/Code"> |
| <meta itemprop="url" content="http://example.com/"> |
| <meta itemprop="name" content="FreeMarker Manual"> |
| |
| <!--[if lte IE 9]> |
| <div style="background-color: #C00; color: #fff; padding: 12px 24px;">Please use a modern browser to view this website.</div> |
| <![endif]--><div class="header-top-bg"><div class="site-width header-top"><a class="logo" href="http://example.com" role="banner"> <img itemprop="image" src="logo.png" alt="My Logo"> |
| </a></div></div><div class="header-bottom-bg"><div class="site-width search-row"><a href="index.html" class="navigation-header">FreeMarker Manual</a><div class="navigation-header"></div></div><div class="site-width breadcrumb-row"><ul class="breadcrumb" itemscope itemtype="http://schema.org/BreadcrumbList"><li class="step-0" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="index.html"><span itemprop="name">FreeMarker Manual</span></a></li><li class="step-1" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="ref.html"><span itemprop="name">Reference</span></a></li><li class="step-2" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="ref_deprecated.html"><span itemprop="name">Deprecated FTL constructs</span></a></li><li class="step-3" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="ref_depr_transform.html"><span itemprop="name">Transform directive</span></a></li></ul><div class="bookmarks" title="Bookmarks"><span class="sr-only">Bookmarks:</span><ul class="bookmark-list"><li><a href="alphaidx.html">Index</a></li><li><a href="gloss.html">Glossary</a></li><li><a href="ref.html">Reference</a></li><li><a href="app_faq.html">FAQ</a></li><li><a href="preface.html#test_target">Bőregér</a></li></ul></div></div></div> <div class="main-content site-width"> |
| <div class="content-wrapper no-toc"> |
| <div id="table-of-contents-wrapper" class="col-left"> |
| </div> |
| <div class="col-right"><div class="page-content"><div class="page-title"><div class="pagers top"><a class="paging-arrow previous" href="ref_depr_oldmacro.html"><span>Previous</span></a><a class="paging-arrow next" href="ref_depr_oldsyntax.html"><span>Next</span></a></div><div class="title-wrapper"> |
| <h1 class="content-header header-section1" id="ref_depr_transform" itemprop="headline">Transform directive</h1> |
| </div></div><div class="page-menu"> |
| <div class="page-menu-title">Page Contents</div> |
| <ul><li><a class="page-menu-link" href="#autoid_129" data-menu-target="autoid_129">Synopsis</a></li><li><a class="page-menu-link" href="#autoid_130" data-menu-target="autoid_130">Description</a></li></ul> </div><a name="ref.directive.transform"></a> |
| |
| |
| |
| |
| <h2 class="content-header header-section2" id="autoid_129">Synopsis</h2> |
| |
| |
| |
| <pre class="metaTemplate"> |
| <code class="inline-code"><transform <em class="code-color">transVar</em>> |
| <em class="code-color">...</em> |
| </transform></code> |
| or |
| <code class="inline-code"><transform <em class="code-color">transVar</em> <em class="code-color">name1</em>=<em class="code-color">value1</em> <em class="code-color">name2</em>=<em class="code-color">value2</em> <em class="code-color">...</em> <em class="code-color">nameN</em>=<em class="code-color">valueN</em>> |
| <em class="code-color">...</em> |
| </transform></code> |
| </pre> |
| |
| |
| <p>Where:</p> |
| |
| <ul> |
| <li> |
| <code class="inline-code"><em class="code-color">transVar</em></code>: |
| Expression evaluates to a transform |
| </li> |
| |
| <li> |
| <code class="inline-code"><em class="code-color">name1</em></code>, |
| <code class="inline-code"><em class="code-color">name2</em></code>, ... |
| <code class="inline-code"><em class="code-color">nameN</em></code>: Name of |
| parameters. Literal value, not expression. |
| </li> |
| |
| <li> |
| <code class="inline-code"><em class="code-color">value1</em></code>, |
| <code class="inline-code"><em class="code-color">value2</em></code>, ... |
| <code class="inline-code"><em class="code-color">valueN</em></code>: |
| Expressions evaluate to the values of parameters |
| </li> |
| </ul> |
| |
| |
| |
| |
| |
| <h2 class="content-header header-section2" id="autoid_130">Description</h2> |
| |
| |
| <div class="callout note"> |
| <strong class="callout-label">Note:</strong> |
| |
| <p>This directive is still working, but deprecated. You may |
| want to read about <a href="ref_directive_userDefined.html#ref.directive.userDefined">user-defined directive |
| calls</a> to see the replacement.</p> |
| </div> |
| |
| |
| <p>Captures the output generated inside its body (i.e. between |
| its start-tag and end-tag), and let the given transform modify it |
| before it is written to the final output.</p> |
| |
| <p>Example:</p> |
| |
| |
| |
| <div class="code-wrapper"><pre class="code-block code-template"><p>A very simple HTML file: |
| <pre> |
| <strong><transform html_escape></strong> |
| <html> |
| <body> |
| <p>Hello word! |
| </body> |
| </html> |
| <strong></transform></strong> |
| </pre></pre></div> |
| |
| <p>the output will be:</p> |
| |
| |
| |
| <div class="code-wrapper"><pre class="code-block code-output"><p>A very simple HTML file: |
| <pre> |
| &lt;html&gt; |
| &lt;body&gt; |
| &lt;p&gt;Hello word! |
| &lt;/body&gt; |
| &lt;/html&gt; |
| </pre></pre></div> |
| |
| <p>Some transforms may take parameters. The name and meaning of |
| parameters depends on the transform in question. For example here we |
| give a parameter called ``var'':</p> |
| |
| |
| |
| <div class="code-wrapper"><pre class="code-block code-template"><#-- This transform stores the output in the variable x, |
| rather than sending it to the output --> |
| <transform capture_output<strong> var="x"</strong>> |
| some test |
| </transform></pre></div> |
| |
| <p>It is the task of the programmers to put the necessary |
| transforms into the data-model. For the name and usage of accessible |
| transforms ask the programmers. <span class="marked-for-programmers">Initially there is a <a href="pgui_config_sharedvariables.html">shared variable</a> for |
| most transforms in the |
| <code class="inline-code">freemarker.template.utility</code> package. For more |
| information see: <a href="pgui_config_sharedvariables.html">Programmer's Guide/The Configuration/Shared variables</a></span></p> |
| <div class="bottom-pagers-wrapper"><div class="pagers bottom"><a class="paging-arrow previous" href="ref_depr_oldmacro.html"><span>Previous</span></a><a class="paging-arrow next" href="ref_depr_oldsyntax.html"><span>Next</span></a></div></div></div></div> </div> |
| </div> |
| <div class="site-footer"><div class="site-width"><div class="footer-bottom"> <p class="last-generated"> |
| Last generated: |
| <time itemprop="dateModified" datetime="2020-07-09T23:48:37Z" title="Thursday, July 9, 2020 11:48:37 PM GMT">2020-07-09 23:48:37 GMT</time> </p> |
| <p class="copyright"> |
| © <span itemprop="copyrightYear">1999</span>–2020 |
| <a itemtype="http://schema.org/Organization" itemprop="copyrightHolder" href="https://apache.org/">The Apache Software Foundation</a> </p> |
| </div></div></div></body> |
| </html> |
