I agree - I once had to unpick some generated HTML in one of the Axis docs.
By all means use your favourite HTML editor - as long as it's emacs or vi ;
-)
Glyn
Glen Daniels
<gdaniels@macrome To: undisclosed-recipients:;,
"'[EMAIL PROTECTED]'"
dia.com> <[EMAIL PROTECTED]>
cc:
14/03/02 22:39 Subject: RE: cvs commit:
xml-axis/java/docs user-guide.html
Please respond to
axis-dev
Grr.
Apparently, I haven't looked at the User's Guide in a really long time.
This is my fault for not noticing for three months (!), but if you take a
look at the diffs between version 1.30 and 1.31, you'll notice that a
really huge amount of all the nice HTML formatting that was in the doc
before (<p></p>s on paragraphs, well-formatted <pre> sections, etc)
apparently disappeared. Rich, did you use some horrible HTML mangling
editor to do that edit???
I spent a lot of time getting that formatting to look good, and I'm a
little cheesed that it's gone (and I'm somewhat surprised noone commented
on the fact that the XML examples looked terrible all of a sudden). Alas,
I'm not going to have time to work much on this tonight, but we should do a
style/cleanup pass on the document at some point in the not-too-distant
future. Once this is fixed up nicely, I would request that people be
really careful about what tools they use to edit these docs....
--Glen
> -----Original Message-----
> From: [EMAIL PROTECTED] [mailto:[EMAIL PROTECTED]]
> Sent: Thursday, March 14, 2002 5:25 PM
> To: [EMAIL PROTECTED]
> Subject: cvs commit: xml-axis/java/docs user-guide.html
>
>
> gdaniels 02/03/14 14:25:14
>
> Modified: java/docs user-guide.html
> Log:
> Update version, fix some formatting (when did this get broken?)
>
> Revision Changes Path
> 1.47 +57 -83 xml-axis/java/docs/user-guide.html
>
> Index: user-guide.html
> ===================================================================
> RCS file: /home/cvs/xml-axis/java/docs/user-guide.html,v
> retrieving revision 1.46
> retrieving revision 1.47
> diff -u -r1.46 -r1.47
> --- user-guide.html 14 Mar 2002 19:16:42 -0000 1.46
> +++ user-guide.html 14 Mar 2002 22:25:14 -0000 1.47
> @@ -24,7 +24,7 @@
>
> <h1>
> Axis User's Guide</h1>
> -<i>Alpha 3 Version</i>
> +<i>Beta 1 Version</i>
> <h3>
> Table of Contents</h3>
>
> @@ -139,67 +139,30 @@
> What's in this release?</h3>
> This release includes the following features:
> <ul>
> -<li>
> -SOAP 1.1 compliant engine</li>
> -
> -<li>
> -Flexible configuration / deployment system</li>
> -
> -<li>
> -Support for "drop-in" deployment of SOAP services (JWS)</li>
> -
> -<li>
> -Support for all basic types, and a type mapping system for
> defining new
> -serializers/deserializers</li>
> -
> -<li>
> -Automatic serialization/deserialization of Java Beans</li>
> -
> -<li>
> -Automatic two-way conversions between Java "List"
> collections and SOAP
> -Arrays</li>
> -
> -<li>
> -Providers for RPC and message based SOAP services</li>
> -
> -<li>
> -Automatic WSDL generation from deployed services</li>
> -
> -<li>
> -WSDL2Java tool for building Java proxies and skeletons
> from WSDL documents</li>
> -
> -<li>
> -Java2WSDL tool for building WSDL from Java classes.</li>
> -
> -<li>
> -Preliminary security extensions, which can integrate with
> Servlet 2.2 security/roles</li>
> -
> -<li>
> -An EJB provider for accessing EJB's as Web Services</li>
> -
> -<li>
> -HTTP servlet-based transport</li>
> -
> -<li>
> -Standalone version of the server (with HTTP support)</li>
> -
> -<li>
> -Examples, including a client and server for the
> soapbuilders community
> -interoperability tests</li>
> + <li> SOAP 1.1 compliant engine</li>
> + <li> Flexible configuration / deployment system</li>
> + <li> Support for "drop-in" deployment of SOAP services (JWS)</li>
> + <li> Support for all basic types, and a type mapping
> system for defining new
> + serializers/deserializers</li>
> + <li> Automatic serialization/deserialization of Java Beans</li>
> + <li> Automatic two-way conversions between Java "List"
> collections and SOAP
> + Arrays</li>
> + <li> Providers for RPC and message based SOAP services</li>
> + <li> Automatic WSDL generation from deployed services</li>
> + <li> WSDL2Java tool for building Java proxies and
> skeletons from WSDL documents</li>
> + <li> Java2WSDL tool for building WSDL from Java classes.</li>
> + <li> Preliminary security extensions, which can
> integrate with Servlet 2.2 security/roles</li>
> + <li>Preliminary support for the <b>SOAP with
> Attachments</b> specification</li>
> + <li> An EJB provider for accessing EJB's as Web Services</li>
> + <li> HTTP servlet-based transport</li>
> + <li> Standalone version of the server (with HTTP support)</li>
> + <li> Examples, including a client and server for the
> soapbuilders community
> + interoperability tests</li>
> </ul>
>
> -<h3>
> -What's missing?</h3>
> -
> -<ul>
> -<li>
> -Support for the SOAP with Attachments specification</li>
> +<h3> What's missing?</h3>
>
> -<li>
> -Support for the SOAP actor attribute</li>
> -
> -</ul>
> -All of these items are on the list for the final release.
> +<p>TBD</p>
> <h2>
> <a NAME="Installation"></a>Installing Axis and Using this
> Guide</h2>
> See the <a href="install.html">Axis Installation Guide</a>
> @@ -214,7 +177,7 @@
> <li>xml-axis-beta1/lib/tt-bytecode.jar</li>
> <li>xml-axis-beta1/lib/wsdl4j.jar</li>
> <li>xml-axis-beta1/ # for the sample code</li>
> -<li>An XML parser such as xerces</li>
> + <li>A JAXP-1.1 compliant XML parser such as xerces or
> crimson</li>
> </ul>
> <h2>
> <a NAME="ConsumingServices"></a>Consuming Web Services
> with Axis</h2>
> @@ -320,30 +283,41 @@
> from client.invoke(). Let's take a moment and investigate
> how this happens,
> which sheds light on a potential problem (to which, of
> course, we have
> a solution - so don't fret :)).
> -<p>Here's what a typical response might look like to the
> echoString method:
> -<div class="xml"><?xml version="1.0" encoding="UTF-8"?>
> <SOAP-ENV:Envelope
> -xmlns:xsd="http://www.w3.org/2001/XMLSchema";
> xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/";
> -xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";>
> <SOAP-ENV:Body>
> -<ns1:echoStringResponse
> xmlns:ns1="http://soapinterop.org/";> <result
> -<font
> color="#FF0000">xsi:type="xsd:string"</font>>Hello!</result>
> -</ns1:echoStringResponse> </SOAP-ENV:Body>
> </SOAP-ENV:Envelope></div>
> -Take a look at the section which we've highlighted in red
> - that attribute
> -is a schema <b>type declaration</b>, which Axis uses to
> figure out that
> -the contents of that element are, in this case,
> deserializable into a Java
> -String object. Many toolkits put this kind of explicit
> typing information
> -in the XML to make the message "self-describing". On the
> other hand, some
> -toolkits return responses that look like this:
> -<div class="xml"><?xml version="1.0" encoding="UTF-8"?>
> <SOAP-ENV:Envelope
> -xmlns:xsd="http://www.w3.org/2001/XMLSchema";
> xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/";
> -xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";>
> <SOAP-ENV:Body>
> -<ns1:echoStringResponse
> xmlns:ns1="http://soapinterop.org/";> <result>Hello,
> -I'm a string!</result> </ns1:echoStringResponse>
> </SOAP-ENV:Body>
> -</SOAP-ENV:Envelope></div>
> -There's no type in the message, so how do we know what
> Java object we should
> +<p>Here's what a typical response might look like to the
> echoString method: </p>
> +<div class="xml">
> +<pre><?xml version="1.0" encoding="UTF-8"?><br>
> <SOAP-ENV:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema";
> +
> xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/";
> +
> xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";>
> + <SOAP-ENV:Body>
> + <ns1:echoStringResponse xmlns:ns1="http://soapinterop.org/";>
> + <result <font
> color="#FF0000">xsi:type="xsd:string"</font>>Hello!</result>
> + </ns1:echoStringResponse>
> + </SOAP-ENV:Body>
> + </SOAP-ENV:Envelope></pre>
> + </div>
> +<p>Take a look at the section which we've highlighted in
> <font color="#FF0000">red</font>
> +- that attribute is a schema <b>type declaration</b>,
> which Axis uses to figure
> +out that the contents of that element are, in this case,
> deserializable into a
> +Java String object. Many toolkits put this kind of
> explicit typing information
> +in the XML to make the message "self-describing". On the
> other hand, some toolkits
> +return responses that look like this: </p>
> +<div class="xml">
> + <pre><?xml version="1.0" encoding="UTF-8"?>
> +<SOAP-ENV:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema";
> +
> xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/";
> +
> xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";>
> + <SOAP-ENV:Body>
> + <ns1:echoStringResponse xmlns:ns1="http://soapinterop.org/";>
> + <result>Hello, I'm a string!</result>
> + </ns1:echoStringResponse>
> + </SOAP-ENV:Body>
> +</SOAP-ENV:Envelope></pre>
> +</div>
> +<p>There's no type in the message, so how do we know what
> Java object we should
> deserialize the <result> element into? The answer is
> <b>metadata</b>
> - data about data. In this case, we need a
> <b>description</b> of the service
> that tells us what to expect as the return type. Here's
> how to do it on
> -the client side in Axis:
> +the client side in Axis:</p>
> <div class="example">
> <pre> call.setReturnType(
> org.apache.axis.encoding.XMLType.XSD_STRING );</pre>
> </div>
> @@ -402,12 +376,12 @@
> are using your service.
> <h4>
> <a NAME="descriptors"></a>Deploying via descriptors</h4>
> -To really use the flexibility available to you in Axis,
> you should get
> +<p>To really use the flexibility available to you in Axis,
> you should get
> familiar with the Axis <b>Web Service Deployment
> Descriptor (WSDD)</b>
> format. A deployment descriptor contains a bunch of things
> you want to
> "deploy" into Axis - i.e. make available to the Axis
> engine. The most common
> thing to deploy is a Web Service, so let's start by taking
> a look at a
> -deployment descriptor for a basic service (this file is <a
> href="../samples/userguide/example3/deploy.wsdd">samples/userg
> uide/example3/deploy.wsdd</a>):
> +deployment descriptor for a basic service (this file is <a
> href="../samples/userguide/example3/deploy.wsdd">samples/userg
> uide/example3/deploy.wsdd</a>):</p>
> <div class="example">
> <pre><deployment xmlns="http://xml.apache.org/axis/wsdd/";
>
> &n
> bsp; xmlns:java="http://xml.apache.org/axis/wsdd/providers/java";>
>
>
>
>
