grchiu      2003/06/17 13:16:57

  Modified:    java/xdocs/sources/xalan commandline.xml samples.xml
                        trax.xml usagepatterns.xml
  Log:
  Patch contributed by Glen Mazza ([EMAIL PROTECTED]) for bugzilla 20625:
  Fixing some documentation typos.
  
  Revision  Changes    Path
  1.27      +1 -1      xml-xalan/java/xdocs/sources/xalan/commandline.xml
  
  Index: commandline.xml
  ===================================================================
  RCS file: /home/cvs/xml-xalan/java/xdocs/sources/xalan/commandline.xml,v
  retrieving revision 1.26
  retrieving revision 1.27
  diff -u -r1.26 -r1.27
  --- commandline.xml   10 Apr 2003 14:34:58 -0000      1.26
  +++ commandline.xml   17 Jun 2003 20:16:57 -0000      1.27
  @@ -150,6 +150,6 @@
          <jump href="apidocs/org/xml/sax/EntityResolver.html">EntityResolver</jump> 
SAX interface to handle external entity references.</p>
          <p>Use <code>-CONTENTHANDLER</code> with a fully qualified class name to 
utilize a custom implementation of the 
          <jump href="apidocs/org/xml/sax/ContentHandler.html">ContentHandler</jump> 
SAX interface to serialize output.</p>
  -       <note>If you want to validate an XML document (verify that it adheres to its 
DOCTYPE declatation), you can use the <link idref="samples" 
anchor="validateutility">Validate utility</link> shipped with &xslt4j-current;.</note>
  +       <note>If you want to validate an XML document (verify that it adheres to its 
DOCTYPE declaration), you can use the <link idref="samples" 
anchor="validateutility">Validate utility</link> shipped with &xslt4j-current;.</note>
      </s2>
   </s1>
  
  
  
  1.57      +11 -11    xml-xalan/java/xdocs/sources/xalan/samples.xml
  
  Index: samples.xml
  ===================================================================
  RCS file: /home/cvs/xml-xalan/java/xdocs/sources/xalan/samples.xml,v
  retrieving revision 1.56
  retrieving revision 1.57
  diff -u -r1.56 -r1.57
  --- samples.xml       7 Jun 2003 21:12:15 -0000       1.56
  +++ samples.xml       17 Jun 2003 20:16:57 -0000      1.57
  @@ -159,7 +159,7 @@
       <p>where <ref>param</ref> is the stylesheet parameter value (a string of your 
choice).</p>  
       </s2><anchor name="sax2sax"/>
     <s2 title="SAX2SAX">
  -  <p>What it does: Explicitly set the SAX XMLReader and SAX ContentHandler for 
processing the stylesheet (birds.xsl), processing the XML input (birds.xml), and 
producing the output (birds.out).</p>
  +  <p>What it does: Explicitly sets the SAX XMLReader and SAX ContentHandler for 
processing the stylesheet (birds.xsl), processing the XML input (birds.xml), and 
producing the output (birds.out).</p>
     <p>Run this sample from the SAX2SAX subdirectory with</p>
      <p><code>java SAX2SAX</code></p>
       </s2><anchor name="dom2dom"/>
  @@ -228,7 +228,7 @@
       <p>For more information, see <link idref="usagepatterns" anchor="xpath">Working 
with XPath expressions</link>.</p>
       </s2><anchor name="appletxmltohtml"/>
       <s2 title="AppletXMLtoHTML">
  -    <p>The applet uses a stylesheet to transform an XML document into HTML. It 
displays the XML document, the
  +    <p>This applet uses a stylesheet to transform an XML document into HTML. It 
displays the XML document, the
        stylesheet, and the HTML output.</p>
       <p>How to run it: Open appletXMLtoHTML.hmtl in the Internet Explorer 5 
browser.</p>
       <note>For information about running &xslt4j; applets in Netscape Communicator, 
see <link idref="usagepatterns" anchor="netscape">Problems
  @@ -242,8 +242,8 @@
       <p>The servlet subdirectory contains four sample servlets and one JSP that use 
&xslt4j; to perform transformations. The sample 
       code is compiled and packed in xalanservlet.war. To run these samples, you must 
place 
       xalanservlet.war on a web server with a servlet engine. For example, using 
<jump href="http://jakarta.apache.org/tomcat/index.html";>jakarta-tomcat 4.1.18</jump>. 
  -    Copy the xalanservlet.war to %Tomcat_Home%/webapps. For more detail about 
deploying
  -    servlet on Tomcat, please refer to <jump 
href="http://jakarta.apache.org/tomcat/tomcat-4.1-doc/appdev/deployment.html";>Deployment
 Organization</jump>.</p>
  +    Copy the xalanservlet.war to %Tomcat_Home%/webapps. For more details about 
