You are viewing a plain text version of this content. The canonical link for it is here.
Posted to axis-cvs@ws.apache.org by ch...@apache.org on 2007/01/29 06:06:19 UTC
svn commit: r500938 - in /webservices/axis2/trunk/java/xdocs: articles.html
download.html guidelines.html maven-help.html refLib.html siteHowTo.html
svn.html
Author: chatra
Date: Sun Jan 28 21:06:18 2007
New Revision: 500938
URL: http://svn.apache.org/viewvc?view=rev&rev=500938
Log:
Reviewed and committing changes in JIRA AXIS2-2036
Modified:
webservices/axis2/trunk/java/xdocs/articles.html
webservices/axis2/trunk/java/xdocs/download.html
webservices/axis2/trunk/java/xdocs/guidelines.html
webservices/axis2/trunk/java/xdocs/maven-help.html
webservices/axis2/trunk/java/xdocs/refLib.html
webservices/axis2/trunk/java/xdocs/siteHowTo.html
webservices/axis2/trunk/java/xdocs/svn.html
Modified: webservices/axis2/trunk/java/xdocs/articles.html
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/articles.html?view=diff&rev=500938&r1=500937&r2=500938
==============================================================================
--- webservices/axis2/trunk/java/xdocs/articles.html (original)
+++ webservices/axis2/trunk/java/xdocs/articles.html Sun Jan 28 21:06:18 2007
@@ -7,15 +7,16 @@
<title>Axis2 Knowledge Base</title>
<meta name="generator" content="amaya 9.2.1, see http://www.w3.org/Amaya/"
/>
- <link href="css/axis-docs.css" rel="stylesheet" type="text/css" media="all" />
+ <link href="css/axis-docs.css" rel="stylesheet" type="text/css" media="all"
+ />
</head>
<body xml:lang="en">
<h1>Apache Axis2 References</h1>
-<p>This page will contain articles, tutorials, presentations and question
-& answer pairs published on various Web sites on Apache Axis2 engine.
-These references will come as great help in boosting your knowledge on
+<p>This page contains articles, tutorials, presentations and question and
+answers published on various Web sites on the Apache Axis2 engine. These
+references will prove to be a great help in boosting your knowledge on
Axis2.</p>
<h2>Articles:</h2>
@@ -113,7 +114,7 @@
<li><a href="http://www.wso2.net/kb/83">How do I Embed SimpleHTTPServer in
My Application and Deploy a POJO?</a>- By Davanum Sirinivas (09 May
2006)</li>
- <li><a href="http://www.wso2.net/kb/209">How to configure Axis2's HTTP
+ <li><a href="http://www.wso2.net/kb/209">How to Configure Axis2's HTTP
Transport Sender at Client Side?</a>- By Saminda Abeysinghe (11July
2006)</li>
<li><a href="http://www.wso2.net/kb/175">How to do REST invocation with
Modified: webservices/axis2/trunk/java/xdocs/download.html
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/download.html?view=diff&rev=500938&r1=500937&r2=500938
==============================================================================
--- webservices/axis2/trunk/java/xdocs/download.html (original)
+++ webservices/axis2/trunk/java/xdocs/download.html Sun Jan 28 21:06:18 2007
@@ -9,7 +9,7 @@
<h2>Apache Axis2 Releases</h2>
<div align="left">
-<p>This page has links to the release versions of Axis2 Java. For more
+<p>This page provides links to the release versions of Axis2 Java. For more
information, please see <a
href="http://www.apache.org/dev/release.html">Apache Release FAQ</a>.</p>
</div>
@@ -78,14 +78,20 @@
</table>
</div>
-<h4>Axis2 Maven Repository</h4>
+<p></p>
-<p>Released Axis2 jars are available <a
-href="http://www.apache.org/dist/java-repository/axis2/">here</a></p>
+<p></p>
-<h4>Nightly Builds</h4>
-Nightly builds of Axis2 <strong>distributions</strong> are available <a
-href="http://cvs.apache.org/dist/axis2/nightly">here</a> <br>
-Nightly SNAPSHOT <strong>Maven Repository</strong> are available <a
-href="http://cvs.apache.org/repository/org.apache.axis2/jars/">here</a></body>
+<h4>Axis2 Distributions : <a
+href="http://cvs.apache.org/dist/axis2/nightly">Nightly builds</a></h4>
+
+<h4>Axis2 Maven Repository: <a
+href="http://www.apache.org/dist/java-repository/axis2/">Released Axis2
+jars</a> | <a
+href="http://cvs.apache.org/repository/org.apache.axis2/jars/">Nightly
+SNAPSHOT</a><a
+href="http://cvs.apache.org/repository/org.apache.axis2/jars/"></a></h4>
+
+<p></p>
+</body>
</html>
Modified: webservices/axis2/trunk/java/xdocs/guidelines.html
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/guidelines.html?view=diff&rev=500938&r1=500937&r2=500938
==============================================================================
--- webservices/axis2/trunk/java/xdocs/guidelines.html (original)
+++ webservices/axis2/trunk/java/xdocs/guidelines.html Sun Jan 28 21:06:18 2007
@@ -1,53 +1,71 @@
-<head>
- <title>Guidelines</title>
- <link href="css/axis-docs.css" rel="stylesheet" type="text/css" media="all" />
-</head>
-<h2>Mail Guideline</h2>
-<p>Every volunteer project obtains its strength from the people involved in it.
-Mailing lists provide a simple and effective communication mechanism. </p>
-<p>You are welcome to join any of our mailing lists (or all of them if you
-wish). You can choose to lurk, or actively participate. It's up to you.</p>
-<p><b>Before you join these lists, you should make sure that you read and follow
-the information below... </b></p>
-<p>We ask that you do your best to respect the charter of the appropriate
-mailing list. There are generally two types of lists that you can join. </p>
-<ul>
- <li>The "User" list is where you should send questions and comments about
- configuration, setup, usage and other "user" types of questions.</li>
- <li>The "Developer" list is where you should should send questions and
- comments about the actual software source code and general "development"
- types of questions. </li>
-</ul>
-<p><b>Summary : Prefix each message with "[Axis2]"</b> <br>
-You may already know that Axis 1.x is still going parallel with Axis 2.0. So for
-everyone's convenience prefix the subject of <b>every mail </b>about Axis 2.0
-with [Axis2].</p>
-<p><b>Summary: Join the lists that are appropriate for your discussion.</b> <br>
-Please make sure that you are joining the list that is appropriate for the topic
-or product that you would like to discuss.</p>
-<p><b>Summary: Do not abuse resources in order to get help.</b> <br>
-Asking your configuration or user type of question on the developers list
-because you think that you will get help more quickly by going directly to the
-developers instead of to the user base is not very nice. Chances are that doing
-this will actually prevent people from answering your question because it is
-clear that you are trying to abuse resources.</p>
-<p><b>Summary: Do your best to ensure that you are not sending HTML or "Stylelized"
-email to the list.</b> <br>
-If you are using Outlook or Outlook Express or Eudora, chances are that you are
-sending HTML email by default. There is usually a setting that will allow you to
-send "Plain Text" email. If you are using Microsoft products to send email,
-there are several bugs in the software that prevent you from turning off the
-sending of HTML email. Please read this page as well...</p>
-<p><b>Summary: Watch where you are sending email.</b> <br>
-The majority of our mailing lists have set the Reply-To to go back to the list.
-That means that when you Reply to a message, it will go to the list and not to
-the original author directly. The reason is because it helps facilitate
-discussion on the list for everyone to benefit from. Be careful of this as
-sometimes you may intend to reply to a message directly to someone instead of
-the entire list.</p>
-<p><b>Summary: Do not crosspost messages.</b> <br>
-In other words, pick a mailing list and send your messages to that mailing list
-only. Do not send your messages to multiple mailing lists. The reason is that
-people may be subscribed to one list and not to the other. Therefore, some
-people may only see half of the conversation. </p>
-<p> </p>
+<html>
+<head>
+ <meta http-equiv="content-type" content="">
+ <title>Guidelines</title>
+ <link href="css/axis-docs.css" rel="stylesheet" type="text/css" media="all">
+</head>
+
+<body>
+<h2>Mail Guideline</h2>
+
+<p>Every volunteer project obtains its strength from the people involved in
+it. Mailing lists provide a simple and effective communication mechanism.</p>
+
+<p>You are welcome to join any of our mailing lists (or all of them if you
+wish). You can choose to lurk, or actively participate. It's up to you.</p>
+
+<p><b>Before you join these lists, you should make sure that you read and
+follow the information below.</b></p>
+
+<p>We ask that you do your best to respect the charter of the appropriate
+mailing list. There are generally two types of lists that you can join.</p>
+<ul>
+ <li>The "User" list is where you should send questions and comments about
+ configuration, setup, usage and other "user" type of questions.</li>
+ <li>The "Developer" list is where you should send questions and comments
+ about the actual software source code and general "development" type of
+ questions.</li>
+</ul>
+
+<p><b>Summary : Prefix each message subject with "[Axis2]"</b> <br>
+You may already know that Axis 1.x is still going parallel with Axis 2.0. So
+for everyone's convenience, prefix the subject of <b>every mail </b>about
+Axis 2.0 with [Axis2].</p>
+
+<p><b>Summary: Join the lists that are appropriate for your discussion.</b>
+<br>
+Please make sure that you are joining the list that is appropriate for the
+topic or product that you would like to discuss.</p>
+
+<p><b>Summary: Do not abuse resources in order to get help.</b> <br>
+Asking your configuration or user type of question on the developers list
+because you think that you will get help more quickly by going directly to
+the developers instead of to the user base is not very nice. Chances are that
+doing this will actually prevent people from answering your question because
+it is clear that you are trying to abuse resources.</p>
+
+<p><b>Summary: Do your best to ensure that you are not sending HTML or
+"Stylelized" email to the list.</b> <br>
+If you are using Outlook or Outlook Express or Eudora, chances are that you
+are sending HTML email by default. There is usually a setting that will allow
+you to send "Plain Text" email. If you are using Microsoft products to send
+email, there are several bugs in the software that prevent you from turning
+off the sending of HTML email. Please read this page as well.</p>
+
+<p><b>Summary: Watch where you are sending email.</b> <br>
+The majority of our mailing lists have set the Reply-To to go back to the
+list. That means that when you Reply to a message, it will go to the list and
+not to the original author directly. The reason is because it helps
+facilitate discussion on the list for everyone to benefit from. Be careful of
+this as sometimes you may intend to reply to a message directly to someone
+instead of the entire list.</p>
+
+<p><b>Summary: Do not crosspost messages.</b> <br>
+In other words, pick a mailing list and send your messages to that mailing
+list only. Do not send your messages to multiple mailing lists. The reason is
+that people may be subscribed to one list and not to the other. Therefore,
+some people may only see half of the conversation.</p>
+
+<p> </p>
+</body>
+</html>
Modified: webservices/axis2/trunk/java/xdocs/maven-help.html
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/maven-help.html?view=diff&rev=500938&r1=500937&r2=500938
==============================================================================
--- webservices/axis2/trunk/java/xdocs/maven-help.html (original)
+++ webservices/axis2/trunk/java/xdocs/maven-help.html Sun Jan 28 21:06:18 2007
@@ -4,7 +4,7 @@
<head>
<title>Quick Guide to Maven for Axis 2.0</title>
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
- <link href="css/axis-docs.css" rel="stylesheet" type="text/css" media="all" />
+ <link href="css/axis-docs.css" rel="stylesheet" type="text/css" media="all">
</head>
<body lang="en">
@@ -13,8 +13,8 @@
<h2 align="left">Introduction</h2>
<p align="left"><a href="http://maven.apache.org">Maven</a> is used as the
-build tool of Axis 2.0. This document will provide a quick guide to use maven
-with your developments.</p>
+build tool of Axis 2.0. This document will provide a quick guide on how to
+use Maven with your developments.</p>
<h2 align="left">Commands</h2>
@@ -37,14 +37,14 @@
</td>
<td>
<div align="left">
- download relevant jars, if not available and compile and run tests of
- the system.</div>
+ Downloads relevant jars if not available, and compiles and runs the
+ tests in the system.</div>
</td>
</tr>
<tr>
<td>maven clean</td>
- <td>Clean all the stuff build so far, that are in the target folder.
- This will not clean the jar repository</td>
+ <td>Cleans all the content built so far in the target folder. This will
+ not clean the jar repository.</td>
</tr>
<tr>
<td>
@@ -53,8 +53,8 @@
</td>
<td>
<div align="left">
- run only the tests. Will do automatic compilation of changed sources
- as well. This will not run soap interop tests</div>
+ Runs only the tests. Performs automatic compilation of the changed
+ sources as well. This will not run SOAP interop tests</div>
</td>
</tr>
<tr>
@@ -64,7 +64,7 @@
</td>
<td>
<div align="left">
- Clean up and run all off line and on line tests</div>
+ Cleans up and runs all offline and online tests</div>
</td>
</tr>
<tr>
@@ -74,7 +74,7 @@
</td>
<td>
<div align="left">
- To run the online-mode tests for say the modules/integration Run
+ To run the online-mode tests for say the modules/integration, run
"maven itest" from modules/integration</div>
</td>
</tr>
@@ -85,7 +85,7 @@
</td>
<td>
<div align="left">
- To run all tests for say the modules/integration Run "maven test
+ To run all the tests for say the modules/integration, run "maven test
itest" from modules/integration</div>
</td>
</tr>
@@ -96,7 +96,7 @@
</td>
<td>
<div align="left">
- List down all the commands available with maven</div>
+ Lists down all the commands available with Maven.</div>
</td>
</tr>
<tr>
@@ -106,7 +106,7 @@
</td>
<td>
<div align="left">
- generate this site</div>
+ Generates the site.</div>
</td>
</tr>
<tr>
@@ -116,7 +116,7 @@
</td>
<td>
<div align="left">
- generate IDEA .ipr, .iml and .iws project files</div>
+ Generates IDEA .ipr, .iml and .iws project files.</div>
</td>
</tr>
<tr>
@@ -127,7 +127,7 @@
<td>
<div align="left">
</div>
- Builds Axis2 and skips all the tests</td>
+ Builds Axis2 and skips all the tests.</td>
</tr>
</tbody>
</table>
@@ -136,16 +136,19 @@
<h2 align="left">Maven FAQ</h2>
-<p><i>1. I have problems with maven 1.1</i></p>
+<p><i>1. I have problems with Maven 1.1</i></p>
-<p>It seems that maven 1.1 doesn't come bundled with the required itest
-plugin and artifact plugin. Run followings to get it updated<br>
-1. maven plugin:download -DgroupId=maven-itest-plugin
--DartifactId=maven-itest-plugin -Dversion=1.0
--Dmaven.repo.remote=http://www.openejb.org/maven,http://www.ibiblio.org/maven
-<br>
-2. maven plugin:Download -DgroupId=maven -DartifactId=maven-artifact-plugin
--Dversion=1.6</p>
+<p style="text-indent: 10pt">It seems that Maven 1.1 doesn't come bundled
+with the required itest plug-in and artifact plug-in. Run the following to
+get it updated.<br>
+</p>
+<ol>
+ <li>maven plugin:download -DgroupId=maven-itest-plugin
+ -DartifactId=maven-itest-plugin -Dversion=1.0
+ -Dmaven.repo.remote=http://www.openejb.org/maven,http://www.ibiblio.org/maven</li>
+ <li>maven plugin:Download -DgroupId=maven
+ -DartifactId=maven-artifact-plugin -Dversion=1.6</li>
+</ol>
<p align="left"> </p>
Modified: webservices/axis2/trunk/java/xdocs/refLib.html
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/refLib.html?view=diff&rev=500938&r1=500937&r2=500938
==============================================================================
--- webservices/axis2/trunk/java/xdocs/refLib.html (original)
+++ webservices/axis2/trunk/java/xdocs/refLib.html Sun Jan 28 21:06:18 2007
@@ -1,53 +1,87 @@
+<html>
<head>
- <title>Reference Library</title>
- <link href="css/axis-docs.css" rel="stylesheet" type="text/css" media="all" />
+ <meta http-equiv="content-type" content="">
+ <title>Reference Library</title>
+ <link href="css/axis-docs.css" rel="stylesheet" type="text/css" media="all">
</head>
+
+<body>
<h2>Reference Library</h2>
-<p>The Axis Project lives or fails based on its human resources. Users and
-contributors alike help the project with ideas and brainpower. A common
-foundation of knowledge is required to effectively participate in this virtual
-community. The following is a list of documents that we have found helpful for
-us and may be helpful to you:</p>
-<p>These resources are required reading for anybody contributing source code to
-the project.</p>
-<p><b><font>SOAP Specific Resources</font></b> </p>
-<p><b>SOAP W3C Specification</b>
-<a href="http://www.w3.org/TR/2000/NOTE-SOAP-20000508/">1.1</a> &
-<a href="http://www.w3.org/TR/soap/">1.2</a><br>
+
+<p>The Axis Project lives or fails based on its human resources. Users and
+contributors alike help the project with ideas and brainpower. A common
+foundation of knowledge is required to effectively participate in this
+virtual community. The following is a list of documents that we have found
+helpful to us and they maybe helpful to you:</p>
+
+<p>These resources are required reading for anybody contributing source code
+to the project.</p>
+
+<p><b><font>SOAP Specific Resources</font></b></p>
+
+<p><b>SOAP W3C Specification</b> <a
+href="http://www.w3.org/TR/2000/NOTE-SOAP-20000508/">1.1</a> and <a
+href="http://www.w3.org/TR/soap/">1.2</a><br>
Required reading.</p>
-<p><b><a href="http://www.w3.org/TR/SOAP-attachments">SOAP Messaging with
+
+<p><b><a href="http://www.w3.org/TR/SOAP-attachments">SOAP Messaging with
Attachments W3C Specification</a></b> <br>
SOAP combined with MIME.</p>
-<p><b><a href="http://www.w3.org/TR/SOAP-dsig/">SOAP Security Extensions:
+
+<p><b><a href="http://www.w3.org/TR/SOAP-dsig/">SOAP Security Extensions:
Digital Signature Specification</a></b> <br>
Adding security to SOAP.</p>
-<p><b>Other Specifications</b> </p>
-<p>Web Services Description Language (WSDL)
-<a href="http://www.w3c.org/TR/wsdl.html">1.1</a> <a href="http://www.w3.org/TR/wsdl20/">2.0 </a></p>
-<p>WS - Addressing <a href="http://www.w3.org/Submission/ws-addressing/">submission</a> <a href="http://www.w3.org/TR/2005/WD-ws-addr-core-20050331/">1.0 (31st March,2005)</a> </p>
-<p><a href="ftp://www6.software.ibm.com/software/developer/library/ws-policy.pdf">Web Services Policy Framework (WSPolicy)</a></p>
-<p><a href="http://www.ws-i.org/Profiles/BasicProfile-1.0.html">WS-I Basic
-Profile Version 1.0</a> </p>
-<p><a href="http://jcp.org/aboutJava/communityprocess/first/jsr101/index.html">
-Java API for XML-based RPC (JAX-RPC)</a> </p>
-<p><a href="http://www.w3.org/TR/2005/REC-soap12-mtom-20050125/">SOAP Message
-Transmission Optimization Mechanism</a> </p>
-<p><b>Other Resources</b> </p>
-<p><b><a href="http://java.sun.com/docs/books/jls/index.html">The Java Language
-Specification</a></b> <br>
-Written by the creators of the Java Programming Language, this online book is
+
+<p><b>Other Specifications</b></p>
+
+<p>Web Services Description Language (WSDL) <a
+href="http://www.w3c.org/TR/wsdl.html">1.1</a> <a
+href="http://www.w3.org/TR/wsdl20/">2.0</a></p>
+
+<p>WS - Addressing <a
+href="http://www.w3.org/Submission/ws-addressing/">submission</a> <a
+href="http://www.w3.org/TR/2005/WD-ws-addr-core-20050331/">1.0 (31st
+March,2005)</a></p>
+
+<p><a
+href="ftp://www6.software.ibm.com/software/developer/library/ws-policy.pdf">Web
+Services Policy Framework (WSPolicy)</a></p>
+
+<p><a href="http://www.ws-i.org/Profiles/BasicProfile-1.0.html">WS-I Basic
+Profile Version 1.0</a></p>
+
+<p><a
+href="http://jcp.org/aboutJava/communityprocess/first/jsr101/index.html">Java
+API for XML-based RPC (JAX-RPC)</a></p>
+
+<p><a href="http://www.w3.org/TR/2005/REC-soap12-mtom-20050125/">SOAP Message
+Transmission Optimization Mechanism</a></p>
+
+<p><b>Other Resources</b></p>
+
+<p><b><a href="http://java.sun.com/docs/books/jls/index.html">The Java
+Language Specification</a></b> <br>
+Written by the creators of the Java Programming Language, this online book is
considered by many to be the bible for programming in Java. A must read.</p>
-<p><b><a href="http://java.sun.com/products/jdk/javadoc/index.html">Javadoc</a></b>
+
+<p><b><a
+href="http://java.sun.com/products/jdk/javadoc/index.html">Javadoc</a></b>
<br>
-Javadoc is the automatic software documentation generator used by Java since it
-was first released. All code written for this project must be documented using
-Javadoc conventions.</p>
-<p><b><a href="http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html">The
-Java Code Conventions</a></b> <br>
-This Sun document specifies the de-facto standard way of formatting Java code.
-All code written for this project must follow these conventions.</p>
-<p><a href="http://svnbook.red-bean.com/en/1.1/svn-book.html"><strong>Version Control
-with SubVersion</strong></a><br>
-Written by Ben Collins-Sussman, Brian W. Fitzpatrick, C. Michael Pilato, . It
+Javadoc is the automatic software documentation generator used by Java, since
+it was first released. All code written for this project must be documented
+using Javadoc conventions.</p>
+
+<p><b><a
+href="http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html">The Java
+Code Conventions</a></b> <br>
+This Sun document specifies the de-facto standard way of formatting Java
+code. All code written for this project must follow these conventions.</p>
+
+<p><a href="http://svnbook.red-bean.com/en/1.1/svn-book.html"><strong>Version
+Control with SubVersion</strong></a><br>
+Written by Ben Collins-Sussman, Brian W. Fitzpatrick, C. Michael Pilato. It
provides details on SVN features.</p>
-<p> </p>
+
+<p> </p>
+</body>
+</html>
Modified: webservices/axis2/trunk/java/xdocs/siteHowTo.html
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/siteHowTo.html?view=diff&rev=500938&r1=500937&r2=500938
==============================================================================
--- webservices/axis2/trunk/java/xdocs/siteHowTo.html (original)
+++ webservices/axis2/trunk/java/xdocs/siteHowTo.html Sun Jan 28 21:06:18 2007
@@ -1,38 +1,49 @@
-<html>
-<head>
-<title>How To Build Axis Project's Website</title>
-<link href="css/axis-docs.css" rel="stylesheet" type="text/css" media="all" />
-</head>
-<body>
-<h1>How To Build Axis2 Project's Website</h1>
-<h2>Installing Maven</h2>
-<p>The Axis 2.0 website build system solely depends
-<a href="http://maven.apache.org/">Maven</a>.Specifically the build has been
-tested to work with Maven version 1.0.1. To install Maven download the
-distributions and follow the instructions in their documentation. Make sure you
-don't forget to put MAVEN_HOME/bin directory in the path. </p>
-<h2>Checking out Axis 2.0</h2>
-<p>Checkout latest source from
-<a href="http://svn.apache.org/repos/asf/webservices/axis2/trunk/java">here</a>
-using your favorite svn client. If you are a committer get a commiter check out
-from <a href="https://svn.apache.org/repos/asf/webservices/axis2/trunk/java">
-here</a>.</p>
-<h2>Building the site</h2>
-<p>type <i>maven multiproject</i> at the root of your project folder. It will take some time to build the whole site and built site will be available under targets/docs</p>
-
-<h2>FAQ</h2>
-<ol>
- <li>How can I update a document in the site ?<br> Get a commiter check out.
- All the documents are in html format under the xdocs folder, and you can
- change only the documents found under this folder. Change the relevant file
- and run maven "html2xdoc:transform". New documentation will be available
- under target folder.</li>
- <li>How can I add a new document<br>Put the new document in xdocs folder.
- Change the navigation.xml found under the xdocs folder to put a link to the
- newly added document. Re-generate the site.<br/>
- Please make sure you have not included any of the illegal characters and your document should be well formed</li>
-</ol>
-<p> </p>
-<p align="right">-- Eran Chinthaka</p>
-</body>
-</html>
\ No newline at end of file
+<html>
+<head>
+ <meta http-equiv="content-type" content="">
+ <title>How To Build Axis Project's Website</title>
+ <link href="css/axis-docs.css" rel="stylesheet" type="text/css" media="all">
+</head>
+
+<body>
+<h1>How to Build the Axis2 Project's Website</h1>
+
+<h2>Installing Maven</h2>
+
+<p>The Axis 2.0 website build system solely depends on <a
+href="http://maven.apache.org/">Maven</a>. The build has been specifically
+tested to work with Maven version 1.0.1. To install Maven, download the
+distributions and follow the instructions in the documentation. Make sure you
+don't forget to put MAVEN_HOME/bin directory in the path.</p>
+
+<h2>Checking out Axis 2.0</h2>
+
+<p>Checkout the <a
+href="http://svn.apache.org/repos/asf/webservices/axis2/trunk/java">latest
+source</a> using your favorite SVN client. If you are a committer, get a <a
+href="https://svn.apache.org/repos/asf/webservices/axis2/trunk/java">commiter
+check out.</a></p>
+
+<h2>Building the Site</h2>
+
+<p>Type <i>maven multiproject</i> at the root of your project folder. It will
+take some time to build the whole site. The built site will be available
+under targets/docs.</p>
+
+<h2>FAQ</h2>
+<ol>
+ <li>How can I update a document in the site ?<br>
+ Get a commiter check out. All the documents are in HTML format under the
+ xdocs folder, and you can change only the documents found under this
+ folder. Change the relevant file and run maven "html2xdoc:transform". New
+ documentation will be available under the target folder.</li>
+ <li>How can I add a new document?<br>
+ Put the new document in the xdocs folder. Change the navigation.xml found
+ under the xdocs folder by adding a link to the newly added document.
+ Re-generate the site.<br>
+ Please make sure you have not included any of the illegal characters and
+ your document should be well formed.</li>
+</ol>
+
+</body>
+</html>
Modified: webservices/axis2/trunk/java/xdocs/svn.html
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/svn.html?view=diff&rev=500938&r1=500937&r2=500938
==============================================================================
--- webservices/axis2/trunk/java/xdocs/svn.html (original)
+++ webservices/axis2/trunk/java/xdocs/svn.html Sun Jan 28 21:06:18 2007
@@ -2,14 +2,14 @@
<head>
<meta http-equiv="content-type" content="">
<title>Developing Apache Axis2</title>
- <link href="css/axis-docs.css" rel="stylesheet" type="text/css" media="all" />
+ <link href="css/axis-docs.css" rel="stylesheet" type="text/css" media="all">
</head>
<body lang="en">
<h1>Developing Apache Axis2</h1>
-<p>This document will give you information on how to use SVN in order to get
-an SVN checkout/update and making commits to repository etc in the process of
+<p>This document provides information on how to use SVN to get an SVN
+checkout/update, make commits to the repository, etc., in the process of
contributing to Apache projects (specifically Axis2). Instructions on
configuring IDEs for development and using Maven to build the project is also
included here.</p>
@@ -27,45 +27,45 @@
<p>The Axis2 development team uses Subversion (SVN) for source control.
Subversion is a compelling replacement for CVS, developed under the auspices
-of the Tigris community and is licensed under an Apache compatible license.
-To learn more about Subversion or to download the latest distribution, visit
-the <a href="http:///subversion.tigris.org" target="_blank">Subversion
-project site</a>. If you are looking for guidance on setting up and
-installing Subversion, please read the ASF <a
+of the Tigris community and licensed under an Apache compatible license. To
+learn more about Subversion or to download the latest distribution, visit the
+<a href="http:///subversion.tigris.org" target="_blank">Subversion project
+site</a>. If you are looking for guidance on setting up and installing
+Subversion, please read the ASF <a
href="http://www.apache.org/dev/version-control.html" target="_blank">Source
Code Repositories page</a>.</p>
<a name="checkout"></a>
-<h2>Checkout Axis2 From Subversion</h2>
+<h2>Checkout Axis2 from Subversion</h2>
-<p>When checking out the latest version of Axis2 from the Foundation's
-Subversion repository you must use one of the following URLs depending on
-your level of access to the Axis2 source code:</p>
+<p>To check out the latest version of Axis2 from the Foundation's Subversion
+repository, you must use one of the following URLs depending on your level of
+access to the Axis2 source code:</p>
<ul>
- <li><b>If you are not a committer:</b> Use <a
+ <li><b>If you are not a committer:</b> <a
href="http://svn.apache.org/repos/asf/webservices/axis2/trunk/java"
target="_blank">http://svn.apache.org/repos/asf/webservices/axis2/trunk/java</a></li>
- <li><b>If you are a committer:</b> Use <a
+ <li><b>If you are a committer:</b> <a
href="https://svn.apache.org/repos/asf/webservices/axis2/trunk/java"
target="_blank">https://svn.apache.org/repos/asf/webservices/axis2/trunk/java</a></li>
</ul>
-If you are a committer, make sure that you have selected an svnpasswd. To do
-this you must log into svn.apache.org. For more information, please read the
+If you are a committer, make sure that you have selected an svnpasswd. To do
+this, you must log into svn.apache.org. For more information, please read the
ASF <a href="http://www.apache.org/dev/version-control.html"
target="_blank">Source Code Repositories page</a>.
<p>Once you have successfully installed Subversion, you can check out Axis2
trunk by following these steps:</p>
<ol type="1">
- <li>Run <strong>svn co <repository URL> axis2</strong> where
+ <li>Run <strong>svn co <repository URL> axis2</strong> where the
repository URL is one of the URLs from the previous list.</li>
<li>This step will check out the latest version of the Axis2 Java codebase
- to a directory named "axis2". The second parameter to the svn co selects
- a directory to create on your local machine. If you want to checkout
- Axis2 to a different directory, feel free to change axis2 to any other
- directory name.</li>
- <li>To update your working copy to the latest version from the repository.
- Execute the <strong>svn update</strong> command.</li>
+ to a directory named "axis2". The second parameter to the <strong>svn
+ co</strong> selects a directory to create on your local machine. If you
+ want to checkout Axis2 to a different directory, feel free to change
+ axis2 to any other directory name.</li>
+ <li>To update your working copy to the latest version from the repository,
+ execute the <strong>svn update</strong> command.</li>
<li>If you would like to submit a patch, you can execute <strong>svn
diff</strong> to create a unified diff for submission to the Axis2 JIRA
issue tracker.</li>
@@ -81,9 +81,8 @@
To use Maven to build the Axis2 project, follow these simple steps:</p>
<ol type="1">
<li>Install <a href="http://maven.apache.org/maven-1.x/"
- target="_blank">Maven1</a>. See <a
- href="http://maven.apache.org/maven-1.x/start/install.html"
- target="_blank">here</a> for instructions.
+ target="_blank">Maven1</a>. Refer to the <a
+ href="http://maven.apache.org/maven-1.x/start/install.html">instructions</a>.
<ul>
<li>Create a MAVEN_HOME environment variable.</li>
<li>Add MAVEN_HOME/bin to your PATH</li>
@@ -104,14 +103,14 @@
ease the process of getting started with Axis2 development.</p>
<ul>
<li><strong>Intellij IDEA-</strong> type <strong>maven
- idea:multiproject</strong>. This will generate the necessary IDEA .ipr,
- .iml and .iws project files</li>
- <li><strong>eclipse</strong>- type
- <strong>maven multiproject:goal -Dgoal=eclipse</strong>
- Then in Eclipse, setup a Classpath Variable for MAVEN_REPO, and select
- File > Import > Existing Projects into Workspace > Select root directory.
- Selecting the root of the Axis source discovers all of the modules and allows
- all to be imported as individual projects at once.</li>
+ idea:multiproject</strong>. Generates the necessary IDEA .ipr, .iml and
+ .iws project files</li>
+ <li><strong>eclipse</strong>- type <strong>maven multiproject:goal
+ -Dgoal=eclipse</strong> Then in Eclipse, setup a Classpath Variable for
+ MAVEN_REPO, and select File > Import > Existing Projects into
+ Workspace > Select root directory. Selecting the root of the Axis
+ source discovers all the modules and allows them to be imported as
+ individual projects at once.</li>
</ul>
</body>
</html>
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org