Author: indika Date: Fri Jun 26 03:52:39 2009 New Revision: 40072 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=40072
Log: xslt mediator doc update Modified: branches/esb/java/2.1/product/docs/xdoc/mediators/xslt.xml Modified: branches/esb/java/2.1/product/docs/xdoc/mediators/xslt.xml URL: http://wso2.org/svn/browse/wso2/branches/esb/java/2.1/product/docs/xdoc/mediators/xslt.xml?rev=40072&r1=40071&r2=40072&view=diff ============================================================================== --- branches/esb/java/2.1/product/docs/xdoc/mediators/xslt.xml (original) +++ branches/esb/java/2.1/product/docs/xdoc/mediators/xslt.xml Fri Jun 26 03:52:39 2009 @@ -12,125 +12,89 @@ <body> <h2>XSLT Mediator</h2> - <p> - The <xslt> mediator applies the specified XSLT transformation to the - selected element of the current message payload. If the source element is not - specified, it defaults to the first child of the soap body. Optionally - parameters (XSLT) could be passed into the transformations through the - 'property' elements. The 'feature' element defines any features which should be - explicitly set to the TransformerFactory. The feature - 'http://ws.apache.org/ns/synapse/transform/feature/dom' turns on DOM based - transformations instead of serializing elements into Byte streams and/or - temporary files. Though this would be better in performance than using byte - streams, sometimes it may not work for all transformations. - </p> - - <p> - Finally, the 'resource' element can be used to resolve XSLT imports and - includes from the repository. It works in exactly the same way as the - corresponding element in a <proxy> definition. - </p> - - <p> - The <xslt> mediator applies the specified XSLT transformation to the - selected element of the current message payload. If the source element is not - specified, it defaults to the first child of the soap body. Optionally - parameters (XSLT) could be passed into the transformations through the - 'property' elements. The 'feature' element defines any features which should be - explicitly set to the TransformerFactory. The feature - 'http://ws.apache.org/ns/synapse/transform/feature/dom' turns on DOM based - transformations instead of serializing elements into Byte streams and/or - temporary files. Though this would be better in performance than using byte - streams, sometimes it may not work for all transformations. - </p> - - <p> - Finally, the 'resource' element can be used to resolve XSLT imports and - includes from the repository. It works in exactly the same way as the - corresponding element in a <proxy> definition. - </p> - - <h3>Syntax</h3> - - <pre xml:space="preserve"> <xslt key="string" [source="xpath"]> + +<p>The <strong>xslt</strong> mediator applies the specified XSLT transformation +to the selected element of the current message payload.The +<strong>source</strong> attribute specifies how what is the element need to be +transform. If the <strong>source</strong> element is not specified, it defaults +to the first child of the soap body. Optionally parameters could be passed into +the transformations through the '<strong>property</strong>' elements. These +properties are corresponding to the XSL parameters and can be accessed during +transformation by <strong><xsl:param name="{the name of the property}" +/></strong>. The '<strong>feature</strong>' element defines any features +which should be explicitly set to the <strong>TransformerFactory</strong>. The +feature +'<strong>http://ws.apache.org/ns/synapse/transform/feature/dom</strong>' turns +on DOM based transformations instead of serializing elements into Byte streams +and/or temporary files. Though this would be better in performance than using +byte streams, sometimes it may not work for all transformations. </p> + +<p>Finally, the '<strong>resource</strong>' element can be used to resolve +<strong>XSLT imports and includes</strong> from the repository. It works in +exactly the same way as the corresponding element in a <proxy> definition +(Proxy Service). </p> + +<h3>Syntax</h3> + +<h2></h2> +<pre xml:space="preserve"> <xslt key="string" [source="xpath"]> <property name="string" (value="literal" | expression="xpath")/>* <feature name="string" value="true| false" />* - <resource location="..." key="..."/>* + <resource location="string" key="string"/>* </xslt></pre> - <p></p> - <pre xml:space="preserve"><xquery key="string" [target="xpath"]> - <variable name="string" type="string" [key="string"] [expression="xpath"] [value="string"]/>? -</xquery> </pre> - <h3>UI Configuration</h3> - <p> - <img src="../xslt-mediator/docs/images/xslt_mediator_screenshot.jpg" alt=""/> - </p> - <p> - <strong>XSLT Mediator</strong> - </p> - - <ul> - <li> - Key : The registry key to refer the xslt. - </li> - <li> - Source: Specify in which part of message (specified in xpath) the xslt should be applied. Default is the SOAP body of - the message. - </li> - </ul> - - <h2>Properties of the XSLT mediator</h2> - <p> - Manage the properties which would be referred from the xslt in transformation (using get-property(prop-name) xpath extension function). - </p> - <p> - <img src="../xslt-mediator/docs/images/add_properties_screenshot.jpg" alt=""/> - </p> - <p> - <strong>XSLT Mediator - Add Properties</strong> - </p> - - <ul> - <li> - Property Name: Name of the property. - </li> - <li> - Property Type: Whether it is a static value or an xpath expression. - </li> - <li> - Value/ Expression: The static value or the xpath expression. - </li> - <li> - NSEditor: Specify the namespaces that are used in the xpath expression. - </li> - <li> - Action: Delete the property. - </li> - </ul> - - - <h2>Features of the XSLT mediator</h2> - <p> - Specify the features to be enabled in the XSLT transformation. Read the introduction paragraph of this guide for an example feature. - </p> - <p> - <img src="../xslt-mediator/docs/images/add_features_screenshot.jpg" alt=""/> - </p> - <p> - <strong>XSLT Mediator - Add Features</strong> - </p> - - <ul> - <li> - Feature Name: Name of the feature. - </li> - <li> - Feature Value: Specify whether the feature is turn on (True) or Not (False). - </li> - <li> - Action: Delete the feature. - </li> - </ul> + +<h3>UI Configuration</h3> + +<p><img src="../xslt-mediator/docs/images/xslt_mediator_screenshot.jpg" alt="" +/></p> + +<p><strong>Figure 1. XSLT Mediator</strong></p> + +<p><strong>XSLT Mediator</strong> </p> +<ul> + <li>Key : The registry key to refer the xslt. </li> + <li>Source: Specify in which part of message (specified in xpath) the xslt + should be applied. Default is the SOAP body of the message. </li> +</ul> + +<h2>Properties of the XSLT mediator</h2> + +<p>Manage the properties which would be referred from the xslt in +transformation (using get-property(prop-name) xpath extension function). </p> + +<p><img src="../xslt-mediator/docs/images/add_properties_screenshot.jpg" alt="" +/> </p> + +<p><strong>Figure 2. Add Properties</strong></p> + +<p><strong></strong> </p> +<ul> + <li>Property Name: Name of the property. </li> + <li>Property Type: Whether it is a static value or an xpath expression. </li> + <li>Value/ Expression: The static value or the xpath expression. </li> + <li>NSEditor: Specify the namespaces that are used in the xpath expression. + </li> + <li>Action: Delete the property. </li> +</ul> + +<h2>Features of the XSLT mediator</h2> + +<p>Specify the features to be enabled in the XSLT transformation. Read the +introduction paragraph of this guide for an example feature. </p> + +<p><img src="../xslt-mediator/docs/images/add_features_screenshot.jpg" alt="" +/> </p> + +<p><strong>Figure 3. Add Features</strong> </p> + +<p><strong>XSLT Mediator - Add Features</strong> </p> +<ul> + <li>Feature Name: Name of the feature. </li> + <li>Feature Value: Specify whether the feature is turn on (True) or Not + (False). </li> + <li>Action: Delete the feature. </li> +</ul> + <p></p> </body> </html> _______________________________________________ Esb-java-dev mailing list [email protected] https://wso2.org/cgi-bin/mailman/listinfo/esb-java-dev
