Transform Task: XmlPrime

Parameters

The following table describes the parameters of the Transform task.

Parameter	Description
Collections Collections Collections	Optional ITaskItem ITaskItem ITaskItem[] parameter. Specifies the available collections. If the CollectionURI metadata is defined the item will be added to the specified collection. Otherwise the items will be set as the default collection.
InitialMode InitialMode InitialMode	Optional string String String parameter. Specifies the initial template mode to apply when executing the transformation. This parameter is in Clark notation. "{URI}local" represents the local name "local" in the namespace "URI", or "local" if no namespace is required.
InitialTemplate InitialTemplate InitialTemplate	Optional string String String parameter. Specifies the initial template to call when executing the transformation. This parameter is in Clark notation. "{URI}local" represents the local name "local" in the namespace "URI", or "local" if no namespace is required.
Input Input Input	Optional ITaskItem ITaskItem ITaskItem parameter. Specifies the path of an XML input file to use as the context item.
OptimizationLevel OptimizationLevel OptimizationLevel	Optional int Integer int parameter. Specifies the compilation optimization level. The default value is 3. If the value is less than zero or greater than 4, the default optimization level is used.
Output Output Output	Required ITaskItem ITaskItem ITaskItem parameter. Specifies the principal output file from executing the transformation.
OutputFiles OutputFiles OutputFiles	Optional ITaskItem ITaskItem ITaskItem[] output parameter. Receives the result documents created by the transformation. MediaType and Encoding custom metadata contain the mime-type and character encoding of each output.
Parameters Parameters Parameters	Optional string String String parameter. Specifies the values of stylesheet parameters. The value of this parameter should be set to a series of XML elements of the following form: <Parameter Name="..." [Namespace="..."] [Value="..."] [Select="..."] /> The `Name` and `Namespace` attributes correspond to the local name and namespace of the parameter. If the namespace is omitted, then the parameter is assumed to be in the empty namespace. Either the `Value`, `Select` or `Path` attributes should be present, but only one of these. If the `Value` attribute is present then the value of the parameter is set to an xs:untypedAtomic value defined by this attribute. If the `Select` attribute is present then the value of the parameter is set to the result of evaluating the XPath expression defined by this attribute. If the `Path` attribute is present then the value of the parameter is set to the document loaded from the location specified by this attribute. The content of the element is ignored.
ProcessXsiSchemaLocation ProcessXsiSchemaLocation ProcessXsiSchemaLocation	Optional bool Boolean bool parameter. Specifies whether `xsi:schemaLocation` and `xsi:noNamespaceSchemaLocation` attributes will be processed. If not specified, the default value is `true`.
Schemas Schemas Schemas	Optional ITaskItem ITaskItem ITaskItem[] parameter. Specifies the set of XML Schema files used for validation.
SerializationParameters SerializationParameters SerializationParameters	Optional string String String parameter. Specifies the values of serialization parameters. The value of this parameter should be set to a series of XML elements of the following form: <Parameter Name="..." [Namespace="..."] Value="..." /> The `Name` and `Namespace` attributes correspond to the local name and namespace of the parameter. If the namespace is omitted, then the parameter is assumed to be in the empty namespace. The `Value` attribute specifies the value of the serialization parameter. The content of the element is ignored.
SerializationParameterDocument SerializationParameterDocument SerializationParameterDocument	Optional ITaskItem ITaskItem ITaskItem parameter. Specifies a serialization parameter document from which to read serialization parameters.
StripWhitespace StripWhitespace StripWhitespace	Optional bool Boolean bool parameter. Specifies whether the whitespace will be stripped from source documents. If not specified, the default value is `false`.
Validation Validation Validation	Optional string String String parameter. Specifies whether the source documents will be validated using a DTD ("dtd"), XML Schemas ("schema") or no validation will be performed ("none"). If not specified, the default value is `none`.
Xsl Xsl Xsl	Required ITaskItem ITaskItem ITaskItem parameter. Specifies the path of the XSL transformation.

Remarks

Parameters and serialization parameters are passed as XML "Parameter" tags with Name, NamespaceURI and Value attributes. The Value attribute must be an XPath expression. See the example below for details.

If both InitialMode and InitialTemplate are specified, the task fails and an error is logged.

In addition to having the parameters that are listed in the table, this task inherits parameters from the Task Task Task class. For a list of these additional parameters and their descriptions, see Task Base Class.

Example

The following example transforms input document document.xml to output.htm using the transformation stylesheet.xsl. Values are supplied for stylesheet parameters 'data' (in namespace 'http://www.example.org/) 'name', 'size' and 'date' are defined. The 'method' serialization parameter is set to XHTML. Input documents are validated using XML Schema against a set of files with extension 'xsd'. The initial template mode is specified as 'classic' in the 'http://www.example.org/' namespace. Two collections are made available with URIs 'urn:foo' and 'urn:bar'.

				<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">

  <Import Project="$(MSBuildExtensionsPath32)\XmlPrime.Tasks\XmlPrime.Tasks.Tasks"/>

  <ItemGroup>
    <Stylesheet Include="stylesheet.xsl" />
    
    <ContextDocument Include="document.xml" />
    
    <Schemas Include="*.xsd" />
    
    <FooCollection Include="foo*.xml">
      <CollectionURI>urn:foo</CollectionURI>
    </FooCollection>
    
    <BarCollection Include="bar*.xml">
      <CollectionURI>urn:bar</CollectionURI>
    </BarCollection>
  </ItemGroup>

  <PropertyGroup>
      <SerializationParameters>
        <!-- set the serialization method to XHTML -->
        <Parameter Name="method" Value="xhtml" />
      </SerializationParameters>
      <StylesheetParameters>
        <!-- bind parameter 'name' to the string 'Jethro' -->
        <Parameter Name="name" Value="Jethro" />
        <!-- bind parameter 'data' in namespace 'http://www.example.org/' to the document data.xml -->
        <Parameter Name="data" NamespaceUri="http://www.example.org/" Select="doc('data.xml')" />
        <!-- bind parameter 'size' to the XPath expression '1024 * 768' -->
        <Parameter Name="size" Select="1024 * 768" />
        <!-- bind parameter 'date' to the current date -->
        <Parameter Name="date" Select="current-date()" />
      </StylesheetParameters>
  </PropertyGroup>

  <!-- test passing of serialization parameters -->
  <Target Name="transform">
    <Transform Xsl="@(Stylesheet)"
               Input="@(ContextDocument)"
               InitialMode="{http://www.example.org/}classic"
               Collections="@(FooCollection);@(BarCollection)"
               Parameters="$(StylesheetParameters)"
               SerializationParameters="$(SerializationParameters)"
               Schemas="@(Schemas)"
               Validation="Schema"
               Output="output.htm">
      <Output TaskParameter="OutputFiles"
              ItemName="TransformOutputFiles" />
    </Transform>
    
    <Message Text="Wrote output file @(TransformOutputFiles)" />
    
  </Target>

</Project>

Transform Task

Parameters

Remarks

Example

See Also

Reference

Other Resources