<?xml version="1.0" encoding="iso-8859-1"?>
<param xmlns="http://www.sos-berlin.com/schema/js7_job_documentation_v1.1"
       xmlns:xhtml="http://www.w3.org/1999/xhtml"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       name="replacement"
       required="false"
       DataType="java.lang.String"
       usewith="replacing">

	<note>
		<title>String for renaming Filenames </title>
        <p>
            String for replacement of matching character sequences within file names that are specified with the
            value of the parameter <paramref>replacing</paramref>.
        </p>
        <p>
            If multiple "capturing groups" are to be replaced then one replacement string per group has to be specified. 
            These strings are separated by a semicolon ";":
        </p>
        <p>
            replacement: aa;[filename:];bb
        </p>
        <p>
              Supports masks for substitution in the file name with format strings that are enclosed with
              <em>[</em>
              and
              <em>]</em>
              .
              The following format strings are supported:
        </p>
			<list type="unordered">
                <item>
					<p>
						<code>
							[date:
							<em>date format</em>
							]
						</code>
					</p>
				</item>
				<item>
					<p>
						<em>date format</em>
						must be a valid Java data format string, e.g.
						<br/>
						<em>yyyyMMddHHmmss</em>
						,
						<em>yyyy-MM-dd.HHmmss</em>
						etc.
	                </p>
                </item>
			</list>
			<list type="unordered">
                <item>
    	            <p>
                  <code>[filename:]</code>
 					</p>
				</item>
				<item>
					<p>
						Will be substituted by the original file name including the file extension.
	                </p>
                </item>
			</list>
			<list type="def">
                <item>
	                <p>
                   <code>[filename:lowercase]</code>
					</p>
				</item>
				<item>
					<p>
						Will be substituted by the original file name including the file extension 
						with all characters converted to lower case.
	                </p>
                </item>
			</list>
			<list type="def">
                <item>
	                <p>
                    <code>[filename:uppercase]</code>
					</p>
				</item>
				<item>
					<p>
						Will be substituted by the original file name including the file extension 
						with all characters converted to upper case.
	                </p>
                </item>
			</list>
        <p>
            Requires the parameter
            <paramref>replacing</paramref>
            to be specified.
        </p>
        <p>
			<list type="unordered">
				<item>
					<p>
						<paramref>replacing</paramref>
						= Hello
					</p>
				</item>
				<item>
					<p>
						<paramref>replacement</paramref>
						= 1234
					</p>
				</item>
				<item>
					<p>
						Input file: Hello_World.txt
					</p>
				</item>
				<item>
					<p>
						Output file: 1234_World.txt
					</p>
				</item>
			</list>
		</p>
	</note>
</param>