| <!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>Using FreeMarker with Ant - 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="Using FreeMarker with Ant"> |
| <meta property="og:locale" content="en_US"> |
| <meta property="og:url" content="http://example.com/pgui_misc_ant.html"> |
| <link rel="canonical" href="http://example.com/pgui_misc_ant.html"> |
| <link rel="icon" href="favicon.png" type="image/png"> |
| <link rel="stylesheet" type="text/css" href="docgen-resources/docgen.min.css?1594338519184"> |
| </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="pgui.html"><span itemprop="name">Programmer's Guide</span></a></li><li class="step-2" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="pgui_misc.html"><span itemprop="name">Miscellaneous</span></a></li><li class="step-3" itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"><a class="label" itemprop="item" href="pgui_misc_ant.html"><span itemprop="name">Using FreeMarker with Ant</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><li><a href="api/index.html">API</a></li><li><a href="../index.html">Home</a></li></ul></div></div></div> <div class="main-content site-width"> |
| <div class="content-wrapper"> |
| <div id="table-of-contents-wrapper" class="col-left"> |
| <script>var breadcrumb = ["FreeMarker Manual","Programmer\'s Guide","Miscellaneous","Using FreeMarker with Ant"];</script> |
| <script src="toc.js?1594338519184"></script> |
| <script src="docgen-resources/main.min.js?1594338519184"></script> |
| </div> |
| <div class="col-right"><div class="page-content"><div class="page-title"><div class="pagers top"><a class="paging-arrow previous" href="pgui_misc_xml_legacy.html"><span>Previous</span></a><a class="paging-arrow next" href="pgui_misc_jythonwrapper.html"><span>Next</span></a></div><div class="title-wrapper"> |
| <h1 class="content-header header-section1" id="pgui_misc_ant" itemprop="headline">Using FreeMarker with Ant</h1> |
| </div></div><p>There are two ``FreeMarker Ant tasks'' that we know |
| about:</p><ul> |
| <li> |
| <p><code class="inline-code">FreemarkerXmlTask</code>: It comes with the |
| FreeMarker distribution, packed into the |
| <code class="inline-code">freemarker.jar</code>. This is a lightweight, |
| easy-to-use Ant task for transforming XML documents with |
| FreeMarker templates. Its approach is that the source files (input |
| files) are XML files, which are rendered to corresponding output |
| files, by a single template. That is, for each XML file, the |
| template will be executed (with the XML document in the |
| data-model), and the template output will be written into a file |
| of similar name than the name of the XML file. Thus, the template |
| file plays a similar role as an XSLT style sheet, but it is FTL, |
| not XSLT.</p> |
| </li> |
| |
| <li> |
| <p> FMPP: It's a more heavyweight, less XML centric, |
| third party Ant task (and standalone command-line tool). Its |
| primary approach is that the source files (input files) are |
| template files that generate the corresponding output files |
| themselves, but it also supports the approach of |
| <code class="inline-code">FreemarkerXmlTask</code> for the source files that are |
| XML-s. Also, it has extra features over the |
| <code class="inline-code">FreemarkerXmlTask</code>. What's its drawback then? As |
| it is more complex and more generalized, it's harder to learn and |
| use it.</p> |
| </li> |
| </ul><p>This section introduces the |
| <code class="inline-code">FreemarkerXmlTask</code>. For more information about FMPP |
| visit its homepage: <a href="http://fmpp.sourceforge.net/">http://fmpp.sourceforge.net/</a>.</p><p>In order to use the <code class="inline-code">FreemarkerXmlTask</code>, you |
| must first define the |
| <code class="inline-code">freemarker.ext.ant.FreemarkerXmlTask</code> inside your |
| Ant buildfile, then call the task. Suppose you want to transform |
| several XML documents to HTML using the hypothetical "xml2html.ftl" |
| template, with XML documents being located in the directory "xml" and |
| HTML documents generated into directory "html". You would write |
| something like:</p> |
| |
| <div class="code-wrapper"><pre class="code-block code-unspecified"><taskdef name="freemarker" classname="freemarker.ext.ant.FreemarkerXmlTask"> |
| <classpath> |
| <pathelement location="freemarker.jar" /> |
| </classpath> |
| </taskdef> |
| <mkdir dir="html" /> |
| <freemarker basedir="xml" destdir="html" includes="**/*.xml" template="xml2html.ftl" /></pre></div><p>The task would invoke the template for every XML document. Every |
| document would be parsed into a DOM tree, then wrapped as a FreeMarker |
| node variable. When template processing begins, the special variable, |
| <code class="inline-code">.node</code>, is set to the root node of the XML |
| document.</p><p>Note that if you are using the legacy (FreeMarker 2.2.x and |
| earlier) XML adapter implementation, that still works, and the root of |
| the XML tree is placed in the data-model as the variable |
| <code class="inline-code">document</code>. That contains an instance of the legacy |
| <code class="inline-code">freemarker.ext.xml.NodeListModel</code> class.</p><p>Note that all properties defined by the build file would be made |
| available as a hash model named "properties". Several other models are |
| made available; for detailed description of what variables are made |
| available to templates as well as what other attributes can the task |
| accept, see the JavaDoc for |
| <code class="inline-code">freemarker.ext.ant.FreemarkerXmlTask</code>.</p><div class="bottom-pagers-wrapper"><div class="pagers bottom"><a class="paging-arrow previous" href="pgui_misc_xml_legacy.html"><span>Previous</span></a><a class="paging-arrow next" href="pgui_misc_jythonwrapper.html"><span>Next</span></a></div></div></div></div> </div> |
| </div> |
| <div class="site-footer"><div class="site-width"><div class="footer-top"><div class="col-left sitemap"></div><div class="col-right"><a class="xxe" href="http://www.xmlmind.com/xmleditor/" rel="nofollow" title="Edited with XMLMind XML Editor"><span>Edited with XMLMind XML Editor</span></a></div></div><div class="footer-bottom"> <p class="last-generated"> |
| Last generated: |
| <time itemprop="dateModified" datetime="2020-07-09T23:48:39Z" title="Thursday, July 9, 2020 11:48:39 PM GMT">2020-07-09 23:48:39 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> |