deploying
  +    servlets on Tomcat, please refer to <jump 
href="http://jakarta.apache.org/tomcat/tomcat-4.1-doc/appdev/deployment.html";>Deployment
 Organization</jump>.</p>
       <note>Dependency on Tomcat version. If encountering "java.lang.VerifyError: 
Cannot inherit from final class" error, 
       replace xercesImpl.jar under %Tomcat_Home%/common/endorsed with the one 
included with &xslt4j; .</note>
       <p><link anchor="simplexsltservlet">servlet.SimpleXSLTServlet</link> applies a 
particular stylesheet to a particular 
  @@ -269,10 +269,10 @@
        <s3 title="servlet.UseStylesheetParamServlet">
        <note>Paul Campbell &lt;[EMAIL PROTECTED]&gt; wrote this servlet and the 
following explanatory text.
        Thank you, Paul!</note>
  -     <p>What it does: The client (perhaps an HTML form ) specifies an XML document, 
a stylesheet, and a value to be passed
  +     <p>What it does: The client (perhaps an HTML form) specifies an XML document, 
a stylesheet, and a value to be passed
         to the stylesheet for a stylesheet parameter named "param1". The servlet 
performs the transformation and returns
         the output to the client. The client must specify which stylesheet 
(containing a "param1" stylesheet parameter") 
  -      and XML file are to be used or use sample files fooparam.xml and 
fooparam.xsl</p>
  +      and XML file are to be used or use sample files fooparam.xml and 
fooparam.xsl.</p>
        <p>How to run it: set up an HTML client to call the servlet with arguments 
along the lines of</p>
       <gloss><label>http://localhost:port/xalanservlet/UseStylesheetParamServlet?
       XML=fooparam.xml&amp;XSL=fooparam.xsl&amp;PVAL=GoodBye</label></gloss>
  @@ -318,8 +318,8 @@
       <p>To run the servlet:  set system property server.root=server root. Set up an 
HTML page to call
        servlet.ApplyXSLT with arguments as illustrated below.</p>
       <p>The files catalog.xml,  booklist1.xsl and booklist2.xsl are used in the 
following example.
  -    In the deploy descriptor, booklist1.xsl is set as the default xsl file. If you 
create these files yourself, be careful that the output method should
  -    be set to "xml" in the stylesheet.</p>
  +    In the deployment descriptor, booklist1.xsl is set as the default xsl file. If 
you create these files yourself, make sure that you set the output method
  +    to "xml" in the stylesheet.</p>
        <p>Examples:</p>
   <gloss>
   
<label>http://localhost:port/xalanservlet/ApplyXSLT?URL=/xalanservlet/catalog.xml&amp;xslURL=
  @@ -489,7 +489,7 @@
       </s3><anchor name="pquery"/>
       <s3 title="Parameterized query">
       <p><em>Contributed by John Gentilin ([EMAIL PROTECTED]).</em></p>
  -    <p>What it does: connect to a datasource, execute a parameterized query, and 
return the result. The XML source document
  +    <p>What it does: connects to a datasource, executes a parameterized query, and 
returns the result. The XML source document
       provides the parameter value as well as the connection information. The 
parameter value is in a node in the XML source.</p>
       <p>The stylesheet gets the required connection and parameter information from 
the XML source, sets up and executes the
       parameterized query, and retuns the query result set.</p>
  @@ -505,7 +505,7 @@
       <p>1. To turn caching on:</p>
       <p><code>java org.apache.xalan.xslt.Process</code>
       <br/><code>-xsl cachedNodes.xsl</code></p>
  -    <p>1. To turn caching off:</p>
  +    <p>2. To turn caching off:</p>
       <p><code>java org.apache.xalan.xslt.Process</code>
       <br/><code>-xsl streamNodes.xsl</code></p>
       <p>3. <ref>To be added</ref></p>
  @@ -562,7 +562,7 @@
        </s2>
        <anchor name="trax"/>
        <s2 title="trax">
  -     <p>What it does: run a number of samples illustrating uses of the <link 
idref="trax">TrAX (Transformation API for XML)</link> interfaces.</p>
  +     <p>What it does: runs a number of samples illustrating uses of the <link 
idref="trax">TrAX (Transformation API for XML)</link> interfaces.</p>
        <p>Run this sample from the trax subdirectory with</p>
        <p><code>java Examples</code></p>
        <p>and examine the source in Examples.java and ExampleContentHandler.java.</p>
  
  
  
  1.6       +1 -1      xml-xalan/java/xdocs/sources/xalan/trax.xml
  
  Index: trax.xml
  ===================================================================
  RCS file: /home/cvs/xml-xalan/java/xdocs/sources/xalan/trax.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- trax.xml  7 Jun 2003 21:12:15 -0000       1.5
  +++ trax.xml  17 Jun 2003 20:16:57 -0000      1.6
  @@ -125,7 +125,7 @@
   <label>Identity (or Copy) Transformation</label>
   <item>The process of transformation from a source to a result,
                         making as few structural changes as possible and no 
informational changes. The
  -                      term is somewhat loosely used, as the process is really a 
copy. from one
  +                      term is somewhat loosely used, as the process is really a 
copy from one
                         "format" (such as a DOM tree, stream, or set of SAX events) to
                         another.</item>
   
  
  
  
  1.58      +3 -3      xml-xalan/java/xdocs/sources/xalan/usagepatterns.xml
  
  Index: usagepatterns.xml
  ===================================================================
  RCS file: /home/cvs/xml-xalan/java/xdocs/sources/xalan/usagepatterns.xml,v
  retrieving revision 1.57
  retrieving revision 1.58
  diff -u -r1.57 -r1.58
  --- usagepatterns.xml 7 Jun 2003 21:12:15 -0000       1.57
  +++ usagepatterns.xml 17 Jun 2003 20:16:57 -0000      1.58
  @@ -250,7 +250,7 @@
   <p>An XML Source may include an <jump 
href="http://www.w3.org/TR/xml-stylesheet/";>xml-stylesheet processing 
instruction</jump> which identifies the stylesheet to be used to process the document. 
As indicated by the processing instruction <ref>href</ref> attribute, the stylesheet 
itself may be embedded in the XML document or located elsewhere.</p>
   <p>Suppose you have an XML document (foo.xml) with the following xml-stylesheet 
processing instruction:</p>
   <p><code>&lt;?xml-stylesheet type="text/xml" href="foo.xsl"?&gt;</code></p>
  -<p>The following fragment, uses this instruction to locate the stylesheet (foo.xsl 
in the same directory as foo.xml) and create a Templates object. Note the use of the 
TransformerFactory getAssociatedStylesheet() in step 2a.</p>
  +<p>The following fragment uses this instruction to locate the stylesheet (foo.xsl 
in the same directory as foo.xml) and create a Templates object. Note the use of the 
TransformerFactory getAssociatedStylesheet() in step 2a.</p>
   <note>An XML document may include more than one xml-stylesheet processing 
instruction, hence the support for working with multiple stylesheets. If more than one 
stylesheet is returned, the other stylesheets are imported into the first 
stylesheet.</note>
   <source>// 1. Instantiate the TransformerFactory.
   javax.xml.transform.TransformerFactory tFactory = 
  @@ -258,7 +258,7 @@
   // 2a. Get the stylesheet from the XML source.
   String media = null , title = null, charset = null;
   javax.xml.transform.Source stylesheet = tFactory.getAssociatedStylesheet
  -                   (new StreamSource("foo.xml"),media, title, charset);
  +                   (new StreamSource("foo.xml"), media, title, charset);
   
   // 2b. Process the stylesheet and generate a Transformer.
   Transformer transformer = tFactory.newTransformer(stylesheet);
  @@ -291,7 +291,7 @@
   <s2 title="Explicitly working with SAX">
     <p>&xslt4j; uses the SAX event model to process stylesheets, to parse XML input 
documents, and to produce output. For each of these operations, an XMLReader reads 
input, firing parse events, and a ContentHandler listens to the XMLReader and executes 
parse event methods.</p>
   <p>When you use the basic procedure described above for performing transformations, 
&xslt4j; takes care of many of the SAX details under the covers. You are free to make 
these details explicit, which simply means that you can intervene in the procedure to 
accommodate the precise environment in which your application operates.</p>
  -<p>Suppose, for example, you are using a custom XMLReader, perhaps doing more than 
just parsing static XML documents) to generate &xslt4j; SAX parse events. You might 
even have a custom reader for producing/processing stylesheets. You can cast the 
TransformerFactory to a SAXTransformerFactory, which provides access to a 
TransformerHandler, which you can set as the ContentHandler for this reader.</p>
  +<p>Suppose, for example, you are using a custom XMLReader (perhaps for doing more 
than just parsing static XML documents) to generate &xslt4j; SAX parse events. You 
might even have a custom reader for producing/processing stylesheets. You can cast the 
TransformerFactory to a SAXTransformerFactory, which provides access to a 
TransformerHandler, which you can set as the ContentHandler for this reader.</p>
     <p>The following example explicitly sets up the XMLReader and ContentHandlers, 
and replicates the <link anchor="basic">basic steps</link> described above.</p>
     <source>// Instantiate a TransformerFactory.
   javax.xml.transform.TransformerFactory tFactory = 
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to