You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-commits@axis.apache.org by ve...@apache.org on 2010/11/27 19:02:56 UTC
svn commit: r1039712 - in /axis/axis2/java/core/trunk: pom.xml
src/site/xdoc/tools/eclipse/servicearchiver-plugin.xml
src/site/xdoc/tools/eclipse/wsdl2java-plugin.xml
Author: veithen
Date: Sat Nov 27 18:02:55 2010
New Revision: 1039712
URL: http://svn.apache.org/viewvc?rev=1039712&view=rev
Log:
Converted the Eclipse plugin documentation to real Xdoc documents. Also upgraded the maven-site-plugin to solve an issue with the toc macro.
Modified:
axis/axis2/java/core/trunk/pom.xml
axis/axis2/java/core/trunk/src/site/xdoc/tools/eclipse/servicearchiver-plugin.xml
axis/axis2/java/core/trunk/src/site/xdoc/tools/eclipse/wsdl2java-plugin.xml
Modified: axis/axis2/java/core/trunk/pom.xml
URL: http://svn.apache.org/viewvc/axis/axis2/java/core/trunk/pom.xml?rev=1039712&r1=1039711&r2=1039712&view=diff
==============================================================================
--- axis/axis2/java/core/trunk/pom.xml (original)
+++ axis/axis2/java/core/trunk/pom.xml Sat Nov 27 18:02:55 2010
@@ -584,6 +584,10 @@
<preparationGoals>clean install</preparationGoals>
</configuration>
</plugin>
+ <plugin>
+ <artifactId>maven-site-plugin</artifactId>
+ <version>2.1.1</version>
+ </plugin>
</plugins>
</pluginManagement>
<plugins>
Modified: axis/axis2/java/core/trunk/src/site/xdoc/tools/eclipse/servicearchiver-plugin.xml
URL: http://svn.apache.org/viewvc/axis/axis2/java/core/trunk/src/site/xdoc/tools/eclipse/servicearchiver-plugin.xml?rev=1039712&r1=1039711&r2=1039712&view=diff
==============================================================================
--- axis/axis2/java/core/trunk/src/site/xdoc/tools/eclipse/servicearchiver-plugin.xml (original)
+++ axis/axis2/java/core/trunk/src/site/xdoc/tools/eclipse/servicearchiver-plugin.xml Sat Nov 27 18:02:55 2010
@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Licensed to the Apache Software Foundation (ASF) under one
~ or more contributor license agreements. See the NOTICE file
@@ -16,174 +17,165 @@
~ specific language governing permissions and limitations
~ under the License.
-->
-
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta name="generator" content=
-"HTML Tidy for Windows (vers 14 June 2007), see www.w3.org" />
-<meta http-equiv="content-type" content="" />
-<title>Service Archive Generator Wizard Guide for Eclipse
-Plug-in</title>
-</head>
-<body lang="en" xml:lang="en">
-<h1>Service Archive Generator Wizard Guide for Eclipse Plug-in</h1>
-<p>This document will guide you through the installation and usage
-of the archive generator Eclipse plug-in.</p>
-<p><a href="../index.html" target=
-"_blank">[Download Plugin Tool]</a></p>
-<h2>Content</h2>
-<ul>
-<li><a href="#intro">Introduction</a></li>
-<li><a href="#installation">Installation</a></li>
-<li><a href="#operation">Operation</a></li>
-</ul>
-<a name="intro" id="intro"></a>
-<h2>Introduction</h2>
-<p>As part of the Axis2 tool set, the service archive generator is
-an important tool that allows the generation of service archives
-("aar" file or a "jar" files) that can be deployed as a web
-services to the Axis2.</p>
-<a name="installation" id="installation"></a>
-<h2>Installation</h2>
-<p>One can easily <a href=
-"../index.html">download</a> the
-plugin</p>
-<p>If one needs to build the plug-in from source, Maven2 and Ant
-builds arevailabe. Please refer the readme.txt located at
-module/tools on Axis2 source.</p>
-<p>Once you've obtained the plug-in just unzip the content of the
-plug-in archive to the Eclipse plug-in directory (if it is the
-zipped-binary version) or copy the necessary folders to the Eclipse
-plug-in directory and restart Eclipse.</p>
-<p><strong>NOTE</strong> : This plug-in works on Eclipse version
-3.1 and upwards, also the java version should be 1.4 or higher. The
-provided screen shots may slightly differ with what the user would
-actually see but the functionality has not been changed.</p>
-<a name="operation" id="operation"></a>
-<h2>Operation</h2>
-<p>If the plug-in is properly installed you should see a new wizard
-under the "New" section. (Use the File -> New -> Other or
-Ctrl + N )</p>
-<p align="center"><img border="0" src=
-"images/ServiceWizardSelection.jpg" /></p>
-<p>Selecting the wizard and pressing the "Next" button will start
-the service generator wizard. Following is the first page of the
-wizard.</p>
-<p><strong>Page 1:</strong></p>
-<p align="center"><img border="0" src=
-"images/ServicePage1.jpg" /></p>
-<p>Once the class file folder(which should be a folder in the
-file system) is browsed and selected, the "Next" button will be
-enabled and you can move to the next page. Note that you have the
-option of either including all the files or the class files only of
-the folder on page 1.</p>
-<p><strong>Page 2:</strong></p>
-<p>Page 2 of the wizard as seen below requires you to locate/browse
-the WSDL file. If you do not wish to add a WSDL file to the service
-archive, select skip WSDL, else you can select the location of the
-WSDL file by selecting the select WSDL option.</p>
-<p align="center"><img border="0" src=
-"images/service_page2.jpg" /></p>
-<p><strong>Page 3:</strong></p>
-<p>Select the services.xml file on this wizard page by browsing or
-select the option of generating service xml automatically, after
-which you can click "Next" button to go to the next page. Notice
-how the browsing option disables when the "Generate service xml
-automatically" check box is ticked.</p>
-<p align="center"><img border="0" src=
-"images/service_page3.jpg" /></p>
-<!--
-<p>Note that The service XML file can be generated if needed. To proceed
-to the service generation page, check the "generate automatically" checkbox. </p>
-<p align="center"><img border="0" src="service_page3_hl.jpg"></p>
-
-<p>If the automatic mode is not selected then the wizard
-will directly jump to the library selection page. However if the automatic mode is selected the wizard will show the
-following page</p>
-<p align="center"><img border="0" src="service_page4_plain.JPG" width="500" height="500"></p>
-<p>This is a somewhat complicated page. The service name textbox should include the name of the service that you
-wish to give this service.
-For the implementation class type in the fully qualified class name and hit the load button to view the operations</p>
-<p align="center"><img border="0" src="service_page4_load.JPG" ></p>
-<p> The loaded operations should be displayed in a table. Once this is displayed you can filter the methods by selecting/deselecting the methods using the checkbox at each row.</p>
-<p align="center"><img border="0" src="service_page4_table.JPG" width="500" height="500"></p>
-<p>Further filtering can be achieved by using the "search declared methods" only checkbox</p>
-<p align="center"><img border="0" src="service_page4_search_declared.JPG" ></p>
-<p>Once the method selection is complete the wizard has enough information to generate a basic services.xml file. If further customization is required, there's no choice but to manually edit it!</p>
-
--->
-<p><strong>Page 4:</strong></p>
-<!--START-->
-<p>The next step is to add the libraries. The library addition page
-looks like this :</p>
-<p align="center"><img border="0" src=
-"images/service_page5.jpg" /></p>
-<p>The library name (with full path) can be either typed on the
-text box or browsed for using the "Browse" button.</p>
-<p align="center"><img border="0" src=
-"images/service_page5_browsed.jpg" /></p>
-<p>Once there is a library name with full path on the text box, hit
-the "Add" button to add the library to the list. Added libraries
-should be displayed in the "Added libraries" list box. This way you
-can add as many external libraries as you wish. See the screen
-shots below.</p>
-<p align="center"><img border="0" src=
-"images/service_page5_hl.jpg" /></p>
-<p align="center"><img border="0" src=
-"images/service_page5_added.jpg" /></p>
-<p>If any added library needs to be removed, highlight it or in
-other words, select it from the "Added libraries" list and hit on
-the "Remove" button as shown below. Click on the "Next" button to
-proceed to the last page of the wizard if the user did not select
-to auto generate the services.xml file. If user select to auto
-generate the services.xml file then the services.xml option page
-will be displayed.</p>
-<p align="center"><img border="0" src=
-"images/service_page5_remove.jpg" /></p>
-<p><strong>Page 5:</strong></p>
-<p>This page only appears if the user select to generate the
-services.xml at page 3 of the wizard. If the user have selected a
-services.xml then the user will be directed to the last page of the
-wizard.</p>
-<p>After entering the correct service name and valid fully
-qualified class name, try to load the existing methods of that
-class by clicking the load button.</p>
-<p align="center"><img border="0" src=
-"images/service_page4_load.jpg" /></p>
-<p>If successfully loaded the user will be presented with a table
-at the bottom of the page with the details of the loaded class. By
-checking and unchecking the user can select the necessary methods
-to include in the services.xml</p>
-<p align="center"><img border="0" src=
-"images/service_page4_table.jpg" /></p>
-<p>By clicking on the search declared method only check box, the
-user can remove the inherited methods from the class. Click on the
-"Next" button to proceed to the last page of the wizard</p>
-<p align="center"><img border="0" src=
-"images/service_page4_search_declared.jpg" /></p>
-<p><strong>Page 6:</strong></p>
-<p>The last page of the wizard asks for the output file location
-and the output archive file name. To be able to finish the wizard,
-user must enter valid output file location and output file
-name.</p>
-<p align="center"><img border="0" src=
-"images/service_page6.jpg" /></p>
-<p>Once all the parameters are filled, hit the "Finish" button to
-complete the wizard and generate the service archive.</p>
-<p align="center"><img border="0" src=
-"images/success_msg.jpg" /></p>
-<p>If you see the above message, then you've successfully generated
-the service archive! This service archive can be hot deployed
-(deployed at run time) to the axis2</p>
-<h1>Appendix</h1>
-<ul>
-<li>Eclipse reference - <a href="http://www.eclipse.org/" target=
-"_blank">http://www.eclipse.org/</a></li>
-<li>Custom Ant Tasks - <a href=
-"http://ant.apache.org/manual/develop.html" target=
-"_blank">http://ant.apache.org/manual/develop.html</a></li>
-</ul>
-</body>
-</html>
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
+ <properties>
+ <title>Service Archive Generator Wizard Guide for Eclipse Plug-in</title>
+ </properties>
+ <body>
+ <h1>Service Archive Generator Wizard Guide for Eclipse Plug-in</h1>
+ <p>This document will guide you through the installation and usage
+ of the archive generator Eclipse plug-in.</p>
+ <p><a href="../index.html" target=
+ "_blank">[Download Plugin Tool]</a></p>
+ <macro name="toc"/>
+ <section name="Introduction">
+ <p>As part of the Axis2 tool set, the service archive generator is
+ an important tool that allows the generation of service archives
+ ("aar" file or a "jar" files) that can be deployed as a web
+ services to the Axis2.</p>
+ </section>
+ <section name="Installation">
+ <p>One can easily <a href=
+ "../index.html">download</a> the
+ plugin</p>
+ <p>If one needs to build the plug-in from source, Maven2 and Ant
+ builds arevailabe. Please refer the readme.txt located at
+ module/tools on Axis2 source.</p>
+ <p>Once you've obtained the plug-in just unzip the content of the
+ plug-in archive to the Eclipse plug-in directory (if it is the
+ zipped-binary version) or copy the necessary folders to the Eclipse
+ plug-in directory and restart Eclipse.</p>
+ <p><strong>NOTE</strong> : This plug-in works on Eclipse version
+ 3.1 and upwards, also the java version should be 1.4 or higher. The
+ provided screen shots may slightly differ with what the user would
+ actually see but the functionality has not been changed.</p>
+ </section>
+ <section name="Operation">
+ <p>If the plug-in is properly installed you should see a new wizard
+ under the "New" section. (Use the File -> New -> Other or
+ Ctrl + N )</p>
+ <p align="center"><img alt="ServiceWizardSelection" src=
+ "images/ServiceWizardSelection.jpg" /></p>
+ <p>Selecting the wizard and pressing the "Next" button will start
+ the service generator wizard. Following is the first page of the
+ wizard.</p>
+ <p><strong>Page 1:</strong></p>
+ <p align="center"><img alt="ServicePage1" src=
+ "images/ServicePage1.jpg" /></p>
+ <p>Once the class file folder(which should be a folder in the
+ file system) is browsed and selected, the "Next" button will be
+ enabled and you can move to the next page. Note that you have the
+ option of either including all the files or the class files only of
+ the folder on page 1.</p>
+ <p><strong>Page 2:</strong></p>
+ <p>Page 2 of the wizard as seen below requires you to locate/browse
+ the WSDL file. If you do not wish to add a WSDL file to the service
+ archive, select skip WSDL, else you can select the location of the
+ WSDL file by selecting the select WSDL option.</p>
+ <p align="center"><img alt="service_page2" src=
+ "images/service_page2.jpg" /></p>
+ <p><strong>Page 3:</strong></p>
+ <p>Select the services.xml file on this wizard page by browsing or
+ select the option of generating service xml automatically, after
+ which you can click "Next" button to go to the next page. Notice
+ how the browsing option disables when the "Generate service xml
+ automatically" check box is ticked.</p>
+ <p align="center"><img alt="service_page3" src=
+ "images/service_page3.jpg" /></p>
+ <!--
+ <p>Note that The service XML file can be generated if needed. To proceed
+ to the service generation page, check the "generate automatically" checkbox. </p>
+ <p align="center"><img border="0" src="service_page3_hl.jpg"></p>
+
+ <p>If the automatic mode is not selected then the wizard
+ will directly jump to the library selection page. However if the automatic mode is selected the wizard will show the
+ following page</p>
+ <p align="center"><img border="0" src="service_page4_plain.JPG" width="500" height="500"></p>
+ <p>This is a somewhat complicated page. The service name textbox should include the name of the service that you
+ wish to give this service.
+ For the implementation class type in the fully qualified class name and hit the load button to view the operations</p>
+ <p align="center"><img border="0" src="service_page4_load.JPG" ></p>
+ <p> The loaded operations should be displayed in a table. Once this is displayed you can filter the methods by selecting/deselecting the methods using the checkbox at each row.</p>
+ <p align="center"><img border="0" src="service_page4_table.JPG" width="500" height="500"></p>
+ <p>Further filtering can be achieved by using the "search declared methods" only checkbox</p>
+ <p align="center"><img border="0" src="service_page4_search_declared.JPG" ></p>
+ <p>Once the method selection is complete the wizard has enough information to generate a basic services.xml file. If further customization is required, there's no choice but to manually edit it!</p>
+
+ -->
+ <p><strong>Page 4:</strong></p>
+ <!--START-->
+ <p>The next step is to add the libraries. The library addition page
+ looks like this :</p>
+ <p align="center"><img alt="service_page5" src=
+ "images/service_page5.jpg" /></p>
+ <p>The library name (with full path) can be either typed on the
+ text box or browsed for using the "Browse" button.</p>
+ <p align="center"><img alt="service_page5_browsed" src=
+ "images/service_page5_browsed.jpg" /></p>
+ <p>Once there is a library name with full path on the text box, hit
+ the "Add" button to add the library to the list. Added libraries
+ should be displayed in the "Added libraries" list box. This way you
+ can add as many external libraries as you wish. See the screen
+ shots below.</p>
+ <p align="center"><img alt="service_page5_hl" src=
+ "images/service_page5_hl.jpg" /></p>
+ <p align="center"><img alt="service_page5_added" src=
+ "images/service_page5_added.jpg" /></p>
+ <p>If any added library needs to be removed, highlight it or in
+ other words, select it from the "Added libraries" list and hit on
+ the "Remove" button as shown below. Click on the "Next" button to
+ proceed to the last page of the wizard if the user did not select
+ to auto generate the services.xml file. If user select to auto
+ generate the services.xml file then the services.xml option page
+ will be displayed.</p>
+ <p align="center"><img alt="service_page5_remove" src=
+ "images/service_page5_remove.jpg" /></p>
+ <p><strong>Page 5:</strong></p>
+ <p>This page only appears if the user select to generate the
+ services.xml at page 3 of the wizard. If the user have selected a
+ services.xml then the user will be directed to the last page of the
+ wizard.</p>
+ <p>After entering the correct service name and valid fully
+ qualified class name, try to load the existing methods of that
+ class by clicking the load button.</p>
+ <p align="center"><img alt="service_page4_load" src=
+ "images/service_page4_load.jpg" /></p>
+ <p>If successfully loaded the user will be presented with a table
+ at the bottom of the page with the details of the loaded class. By
+ checking and unchecking the user can select the necessary methods
+ to include in the services.xml</p>
+ <p align="center"><img alt="service_page4_table" src=
+ "images/service_page4_table.jpg" /></p>
+ <p>By clicking on the search declared method only check box, the
+ user can remove the inherited methods from the class. Click on the
+ "Next" button to proceed to the last page of the wizard</p>
+ <p align="center"><img alt="service_page4_search_declared" src=
+ "images/service_page4_search_declared.jpg" /></p>
+ <p><strong>Page 6:</strong></p>
+ <p>The last page of the wizard asks for the output file location
+ and the output archive file name. To be able to finish the wizard,
+ user must enter valid output file location and output file
+ name.</p>
+ <p align="center"><img alt="service_page6" src=
+ "images/service_page6.jpg" /></p>
+ <p>Once all the parameters are filled, hit the "Finish" button to
+ complete the wizard and generate the service archive.</p>
+ <p align="center"><img alt="success_msg" src=
+ "images/success_msg.jpg" /></p>
+ <p>If you see the above message, then you've successfully generated
+ the service archive! This service archive can be hot deployed
+ (deployed at run time) to the axis2</p>
+ </section>
+ <section name="Appendix">
+ <ul>
+ <li>Eclipse reference - <a href="http://www.eclipse.org/" target=
+ "_blank">http://www.eclipse.org/</a></li>
+ <li>Custom Ant Tasks - <a href=
+ "http://ant.apache.org/manual/develop.html" target=
+ "_blank">http://ant.apache.org/manual/develop.html</a></li>
+ </ul>
+ </section>
+ </body>
+</document>
Modified: axis/axis2/java/core/trunk/src/site/xdoc/tools/eclipse/wsdl2java-plugin.xml
URL: http://svn.apache.org/viewvc/axis/axis2/java/core/trunk/src/site/xdoc/tools/eclipse/wsdl2java-plugin.xml?rev=1039712&r1=1039711&r2=1039712&view=diff
==============================================================================
--- axis/axis2/java/core/trunk/src/site/xdoc/tools/eclipse/wsdl2java-plugin.xml (original)
+++ axis/axis2/java/core/trunk/src/site/xdoc/tools/eclipse/wsdl2java-plugin.xml Sat Nov 27 18:02:55 2010
@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Licensed to the Apache Software Foundation (ASF) under one
~ or more contributor license agreements. See the NOTICE file
@@ -16,150 +17,141 @@
~ specific language governing permissions and limitations
~ under the License.
-->
-
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta name="generator" content=
-"HTML Tidy for Windows (vers 14 June 2007), see www.w3.org" />
-<meta http-equiv="content-type" content="" />
-<title>Code Generator Wizard Guide for Eclipse Plug-in</title>
-</head>
-<body lang="en" xml:lang="en">
-<h1>Code Generator Wizard Guide for Eclipse Plug-in</h1>
-<p>This document explains the usage of this code generator plug-in
-for Eclipse. In other words, this document will guide you through
-the operations of generating a WSDL file from a Java class and/or
-generating a Java class file from a WSDL file.</p>
-<p><a href="../index.html" target=
-"_blank">[Download Plugin Tool]</a></p>
-<h2>Content</h2>
-<ul>
-<li><a href="#intro">Introduction</a></li>
-<li><a href="#installation">Installation</a></li>
-<li><a href="#operation1">Operation - WSDL2Java</a></li>
-<li><a href="#operation2">Operation - Java2WSDL</a></li>
-</ul>
-<a name="intro" id="intro"></a>
-<h2>Introduction</h2>
-<p>The Axis2 code generator comes built-in with an <a href=
-"http://www.eclipse.org">Eclipse</a> plug-in. This plug-in can be
-used to generate a WSDL file from a java class (Java2WSDL) and/or a
-java class file from a WSDL (WSDL2Java). First you need to install
-the plug-in. The instructions for the installation process are
-given below.</p>
-<a name="installation" id="installation"></a>
-<h2>Installation</h2>
-<p>One can easily <a href=
-"../index.html">download</a> the
-plugin</p>
-<p>If one needs to build the plug-in from source, Maven2 and Ant
-builds arevailabe. Please refer the readme.txt located at
-module/tools on Axis2 source.</p>
-<p>Once you've obtained the plug-in just unzip the content of the
-plug-in archive to the Eclipse plug-in directory (if it is the
-zipped-binary version) or copy the necessary folders to the Eclipse
-plug-in directory and restart Eclipse.</p>
-<p><strong>NOTE</strong> : This plug-in works on Eclipse version
-3.1 and upwards, also the java version should be 1.4 or higher. The
-provided screen shots may slightly differ with what the user would
-actually see but the functionality has not been changed.</p>
-<a name="operation1" id="operation1"></a>
-<h2>Operation - WSDL2Java</h2>
-<p>If the plug-in is properly installed you should see a new wizard
-under the "New" section.(use the File -> New -> Other or Ctrl
-+ N )</p>
-<p><img border="0" src="images/wsdl2java-screen0.png" /></p>
-<p>Selecting the wizard and pressing the "Next" button will start
-the code generator wizard. Following is the first wizard page.</p>
-<p><strong>Page 1:</strong></p>
-<p><img src="images/wsdl2java-screen1.png" /></p>
-<p>Selecting the "Generate Java source code from WSDL file" option
-and clicking "Next" leads to the following page.</p>
-<p><strong>WSDL2Java Page 2 :</strong></p>
-<p><img border="0" src="images/wsdl2java-screen2.png" /></p>
-<p>To move on to the next page the WSDL file location must be
-given. The "Browse" button can be used to easily browse for a file
-rather than typing the whole path.</p>
-<p><strong>WSDL2Java Page 3 :</strong></p>
-<p>Once the WSDL file is selected, the next page will take you to
-the page from where <strong>codegen options</strong> are to be
-selected. By far this is the most important page in this wizard.
-This page determines the characteristics of the code being
-generated.</p>
-<p>Novices need not worry about these options since the most common
-options are defaulted, but advanced users will find it very easy to
-turn the knobs using these options.</p>
-<p><img border="0" src="images/wsdl2java-screen3.png" /></p>
-<p>What advanced users can do is select custom from the select
-codegen options drop down list and then change/edit the fields that
-you need.</p>
-<p><img border="0" src="images/wsdl2java-screen31.png" /></p>
-<p>Once the options are selected, only the final step of the code
-generation is left which is the selection of the output file
-location.</p>
-<p><strong>WSDL2Java Page 4 :</strong></p>
-<p>Here you can select the output file path by typing or browsing
-using the "Browse" button. You have the option of browsing only
-eclipse workspace projects by selecting the "Add the source to a
-project on current eclipse workspace" radio button. Or else you
-have the option to save the codegen resutls to file system</p>
-<p><img border="0" src="images/wsdl2java-screen4.png" /></p>
-<p>Here also you have the option to add some value to the codegen
-results. If you have enabled the check box "Add Axis2 libraries to
-the codegen result project" then all other controls below will get
-enabled. What you can do is point the downloaded Axis2_HOME
-location via the "Browse" button. Then you can verify the
-availability of the Axis2 libs by clicking on the "Check Libs"
-button. If all goes well then you can add the axis 2 libs to the
-codegen results location. Another option is available to generate a
-jar file if the user needs to add the codegen results to a project
-as a compiled jar file to the selected locations lib directory.</p>
-<p><img border="0" src="images/wsdl2java-screen41.png" /></p>
-<p>When the output file location is selected, the "Finish" button
-will be enabled. Clicking the "Finish" button will generate the
-code and a message box will pop up acknowledging the success. Well
-Done! You've successfully completed Axis2 code generation.</p>
-<a name="operation2" id="operation2"></a>
-<h2>Operation - Java2WSDL</h2>
-<p><strong>Page 1:</strong></p>
-<p>For this operation you need to select the option which says
-"Generate a WSDL from a Java source file"</p>
-<p><img border="0" src="images/java2wsdl-screen0.png" /></p>
-<p>Then click the "Next" button which will lead to the next page
-below.</p>
-<p><strong>Java2WSDL Page 2:</strong></p>
-<p><img border="0" src="images/java2wsdl-screen1.png" /></p>
-<p>In this page one needs to select the class to be exposed and the
-relevant jar files /classes to be loaded as the classpath. After
-the libraries have been set, the "Test Class Loading" button must
-be clicked in order to test whether the class is loadable. Unless
-the class loading is successful proceeding to the "Next" button
-will not be enabled.</p>
-<p>Once the classloading is successful and "Next" button is clicked
-the page below will appear.</p>
-<p><strong>Java2WSDL Page 3:</strong></p>
-<p>This page allows the parameters to be modified by setting the
-options for the generator.</p>
-<p><img border="0" src="images/java2wsdl-screen2.png" /></p>
-<p><strong>Java2WSDL Page 4:</strong></p>
-<p>Here you can select the output file path by typing or browsing
-using the "Browse" button. You have the option of browsing only
-Eclipse workspace projects by selecting the "Add the source to a
-project on current eclipse workspace" radio button . Or else you
-have the option to save the codegen resutls to file system. Once
-the output file location and the output WSDL file name is added you
-can click the "Finish" button to complete generation.</p>
-<p><img border="0" src="images/java2wsdl-screen3.png" /></p>
-<p>If a message box pops up acknowledging the success, then you've
-successfully completed the Java2WSDL code generation.</p>
-<h1>Appendix</h1>
-<ul>
-<li>Eclipse reference - <a href=
-"http://www.eclipse.org/">http://www.eclipse.org/</a></li>
-<li>Custom Ant Tasks - <a href=
-"http://ant.apache.org/manual/develop.html">http://ant.apache.org/manual/develop.html</a></li>
-</ul>
-</body>
-</html>
+<document xmlns="http://maven.apache.org/XDOC/2.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
+ <properties>
+ <title>Code Generator Wizard Guide for Eclipse Plug-in</title>
+ </properties>
+ <body>
+ <h1>Code Generator Wizard Guide for Eclipse Plug-in</h1>
+ <p>This document explains the usage of this code generator plug-in
+ for Eclipse. In other words, this document will guide you through
+ the operations of generating a WSDL file from a Java class and/or
+ generating a Java class file from a WSDL file.</p>
+ <p><a href="../index.html" target=
+ "_blank">[Download Plugin Tool]</a></p>
+ <macro name="toc"/>
+ <section name="Introduction">
+ <p>The Axis2 code generator comes built-in with an <a href=
+ "http://www.eclipse.org">Eclipse</a> plug-in. This plug-in can be
+ used to generate a WSDL file from a java class (Java2WSDL) and/or a
+ java class file from a WSDL (WSDL2Java). First you need to install
+ the plug-in. The instructions for the installation process are
+ given below.</p>
+ </section>
+ <section name="Installation">
+ <p>One can easily <a href=
+ "../index.html">download</a> the
+ plugin</p>
+ <p>If one needs to build the plug-in from source, Maven2 and Ant
+ builds arevailabe. Please refer the readme.txt located at
+ module/tools on Axis2 source.</p>
+ <p>Once you've obtained the plug-in just unzip the content of the
+ plug-in archive to the Eclipse plug-in directory (if it is the
+ zipped-binary version) or copy the necessary folders to the Eclipse
+ plug-in directory and restart Eclipse.</p>
+ <p><strong>NOTE</strong> : This plug-in works on Eclipse version
+ 3.1 and upwards, also the java version should be 1.4 or higher. The
+ provided screen shots may slightly differ with what the user would
+ actually see but the functionality has not been changed.</p>
+ </section>
+ <section name="Operation">
+ <p>If the plug-in is properly installed you should see a new wizard
+ under the "New" section.(use the File -> New -> Other or Ctrl
+ + N )</p>
+ <p><img alt="wsdl2java-screen0" src="images/wsdl2java-screen0.png" /></p>
+ <p>Selecting the wizard and pressing the "Next" button will start
+ the code generator wizard. Following is the first wizard page.</p>
+ <p><strong>Page 1:</strong></p>
+ <p><img alt="wsdl2java-screen1" src="images/wsdl2java-screen1.png" /></p>
+ <p>Selecting the "Generate Java source code from WSDL file" option
+ and clicking "Next" leads to the following page.</p>
+ <p><strong>WSDL2Java Page 2 :</strong></p>
+ <p><img alt="wsdl2java-screen2" src="images/wsdl2java-screen2.png" /></p>
+ <p>To move on to the next page the WSDL file location must be
+ given. The "Browse" button can be used to easily browse for a file
+ rather than typing the whole path.</p>
+ <p><strong>WSDL2Java Page 3 :</strong></p>
+ <p>Once the WSDL file is selected, the next page will take you to
+ the page from where <strong>codegen options</strong> are to be
+ selected. By far this is the most important page in this wizard.
+ This page determines the characteristics of the code being
+ generated.</p>
+ <p>Novices need not worry about these options since the most common
+ options are defaulted, but advanced users will find it very easy to
+ turn the knobs using these options.</p>
+ <p><img alt="wsdl2java-screen3" src="images/wsdl2java-screen3.png" /></p>
+ <p>What advanced users can do is select custom from the select
+ codegen options drop down list and then change/edit the fields that
+ you need.</p>
+ <p><img alt="wsdl2java-screen31" src="images/wsdl2java-screen31.png" /></p>
+ <p>Once the options are selected, only the final step of the code
+ generation is left which is the selection of the output file
+ location.</p>
+ <p><strong>WSDL2Java Page 4 :</strong></p>
+ <p>Here you can select the output file path by typing or browsing
+ using the "Browse" button. You have the option of browsing only
+ eclipse workspace projects by selecting the "Add the source to a
+ project on current eclipse workspace" radio button. Or else you
+ have the option to save the codegen resutls to file system</p>
+ <p><img alt="wsdl2java-screen4" src="images/wsdl2java-screen4.png" /></p>
+ <p>Here also you have the option to add some value to the codegen
+ results. If you have enabled the check box "Add Axis2 libraries to
+ the codegen result project" then all other controls below will get
+ enabled. What you can do is point the downloaded Axis2_HOME
+ location via the "Browse" button. Then you can verify the
+ availability of the Axis2 libs by clicking on the "Check Libs"
+ button. If all goes well then you can add the axis 2 libs to the
+ codegen results location. Another option is available to generate a
+ jar file if the user needs to add the codegen results to a project
+ as a compiled jar file to the selected locations lib directory.</p>
+ <p><img alt="wsdl2java-screen41" src="images/wsdl2java-screen41.png" /></p>
+ <p>When the output file location is selected, the "Finish" button
+ will be enabled. Clicking the "Finish" button will generate the
+ code and a message box will pop up acknowledging the success. Well
+ Done! You've successfully completed Axis2 code generation.</p>
+ <a name="operation2" id="operation2"></a>
+ <h2>Operation - Java2WSDL</h2>
+ <p><strong>Page 1:</strong></p>
+ <p>For this operation you need to select the option which says
+ "Generate a WSDL from a Java source file"</p>
+ <p><img alt="java2wsdl-screen0" src="images/java2wsdl-screen0.png" /></p>
+ <p>Then click the "Next" button which will lead to the next page
+ below.</p>
+ <p><strong>Java2WSDL Page 2:</strong></p>
+ <p><img alt="java2wsdl-screen1" src="images/java2wsdl-screen1.png" /></p>
+ <p>In this page one needs to select the class to be exposed and the
+ relevant jar files /classes to be loaded as the classpath. After
+ the libraries have been set, the "Test Class Loading" button must
+ be clicked in order to test whether the class is loadable. Unless
+ the class loading is successful proceeding to the "Next" button
+ will not be enabled.</p>
+ <p>Once the classloading is successful and "Next" button is clicked
+ the page below will appear.</p>
+ <p><strong>Java2WSDL Page 3:</strong></p>
+ <p>This page allows the parameters to be modified by setting the
+ options for the generator.</p>
+ <p><img alt="java2wsdl-screen2" src="images/java2wsdl-screen2.png" /></p>
+ <p><strong>Java2WSDL Page 4:</strong></p>
+ <p>Here you can select the output file path by typing or browsing
+ using the "Browse" button. You have the option of browsing only
+ Eclipse workspace projects by selecting the "Add the source to a
+ project on current eclipse workspace" radio button . Or else you
+ have the option to save the codegen resutls to file system. Once
+ the output file location and the output WSDL file name is added you
+ can click the "Finish" button to complete generation.</p>
+ <p><img alt="java2wsdl-screen3" src="images/java2wsdl-screen3.png" /></p>
+ <p>If a message box pops up acknowledging the success, then you've
+ successfully completed the Java2WSDL code generation.</p>
+ </section>
+ <section name="Appendix">
+ <ul>
+ <li>Eclipse reference - <a href=
+ "http://www.eclipse.org/">http://www.eclipse.org/</a></li>
+ <li>Custom Ant Tasks - <a href=
+ "http://ant.apache.org/manual/develop.html">http://ant.apache.org/manual/develop.html</a></li>
+ </ul>
+ </section>
+ </body>
+</document>