[mashup-dev] svn commit r4759 - in trunk/mashup/java/xdocs: . images
svn at wso2.org
svn at wso2.org
Tue Jul 3 23:04:16 PDT 2007
Author: thilina
Date: Tue Jul 3 23:03:28 2007
New Revision: 4759
Added:
trunk/mashup/java/xdocs/images/
trunk/mashup/java/xdocs/images/helloworld_listing.png (contents, props changed)
trunk/mashup/java/xdocs/images/helloworld_tryit.png (contents, props changed)
trunk/mashup/java/xdocs/images/login_page.png (contents, props changed)
trunk/mashup/java/xdocs/images/scripts_dir.png (contents, props changed)
Modified:
trunk/mashup/java/xdocs/generatedresources.html
trunk/mashup/java/xdocs/helloworldclient.html
trunk/mashup/java/xdocs/helloworldservice.html
trunk/mashup/java/xdocs/installationguide.html
Log:
updating the docs, adding images
Modified: trunk/mashup/java/xdocs/generatedresources.html
==============================================================================
--- trunk/mashup/java/xdocs/generatedresources.html (original)
+++ trunk/mashup/java/xdocs/generatedresources.html Tue Jul 3 23:03:28 2007
@@ -23,9 +23,9 @@
<ul>
<li><a href="#WSDL">WSDL (?wsdl2, ?wsdl)</a></li>
<li><a href="#Schema">XML Schema (?xsd)</a></li>
- <li><a href="#Javascript1">JavaScript Stubs (?stub)</a></li>
+ <li><a href="#stub">JavaScript Stubs (?stub)</a></li>
<li><a href="#Try-it">Try-it (?tryit)</a></li>
- <li><a href="#Documentat">Documentation (?doc)</a></li>
+ <li><a href="#Doc">API Documentation (?doc)</a></li>
<li><a href="#Source">Source Code (?source)</a></li>
</ul>
</div>
@@ -195,7 +195,7 @@
option. For the helloworld service, try <a
href="http://localhost:9762/services/helloworld?xsd">http://localhost:9762/services/helloworld?xsd</a>.</p>
-<h2 id="Javascript1">JavaScript Stubs (?stub)</h2>
+<h2 id="stub">JavaScript Stubs (?stub)</h2>
<p class="MsoNormal">Most Web Service toolkits can successfully use the WSDL
description to provide a nice programming model for accessing the service.
@@ -344,7 +344,7 @@
Ajax-style web application to interact with your service. You’ll find the
source code quite minimal.</p>
-<h2 id="Documentat">Documentation (?doc)</h2>
+<h2 id="Doc">Documentation (?doc)</h2>
<p class="MsoNormal">[TBD whether this will be done.] The documentation for a
service, as defined in by the “documentation” annotations [link], can be
Modified: trunk/mashup/java/xdocs/helloworldclient.html
==============================================================================
--- trunk/mashup/java/xdocs/helloworldclient.html (original)
+++ trunk/mashup/java/xdocs/helloworldclient.html Tue Jul 3 23:03:28 2007
@@ -12,11 +12,156 @@
<div
style="border:none;border-bottom:solid #4F81BD 1.0pt;padding:0in 0in 4.0pt 0in">
-<p class="MsoTitle">Hello World Client !!</p>
+<p class="MsoTitle">Writing a Hello World Client !!</p>
</div>
-<h1>Consuming services</h1>
+<p class="MsoNormal">The Mashup Server supports the quick and easy creation
+of Web services clients written in HTML and JavaScript. You can use the <a href="generatedresources.html#stub">javascript
+stubs(?stub)</a> generated by the Mashup Server to invoke the mashup services from your web page.</p>
+<p class="MsoNormal">Mashup server also has the concept of bundling a custom UI along
+with the service. Follow these simple steps to write & expose a simple client for the
+<a href="helloworldservice.html">helloworld service</a>:</p>
+<strong>Step 1:</strong>
+
+<p class="MsoNormal">In Notepad or your favorite html editor, type the following
+text:</p>
+
+<p class="Code">function hello() {<br>
+Â Â Â return <response>Hello World</response>;<br>
+}</p>
+
+<p class="MsoNormal"><b>Â </b></p>
+<strong>Step 2:</strong>
+
+<p class="MsoNormal">Save this file as “helloworld.js” in the directory
+“scripts” within the Mashup Server directory.</p>
+
+<p class="MsoNormal">[image]</p>
+<strong>Step 3:</strong>
+
+<p class="MsoNormal">That’s it, the “hello world” service is now live,
+exposing a single operation “hello” that returns some XML. But let’s try it
+out to make sure it’s working properly. Open up the WSO2 Mashup Server
+web-based console (typically at <a
+href="http://localhost:9443/">http://localhost:9443/</a>) and look for
+“helloworld” in the list of running services.</p>
+
+<p class="MsoNormal">[image]</p>
+
+<p class="MsoNormal">Click on the “<strong>Try helloworld</strong>” link, and
+you will get a web-based client that can interact with the Web service. In
+this case, click <strong>Hello</strong> to invoke the hello operation. The
+response is displayed like this:</p>
+
+<p class="MsoNormal">[image]</p>
+
+<h2 id="Automatica">Automatically Generated Resources</h2>
+
+<p class="MsoNormal">Just by virtue of deploying the service, the WSO2 mashup
+server generates a number of descriptive artifacts and tools to make it easy
+to consume the web service you’ve just created. These artifacts are linked
+from the management console for the service, or can be accessed directly from
+the endpoint URI associated with the service. Typically the endpoint URI is
+http://{host ip}:9762/services/{service name}, where the service name is by
+default the name of the JavaScript file defining the service (minus the
+“.js”). By appending one of the following queries to the endpoint URI,
+different artifacts and tools can be accessed:</p>
+
+<table class="MsoTableGrid" border="1" cellspacing="0" cellpadding="0"
+style="margin-left:.5in;border-collapse:collapse;border:none">
+ <tbody>
+ <tr>
+ <td width="67" valign="top"
+ style="width:.7in;border:solid black 1.0pt; padding:0in 5.4pt 0in 5.4pt"><p
+ class="MsoNormal"
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">?wsdl2</p>
+ </td>
+ <td width="372" valign="top"
+ style="width:279.0pt;border:solid black 1.0pt; border-left:none;padding:0in 5.4pt 0in 5.4pt"><p
+ class="MsoNormal"
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">WSDL
+ 2.0 description of the service</p>
+ </td>
+ </tr>
+ <tr>
+ <td width="67" valign="top"
+ style="width:.7in;border:solid black 1.0pt; border-top:none;padding:0in 5.4pt 0in 5.4pt"><p
+ class="MsoNormal"
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">?wsdl</p>
+ </td>
+ <td width="372" valign="top"
+ style="width:279.0pt;border-top:none;border-left: none;border-bottom:solid black 1.0pt;border-right:solid black 1.0pt; padding:0in 5.4pt 0in 5.4pt"><p
+ class="MsoNormal"
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">WSDL
+ 1.1 description of the service</p>
+ </td>
+ </tr>
+ <tr>
+ <td width="67" valign="top"><p class="MsoNormal"
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">?xsd</p>
+ </td>
+ <td width="372" valign="top"
+ style="width:279.0pt;border-top:none;border-left: none;border-bottom:solid black 1.0pt;border-right:solid black 1.0pt; padding:0in 5.4pt 0in 5.4pt"><p
+ class="MsoNormal"
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">XML
+ Schema description of the service</p>
+ </td>
+ </tr>
+ <tr>
+ <td width="67" valign="top"
+ style="width:.7in;border:solid black 1.0pt; border-top:none;padding:0in 5.4pt 0in 5.4pt"><p
+ class="MsoNormal"
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">?stub</p>
+ </td>
+ <td width="372" valign="top"
+ style="width:279.0pt;border-top:none;border-left: none;border-bottom:solid black 1.0pt;border-right:solid black 1.0pt; padding:0in 5.4pt 0in 5.4pt"><p
+ class="MsoNormal"
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">JavaScript
+ or E4X stub for accessing the service</p>
+ </td>
+ </tr>
+ <tr>
+ <td width="67" valign="top"
+ style="width:.7in;border:solid black 1.0pt; border-top:none;padding:0in 5.4pt 0in 5.4pt"><p
+ class="MsoNormal"
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">?tryit</p>
+ </td>
+ <td width="372" valign="top"
+ style="width:279.0pt;border-top:none;border-left: none;border-bottom:solid black 1.0pt;border-right:solid black 1.0pt; padding:0in 5.4pt 0in 5.4pt"><p
+ class="MsoNormal"
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">Ajax
+ client for simple, generic interactions with the service</p>
+ </td>
+ </tr>
+ <tr>
+ <td width="67" valign="top"
+ style="width:.7in;border:solid black 1.0pt; border-top:none;padding:0in 5.4pt 0in 5.4pt"><p
+ class="MsoNormal"
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">?source</p>
+ </td>
+ <td width="372" valign="top"
+ style="width:279.0pt;border-top:none;border-left: none;border-bottom:solid black 1.0pt;border-right:solid black 1.0pt; padding:0in 5.4pt 0in 5.4pt"><p
+ class="MsoNormal"
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">The
+ JavaScript source code for the service</p>
+ </td>
+ </tr>
+ <tr>
+ <td width="67" valign="top"
+ style="width:.7in;border:solid black 1.0pt; border-top:none;padding:0in 5.4pt 0in 5.4pt"><p
+ class="MsoNormal"
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">?doc</p>
+ </td>
+ <td width="372" valign="top"
+ style="width:279.0pt;border-top:none;border-left: none;border-bottom:solid black 1.0pt;border-right:solid black 1.0pt; padding:0in 5.4pt 0in 5.4pt"><p
+ class="MsoNormal"
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">Documentation
+ for the service</p>
+ </td>
+ </tr>
+ </tbody>
+</table>
</div>
</body>
</html>
Modified: trunk/mashup/java/xdocs/helloworldservice.html
==============================================================================
--- trunk/mashup/java/xdocs/helloworldservice.html (original)
+++ trunk/mashup/java/xdocs/helloworldservice.html Tue Jul 3 23:03:28 2007
@@ -40,24 +40,24 @@
<p class="MsoNormal">Save this file as “helloworld.js” in the directory
“scripts” within the Mashup Server directory.</p>
-<p class="MsoNormal">[image]</p>
+<p class="MsoNormal"><img src = 'images/scripts_dir.png' title = 'Mashup server directory structure - scripts folder'/></p>
<strong>Step 3:</strong>
<p class="MsoNormal">That’s it, the “hello world” service is now live,
exposing a single operation “hello” that returns some XML. But let’s try it
out to make sure it’s working properly. Open up the WSO2 Mashup Server
web-based console (typically at <a
-href="http://localhost:9443/">http://localhost:9443/</a>) and look for
-“helloworld” in the list of running services.</p>
+href="https://localhost:9443/">https://localhost:9443/</a>) and look for
+“helloworld” in the list of available mashups.</p>
-<p class="MsoNormal">[image]</p>
+<p class="MsoNormal"><img src = 'images/helloworld_listing.png' title = 'hello world service listed in available mashups'/></p>
-<p class="MsoNormal">Click on the “<strong>Try helloworld</strong>” link, and
+<p class="MsoNormal">Click on the “<strong>Try helloworld</strong>” link in the mashup widget or try typing the tryit URL (typically at <a
+href="http://127.0.0.1:9762/services/helloworld?tryit">http://127.0.0.1:9762/services/helloworld?tryit</a>) in the browser, and
you will get a web-based client that can interact with the Web service. In
-this case, click <strong>Hello</strong> to invoke the hello operation. The
-response is displayed like this:</p>
+this case,type some xml in the given text box and click <strong>Hello</strong> to invoke the hello operation. The response is displayed like this:</p>
-<p class="MsoNormal">[image]</p>
+<p class="MsoNormal">[image of the widget]<img src = 'images/helloworld_tryit.png' title = 'Try the helloworld mashup'/></p>
<h2 id="Automatica">Automatically Generated Resources</h2>
@@ -78,7 +78,7 @@
<td width="67" valign="top"
style="width:.7in;border:solid black 1.0pt; padding:0in 5.4pt 0in 5.4pt"><p
class="MsoNormal"
- style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">?wsdl2</p>
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal"><a href="generatedresources.html#WSDL">?wsdl2</a></p>
</td>
<td width="372" valign="top"
style="width:279.0pt;border:solid black 1.0pt; border-left:none;padding:0in 5.4pt 0in 5.4pt"><p
@@ -91,7 +91,7 @@
<td width="67" valign="top"
style="width:.7in;border:solid black 1.0pt; border-top:none;padding:0in 5.4pt 0in 5.4pt"><p
class="MsoNormal"
- style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">?wsdl</p>
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal"><a href="generatedresources.html#WSDL">?wsdl</a></p>
</td>
<td width="372" valign="top"
style="width:279.0pt;border-top:none;border-left: none;border-bottom:solid black 1.0pt;border-right:solid black 1.0pt; padding:0in 5.4pt 0in 5.4pt"><p
@@ -101,8 +101,8 @@
</td>
</tr>
<tr>
- <td width="67" valign="top"><p class="MsoNormal"
- style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">?xsd</p>
+ <td width="67" valign="top" style="width:.7in;border:solid black 1.0pt; border-top:none;padding:0in 5.4pt 0in 5.4pt"><p class="MsoNormal"
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal"><a href="generatedresources.html#Schema">?xsd</a></p>
</td>
<td width="372" valign="top"
style="width:279.0pt;border-top:none;border-left: none;border-bottom:solid black 1.0pt;border-right:solid black 1.0pt; padding:0in 5.4pt 0in 5.4pt"><p
@@ -115,7 +115,7 @@
<td width="67" valign="top"
style="width:.7in;border:solid black 1.0pt; border-top:none;padding:0in 5.4pt 0in 5.4pt"><p
class="MsoNormal"
- style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">?stub</p>
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal"><a href="generatedresources.html#stub">?stub</a></p>
</td>
<td width="372" valign="top"
style="width:279.0pt;border-top:none;border-left: none;border-bottom:solid black 1.0pt;border-right:solid black 1.0pt; padding:0in 5.4pt 0in 5.4pt"><p
@@ -128,7 +128,7 @@
<td width="67" valign="top"
style="width:.7in;border:solid black 1.0pt; border-top:none;padding:0in 5.4pt 0in 5.4pt"><p
class="MsoNormal"
- style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">?tryit</p>
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal"><a href="generatedresources.html#Try-it">?tryit</a></p>
</td>
<td width="372" valign="top"
style="width:279.0pt;border-top:none;border-left: none;border-bottom:solid black 1.0pt;border-right:solid black 1.0pt; padding:0in 5.4pt 0in 5.4pt"><p
@@ -141,7 +141,7 @@
<td width="67" valign="top"
style="width:.7in;border:solid black 1.0pt; border-top:none;padding:0in 5.4pt 0in 5.4pt"><p
class="MsoNormal"
- style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">?source</p>
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal"><a href="generatedresources.html#Source">?source</a></p>
</td>
<td width="372" valign="top"
style="width:279.0pt;border-top:none;border-left: none;border-bottom:solid black 1.0pt;border-right:solid black 1.0pt; padding:0in 5.4pt 0in 5.4pt"><p
@@ -154,12 +154,12 @@
<td width="67" valign="top"
style="width:.7in;border:solid black 1.0pt; border-top:none;padding:0in 5.4pt 0in 5.4pt"><p
class="MsoNormal"
- style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">?doc</p>
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal"><a href="generatedresources.html#Doc">?doc</a></p>
</td>
<td width="372" valign="top"
style="width:279.0pt;border-top:none;border-left: none;border-bottom:solid black 1.0pt;border-right:solid black 1.0pt; padding:0in 5.4pt 0in 5.4pt"><p
class="MsoNormal"
- style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">Documentation
+ style="margin-bottom:0in;margin-bottom:.0001pt;line-height: normal">API Documentation
for the service</p>
</td>
</tr>
Added: trunk/mashup/java/xdocs/images/helloworld_listing.png
==============================================================================
Binary file. No diff available.
Added: trunk/mashup/java/xdocs/images/helloworld_tryit.png
==============================================================================
Binary file. No diff available.
Added: trunk/mashup/java/xdocs/images/login_page.png
==============================================================================
Binary file. No diff available.
Added: trunk/mashup/java/xdocs/images/scripts_dir.png
==============================================================================
Binary file. No diff available.
Modified: trunk/mashup/java/xdocs/installationguide.html
==============================================================================
--- trunk/mashup/java/xdocs/installationguide.html (original)
+++ trunk/mashup/java/xdocs/installationguide.html Tue Jul 3 23:03:28 2007
@@ -117,9 +117,9 @@
Server_HOME\bin\startup.bat</li>
<li>Check your WSO2 Mashup Server instance using the URL
https://localhost:9443 which will take you to the WSO2 Mashup Server
- Management Console.</li>
+ Management Console.(Refer to the <a href="adminguide.html">Management Console guide</a> for more details)</li>
</ol>
-
+<img src = 'images/login_page.png' title = 'Login to the WSO2 Mashup Server Management Console'/>
<h3 id="Installing2"><strong>Installing on Linux</strong></h3>
<ol>
<li><a
@@ -134,7 +134,7 @@
/opt/wso2-esb-java-1.0/bin; sh startup.sh</li>
<li>Check your WSO2 Mashup Server instance using the URL
https://localhost:9443 which will take you to the WSO2 Mashup Server
- Management Console.</li>
+ Management Console.(Refer to the <a href="adminguide.html">Management Console guide</a> for more details)</li>
</ol>
<h2 id="Building">Building WSO2 Mashup Server Using the Source
More information about the Mashup-dev
mailing list