You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by ha...@apache.org on 2008/07/16 00:27:17 UTC
svn commit: r677070 -
/myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/xmlTemplate.xml
Author: hazems
Date: Tue Jul 15 15:27:16 2008
New Revision: 677070
URL: http://svn.apache.org/viewvc?rev=677070&view=rev
Log:
https://issues.apache.org/jira/browse/TOMAHAWK-1271
Documenting the s:xmlTemplate component for promoting it to Tomahawk
Added:
myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/xmlTemplate.xml
Added: myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/xmlTemplate.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/xmlTemplate.xml?rev=677070&view=auto
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/xmlTemplate.xml (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/xmlTemplate.xml Tue Jul 15 15:27:16 2008
@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+<document>
+ <!-- component name -->
+ <body>
+ <!-- Description -->
+ <section name="Description">
+ <p>
+ This component is used to transform XML (from either a String or URL)
+ using XSLT.
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+ Not available
+ </section>
+ <!-- API -->
+ <section name="API">
+ <table>
+ <tr>
+ <td>component-family</td>
+ <td>org.apache.myfaces.tomahawk.Template</td>
+ </tr>
+ <tr>
+ <td>component-class</td>
+ <td>org.apache.myfaces.custom.template.XmlTemplate</td>
+ </tr>
+ <tr>
+ <td>tag-class</td>
+ <td>org.apache.myfaces.custom.template.XmlTemplateTag</td>
+ </tr>
+ </table>
+ </section>
+
+ <!-- Usage -->
+ <section name="Usage">
+ <source xml:space="preserve">
+ <s:xmlTemplate rendered="true"
+ contentLocation="org/apache/myfaces/examples/template/foo.xml"
+ stylesheetLocation="org/apache/myfaces/examples/template/foo.xsl"/>
+
+ </source>
+ </section>
+
+
+ <!-- Instructions -->
+ <section name="Instructions">
+
+ <p>
+ <code>
+ id - defines the id of the component.
+ </code>
+ <br/>
+ <code>
+ content - String containing the XML content to be transformed. It is optional.
+ </code>
+ <br/>
+ <code>
+ contentLocation - String containing the location of the XML content to be transformed. It is optional.
+ </code>
+ <br/>
+
+ <code>
+ contentStream - Value binding expression referencing an InputStream from which the XML content
+ is to be read. It is optional.
+ </code>
+ <br/>
+
+ <code>
+ stylesheet - String containing the XSL information to use in the transformation. It is optional.
+ </code>
+ <br/>
+
+ </p>
+ </section>
+
+
+ <!-- Additional Information -->
+ <section name="Additional Information">
+ <p>see template/index.jsf in the Sandbox examples.</p>
+ </section>
+ </body>
+
+</document>