<?xml version="1.0"?>

<!--
   Copyright 2000-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.
-->


<document>

 <properties>
  <title>Migration To Velocity</title>
  <author email="jvanzyl@zenplex.com">Velocity Documentation Team</author>
 </properties>

<body>

<section name="Converting Templates">

<p>
    Legacy documents are the bane of any software migration. The
    Velocity Team has tried to ensure that existing templates can be
    converted for use within Velocity in as painless a manner as
    possible.
</p>

<p>
    Currently there is only a WebMacro to Velocity template converter,
    but there are plans for a Tea to Velocity template converter, and a
    FreeMarker to Velocity template converter.
</p>

</section>

<section name="WebMacro to Velocity Template Converter">

<p>
    The <code>convert-wm.sh</code> script in the <code>convert</code>
    directory converts a single WebMacro template (<code>*.wm</code>) to
    a Velocity template (<code>*.vm</code>), or converts an entire
    directory structure of WebMacro templates to Velocity templates.
</p>

<p>
    The <code>convert-wm.sh</code> script can convert a single WebMacro
    template to a Velocity template.
</p>

<source><![CDATA[
./convert-wm.sh template.wm
]]></source>

<p>
    This will produce a single Velocity template named
    <code>template.vm</code> from the WebMacro template
    <code>template.wm</code>. The original WebMacro template will be
    preserved.
</p>

<p>
    To convert an entire directory structure of WebMacro templates using
    the <code>convert-wm.sh</code> script, simply include the directory
    name instead of the template name, as indicated below.
</p>

<source><![CDATA[
./convert-wm.sh templates
]]></source>

<p>
    This will produce a directory structure of templates named
    <code>templates/[template].vm</code>. The original WebMacro templates
    will be preserved during the conversion process.
</p>
</section>

</body>
</document>
