Author: veithen
Date: Sat Nov 27 18:45:24 2010
New Revision: 1039718
URL: http://svn.apache.org/viewvc?rev=1039718&view=rev
Log:
* AXIS2-4896: Updated the installation instructions for the Eclipse plugins.
* Fixed a formatting issue in wsdl2java-plugin.xml.
Added:
axis/axis2/java/core/trunk/src/site/xdoc/tools/eclipse/plugin-installation.xml
(with props)
Modified:
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
Added:
axis/axis2/java/core/trunk/src/site/xdoc/tools/eclipse/plugin-installation.xml
URL:
http://svn.apache.org/viewvc/axis/axis2/java/core/trunk/src/site/xdoc/tools/eclipse/plugin-installation.xml?rev=1039718&view=auto
==============================================================================
---
axis/axis2/java/core/trunk/src/site/xdoc/tools/eclipse/plugin-installation.xml
(added)
+++
axis/axis2/java/core/trunk/src/site/xdoc/tools/eclipse/plugin-installation.xml
Sat Nov 27 18:45:24 2010
@@ -0,0 +1,69 @@
+<?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
+ ~ distributed with this work for additional information
+ ~ regarding copyright ownership. The ASF licenses this file
+ ~ to you under the Apache License, Version 2.0 (the
+ ~ "License"); you may not use this file except in compliance
+ ~ with the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing,
+ ~ software distributed under the License is distributed on an
+ ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ ~ KIND, either express or implied. See the License for the
+ ~ specific language governing permissions and limitations
+ ~ under the License.
+ -->
+<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>Eclipse plugin installation</title>
+ </properties>
+ <body>
+ <h1>Eclipse plugin installation</h1>
+ <section name="Introduction">
+ <p>
+ This document provides instructions for installating of the
two Eclipse plugins provided by Axis2
+ (<a href="servicearchiver-plugin.html">Service Archive
Generator</a> and
+ <a href="wsdl2java-plugin.html">Code Generator Wizard</a>).
+ The two plugins should work on Eclipse version 3.1 and
upwards, and require at least Java 1.5.
+ The installation procedure is the same for both plugins, but
depends on the Eclipse
+ version being used. To determine which procedure to use, check
if there is a
+ <tt>dropins</tt> folder in the Eclipse installation directory.
This folder is used
+ by the p2 provisioning system introduced in recent Eclipse
version. It should be
+ present starting with Eclipse version 3.4.
+ </p>
+ </section>
+ <section name="Installation using the dropins directory">
+ <p>
+ If your Eclipse version uses p2, use the following procedure
to install the
+ Axis2 plugins:
+ </p>
+ <ol>
+ <li><a href="../index.html">Download</a> the ZIP file for the
plugin you want to install.</li>
+ <li>Extract the content of the <tt>plugins</tt> folder in the
ZIP archive into the
+ <tt>dropins</tt> folder (i.e. do <b>not</b> create a
<tt>plugins</tt> folder under <tt>dropins</tt>).</li>
+ </ol>
+ <p>
+ As explained <a
href="http://wiki.eclipse.org/Equinox_p2_Getting_Started#Dropins";>here</a>,
+ it is possible to use other directory layouts in the
<tt>dropins</tt> folder.
+ </p>
+ </section>
+ <section name="Installation on older Eclipse versions">
+ <p>
+ If you have an older Eclipse version that doesn't support p2
yet, use the following
+ procedure to install the Axis2 plugins:
+ </p>
+ <ol>
+ <li><a href="../index.html">Download</a> the ZIP file for the
plugin you want to install.</li>
+ <li>Extract the content of the ZIP archive into the Eclipse
installation directory.
+ This should add one or more JAR files and/or directories to
the existing <tt>plugins</tt>
+ folder.</li>
+ </ol>
+ </section>
+ </body>
+</document>
Propchange:
axis/axis2/java/core/trunk/src/site/xdoc/tools/eclipse/plugin-installation.xml
------------------------------------------------------------------------------
svn:eol-style = native
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=1039718&r1=1039717&r2=1039718&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:45:24 2010
@@ -37,20 +37,10 @@
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>
+ <p>
+ Installation instructions for the plugin can be found
+ <a href="plugin-installation.html">here</a>.
+ </p>
</section>
<section name="Operation">
<p>If the plug-in is properly installed you should see a new wizard
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=1039718&r1=1039717&r2=1039718&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:45:24 2010
@@ -41,109 +41,101 @@
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>
+ <p>
+ Installation instructions for the plugin can be found
+ <a href="plugin-installation.html">here</a>.
+ </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>
+ <subsection name="WSDL2Java">
+ <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>
+ </subsection>
+ <subsection name="Java2WSDL">
+ <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>
+ </subsection>
</section>
<section name="Appendix">
<ul>
