[mashup-dev] svn commit r8600 - trunk/mashup/java/xdocs
svn at wso2.org
svn at wso2.org
Fri Oct 5 02:02:59 PDT 2007
Author: keith
Date: Fri Oct 5 02:02:55 2007
New Revision: 8600
Modified:
trunk/mashup/java/xdocs/adminguide.html
trunk/mashup/java/xdocs/annotations.html
Log:
Did some formatting on these two files
Modified: trunk/mashup/java/xdocs/adminguide.html
==============================================================================
--- trunk/mashup/java/xdocs/adminguide.html (original)
+++ trunk/mashup/java/xdocs/adminguide.html Fri Oct 5 02:02:55 2007
@@ -1,208 +1,162 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
-<head>
-
-
- <meta http-equiv="content-type" content="">
-
-
- <title>The Mashup Server Admin UI</title>
- <link href="styles.css" rel="stylesheet" type="text/css" media="all">
-</head>
-
-<body lang="en">
-
-
-<div id="main-content">
-<h1>The Mashup Server Admin UI</h1>
-
-
-<p>This document describes the WSO2 Mashup Server Admin User
- Interface (Admin
- UI), which is accessible through https://localhost:7443 in a vanilla
- installation. The Admin UI helps the user to perform routine tasks
- associated
- with creating and maintaining Mashups.</p>
-
-
-<p><span style="font-weight: bold;">Note: </span>The default
- username/password combination to log in is admin/admin. The default
- password can be changed using the 'chpasswd' script found in your
- installations 'bin' directory.</p>
-
-
-<p></p>
-
-
-<p><img alt="Mashup UI" src="images/mashup-ui.png"></p>
-
-
-<p></p>
-
-
-<h2>The Available Mashups List</h2>
-
-
-<p>The Available Mashups list contains a list of Mashups and
- Services
- deployed and running in the server. Each item in the list can be
- dragged to
- the pane on the left, which will transform them into Mashup Widgets,
- which
- display further information and documentation.</p>
-
-
-<p>You can also do the following:</p>
-
-
-<ol>
-
-
- <li>Start/Stop a Service</li>
-
-
- <li>Share a service with another WSO2 Mashup Server</li>
-
-
- <li>Edit the service source and documentation using the buttons
- on the listed items
- </li>
-
-
-</ol>
-
-
-<p><img alt="Available Mashups List" src="images/available_mashups.png"></p>
-
-
-<br/>
-
-
-<h2 id="sharing">Sharing a Mashup</h2>
-
-
-<p>You can share a mashup running in your server with another
- server by a click of a button.</p>
-
-
-<img alt="Mashup Sharing" src="images/sharing.png">
-
-<p>Enter the http (unsecured) address of the destination server.</p>
-
-
-<img alt="Mashup Sharing" src="images/sharing_dialog.png">
-<br/>
-
-
-<br/>
-
-
-<br/>
-
-
-<h2>Creating a New Mashup or Service</h2>
-
-
-<p>The Admin UI is capable of generating a skeleton JavaScript
- service for
- the user. Click the <strong>Create a new Mashup</strong>
- icon at top of the
- Available Mashups list, as illustrated in this screenshot. When you
- enter a
- name for the new service, the Admin UI will create the service skeleton
- and
- deploy it. It will be listed as a service in the Available Mashups list
- after
- a few seconds. If you do not wish to wait till the Admin UI refreshes
- the
- list, click the <strong>Refresh</strong> icon (next to the
- <strong>Create new
- Mashup</strong> icon), which results in a manual refresh of the
- list.</p>
-
-
-<p><strong>Note</strong>: From release 0.2 onwards
- this operation will be
- wizard based, allowing greater customization of the initial skeleton.</p>
-
-
-<p><img alt="Create a new mashup" src="images/create_new_mashup.png"></p>
-
-
-<p></p>
-
-
-<h2>Mashup Widgets</h2>
-
-
-<p>A Mashup Widget displays a complete set of information
- regarding a Mashup
- or a Service. It also provides links to resources such as:</p>
-
-
-<ol>
-
-
- <li>WSDL - Link to the WSDL 1.1 description of the service</li>
-
-
- <li>WSDL2 - Link to the WSDL 2.0 document of the service</li>
-
-
- <li>Try service - Link to the try-it page where you can try the service out</li>
- <li>Stub source- Displays a Java Script Stub that can be used to invoke the service</li>
- <li>Schema - Link to the schema of the service</li>
-
-
- <li>API docs - Link to the documentation of the service </li>
-
-
- <li>Service source - Displays the source of the service</li>
-
-
- <li>Custom
- UI - Link to the custom UI of the service (The link is shown only if
- the service has a custom UI, fogured out by the presence ofan
- index.html or index.htm file within its www folder)<br/></li>
-
-
-</ol>
-
-
-<p><img alt="The Mashup Widget" src="images/mashup_widget.png"></p>
-
-
-<p></p>
-
-
-<h2>Editing Mashups</h2>
-
-
-<p>The Mashup Editor allows you to edit the source code and
- documentation of
- your Services and Mashups. You can launch the editor from the buttons
- in the
- service items listed in the Available Mashups list. Once you have
- completed
- editing the service, click the<strong> Save</strong>
- button, at the top of
- the edit area.</p>
-
-
-<p><img alt="Mashup Editor Design View" src="images/mashup_editor_design.png"></p>
-
-
-<p></p>
-
-
-<p><img alt="Mashup Editor Source View" src="images/mashup_editor_source.png"></p>
-
-
-<p></p>
-
-
-</div>
-
-<p>© WSO2 Inc.</p>
-</body>
+ <head>
+ <meta http-equiv="content-type" content="">
+ <title>The Mashup Server Admin UI</title>
+ <link href="styles.css" rel="stylesheet" type="text/css" media="all">
+ </head>
+
+ <body lang="en">
+ <div id="main-content">
+ <h1>The Mashup Server Admin UI</h1>
+ <p>
+ This document describes the WSO2 Mashup Server Admin User
+ Interface (Admin
+ UI), which is accessible through https://localhost:7443 in a vanilla
+ installation. The Admin UI helps the user to perform routine tasks
+ associated
+ with creating and maintaining Mashups.
+ </p>
+
+ <p>
+ <span style="font-weight: bold;">
+ Note:
+ </span>
+ The default
+ username/password combination to log in is admin/admin. The default
+ password can be changed using the 'chpasswd' script found in your
+ installations 'bin' directory.
+ </p>
+
+ <p>
+ <img alt="Mashup UI" src="images/mashup-ui.png"/>
+ </p>
+
+ <h2>The Available Mashups List</h2>
+
+ <p>
+ The Available Mashups list contains a list of Mashups and
+ Services
+ deployed and running in the server. Each item in the list can be
+ dragged to
+ the pane on the left, which will transform them into Mashup Widgets,
+ which
+ display further information and documentation.
+ </p>
+
+ <p>You can also do the following:</p>
+
+ <ol>
+ <li>Start/Stop a Service</li>
+ <li>Share a service with another WSO2 Mashup Server</li>
+ <li>Edit the service source and documentation using the buttons
+ on the listed items
+ </li>
+ </ol>
+
+ <p>
+ <img alt="Available Mashups List" src="images/available_mashups.png"/>
+ </p>
+
+ <br/>
+
+ <h2 id="sharing">Sharing a Mashup</h2>
+
+ <p>
+ You can share a mashup running in your server with another
+ server by a click of a button.
+ </p>
+
+ <img alt="Mashup Sharing" src="images/sharing.png"/>
+
+ <p>Enter the http (unsecured) address of the destination server.</p>
+
+ <img alt="Mashup Sharing" src="images/sharing_dialog.png"/>
+ <br/>
+ <br/>
+ <br/>
+
+ <h2>Creating a New Mashup or Service</h2>
+
+ <p>
+ The Admin UI is capable of generating a skeleton JavaScript
+ service for
+ the user. Click the <strong>Create a new Mashup</strong>
+ icon at top of the
+ Available Mashups list, as illustrated in this screenshot. When you
+ enter a
+ name for the new service, the Admin UI will create the service skeleton
+ and
+ deploy it. It will be listed as a service in the Available Mashups list
+ after
+ a few seconds. If you do not wish to wait till the Admin UI refreshes
+ the
+ list, click the <strong>Refresh</strong> icon (next to the
+ <strong>Create new Mashup</strong> icon), which results in a manual refresh of the
+ list.
+ </p>
+
+
+ <p>
+ <strong>Note</strong>: From release 0.2 onwards
+ this operation will be
+ wizard based, allowing greater customization of the initial skeleton.
+ </p>
+
+ <p>
+ <img alt="Create a new mashup" src="images/create_new_mashup.png"/>
+ </p>
+
+ <h2>Mashup Widgets</h2>
+
+ <p>
+ A Mashup Widget displays a complete set of information
+ regarding a Mashup
+ or a Service. It also provides links to resources such as:
+ </p>
+
+ <ol>
+ <li>WSDL - Link to the WSDL 1.1 description of the service</li>
+ <li>WSDL2 - Link to the WSDL 2.0 document of the service</li>
+ <li>Try service - Link to the try-it page where you can try the service out</li>
+ <li>Stub source- Displays a Java Script Stub that can be used to invoke the service</li>
+ <li>Schema - Link to the schema of the service</li>
+ <li>API docs - Link to the documentation of the service </li>
+ <li>Service source - Displays the source of the service</li>
+ <li>Custom
+ UI - Link to the custom UI of the service (The link is shown only if
+ the service has a custom UI, fogured out by the presence ofan
+ index.html or index.htm file within its www folder)<br/>
+ </li>
+ </ol>
+
+ <p>
+ <img alt="The Mashup Widget" src="images/mashup_widget.png"/>
+ </p>
+
+ <h2>Editing Mashups</h2>
+
+ <p>
+ The Mashup Editor allows you to edit the source code and
+ documentation of
+ your Services and Mashups. You can launch the editor from the buttons
+ in the
+ service items listed in the Available Mashups list. Once you have
+ completed
+ editing the service, click the<strong> Save</strong>
+ button, at the top of
+ the edit area.
+ </p>
+
+ <p>
+ <img alt="Mashup Editor Design View" src="images/mashup_editor_design.png"/>
+ </p>
+
+ <p>
+ <img alt="Mashup Editor Source View" src="images/mashup_editor_source.png"/>
+ </p>
+ <p>© WSO2 Inc.</p>
+ </div>
+
+ </body>
</html>
\ No newline at end of file
Modified: trunk/mashup/java/xdocs/annotations.html
==============================================================================
--- trunk/mashup/java/xdocs/annotations.html (original)
+++ trunk/mashup/java/xdocs/annotations.html Fri Oct 5 02:02:55 2007
@@ -1,123 +1,131 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
-<head>
- <meta http-equiv="content-type" content="">
-
- <title>JavaScript Web Service Annotations</title>
- <link href="styles.css" rel="stylesheet" type="text/css" media="all">
-</head>
-<body>
-
-<div id="main-content">
- <h1>JavaScript Web Service Annotations</h1>
-
- <p></p>
-
- <p><strong>Table of Contents</strong></p>
-
- <div class="toc">
- <ul>
- <li><a href="#documentat">documentation Annotation</a></li>
- <li><a href="#visible">visible Annotation</a></li>
- <li><a href="#inputTypes">inputTypes and outputType Annotations</a></li>
- <li><a href="#Other">Other Annotations</a></li>
- </ul>
- </div>
-
- <p>There are a number of annotations that you can insert into your JavaScript
- Mashup service that enrich the descriptions and tools generated by the mashup
- service. We encourage you to use these annotations liberally.</p>
-
- <p>The WSO2 Mashup Server defines a set of properties that can be applied to
- the Global object, representing the service as a whole, or to individual
- functions. In JavaScript, functions are actually objects, and any object can
- have additional properties dynamically added to it. The set of common
- properties to set on an object is described below.</p>
-
- <p></p>
-
- <h2 id="documentat">documentation Annotation</h2>
-
- <p>Documentation properties can be added either to the global object, or to
- individual function objects.</p>
-
- <pre class="Code">this.documentation = <div>The <b>simple</b> service has a single operation - <i>echo</i>.</div>; <br/><br/>echo.documentation = "The echo operation accepts a blob of XML and returns it to the caller unchanged."<br/><br/>function echo(xmlblob) {<br/> return xmlblob;<br/>}</pre>
-
- <p>The documentation can have either a string value, as shown in the
- echo.documentation property above, or it can have an XML.</p>
-
- <p>The documentation property serves several purposes:</p>
- <ol>
- <li>It provides structured documentation within the service. While you
- could use JavaScript comments instead, using a documentation property to
- describe the service and its operations makes it possible to distinguish
- between comments describing the implementation, and comments documenting
- the behavior of the service, and to re-use the latter.
- </li>
- <li>The documentation for the service (this.documentation) appears in the
- WSDL as a top-level <documentation> element. The documentation for
- each operation (echo.documentation in the above example) appears as
- <documentation> elements on each Interface Operation.
- </li>
- <li>The documentation is displayed in the Try-it page.</li>
- <li>The documentation is also displayed in the ?doc page.</li>
- </ol>
-
- <p></p>
-
- <h2 id="visible">visible Annotation</h2>
-
- <p>By default, each function in a JavaScript service file is exposed as an
- operation. But often functions should be 'private', for the benefit of other
- functions and not an entry point that the author wishes to expose to a
- client. When the 'visible' property has the Boolean value <em>false</em>,
- the function is not exposed as an operation (e.g., it doesn't appear in the
- WSDL, Try-it, etc.)</p>
-
- <pre class="Code">function equals(lefthand, righthand)<br/>{<br/> return (lefthand == righthand && typeEquals(lefthand, righthand));<br/>}<br/><br/>typeEquals.visible = false;<br/>function typeEquals(lefthand, righthand)<br/>{<br/> return (typeof(lefthand) == typeof(righthand));<br/>}</pre>
-
-
- <p>In the above example, there is an implicit
- "equals.visible = true;".</p>
-
- <p></p><br/>
-
- <h2 id="inputTypes">inputTypes and outputType Annotations</h2>Please refer documentation on <a
- href="dataBinding.html">JavaScript Data Binding</a> for details.<br/>
-
- <h2 id="Other">Other Annotations</h2>
-
- <p>For advanced usage, there are a number of other properties that can be
- used:</p>
- <ul>
- <li><b>this.targetNamespace </b>: places the components of the description
- (WSDL 2.0, WSDL 1.1) in a specific namespace. By default, the
- targetNamespace is <a href="http://services.mashup.wso2.org/%7bservice%20name%7d">http://services.mashup.wso2.org/{service
- name}</a>, which is of course not guaranteed to be unique.
- </li>
- <li><b>this.schemaTargetNamespace</b> : sets the schema target namespace,
- which will be used as the namespace for any wrapper elements generated by
- the mashup server. By default the targetnamespace is <a
- href="http://services.mashup.wso2.org/%7bservice%20name%7d?xsd">http://services.mashup.wso2.org/{service
- name}?xsd</a>.
- </li>
- <li><b>this.serviceName</b> : exposes the service under an alternate name
- (in the WSDL, try-it, documentation, etc.) By default the serviceName is
- the name of the JavaScript file (minus the '.js'.)
- </li>
- <li><b>{function}.safe</b> :indicates whether repeated calls to the
- operation cause side effects. For example, two calls to a 'bill me'
- operation would normally result in two charges, while two calls to a
- 'current activity' operation would not cause any harmful side-effects.
- The safe annotation maps to the wsdlx:safe attribute, and helps determine
- whether GET or POST is the most appropriate HTTP method to use.
- </li>
- <li><b>{function}.operationName</b> : exposes the function as an operation
- under an alternate name (in the WSDL, try-it, documentation, etc.). By
- default, the operationName is the name of the function.
- </li>
- </ul>
-</div>
-<p>© WSO2 Inc.</p>
-</body>
+ <head>
+ <meta http-equiv="content-type" content="">
+ <title>JavaScript Web Service Annotations</title>
+ <link href="styles.css" rel="stylesheet" type="text/css" media="all">
+ </head>
+ <body>
+ <div id="main-content">
+ <h1>JavaScript Web Service Annotations</h1>
+
+ <p>
+ <strong>Table of Contents</strong>
+ </p>
+
+ <div class="toc">
+ <ul>
+ <li><a href="#documentat">documentation Annotation</a></li>
+ <li><a href="#visible">visible Annotation</a></li>
+ <li><a href="#inputTypes">inputTypes and outputType Annotations</a></li>
+ <li><a href="#Other">Other Annotations</a></li>
+ </ul>
+ </div>
+
+ <p>
+ There are a number of annotations that you can insert into your JavaScript
+ Mashup service that enrich the descriptions and tools generated by the mashup
+ service. We encourage you to use these annotations liberally.
+ </p>
+
+ <p>
+ The WSO2 Mashup Server defines a set of properties that can be applied to
+ the Global object, representing the service as a whole, or to individual
+ functions. In JavaScript, functions are actually objects, and any object can
+ have additional properties dynamically added to it. The set of common
+ properties to set on an object is described below.
+ </p>
+
+ <h2 id="documentat">documentation Annotation</h2>
+
+ <p>
+ Documentation properties can be added either to the global object, or to
+ individual function objects.
+ </p>
+
+ <pre class="Code">this.documentation = <div>The <b>simple</b> service has a single operation - <i>echo</i>.</div>; <br/><br/>echo.documentation = "The echo operation accepts a blob of XML and returns it to the caller unchanged."<br/><br/>function echo(xmlblob) {<br/> return xmlblob;<br/>}</pre>
+
+ <p>
+ The documentation can have either a string value, as shown in the
+ echo.documentation property above, or it can have an XML.
+ </p>
+
+ <p>The documentation property serves several purposes:</p>
+
+ <ol>
+ <li>It provides structured documentation within the service. While you
+ could use JavaScript comments instead, using a documentation property to
+ describe the service and its operations makes it possible to distinguish
+ between comments describing the implementation, and comments documenting
+ the behavior of the service, and to re-use the latter.
+ </li>
+ <li>The documentation for the service (this.documentation) appears in the
+ WSDL as a top-level <documentation> element. The documentation for
+ each operation (echo.documentation in the above example) appears as
+ <documentation> elements on each Interface Operation.
+ </li>
+ <li>The documentation is displayed in the Try-it page.</li>
+ <li>The documentation is also displayed in the ?doc page.</li>
+ </ol>
+
+ <h2 id="visible">visible Annotation</h2>
+
+ <p>
+ By default, each function in a JavaScript service file is exposed as an
+ operation. But often functions should be 'private', for the benefit of other
+ functions and not an entry point that the author wishes to expose to a
+ client. When the 'visible' property has the Boolean value <em>false</em>,
+ the function is not exposed as an operation (e.g., it doesn't appear in the
+ WSDL, Try-it, etc.)
+ </p>
+
+ <pre class="Code">function equals(lefthand, righthand)<br/>{<br/> return (lefthand == righthand && typeEquals(lefthand, righthand));<br/>}<br/><br/>typeEquals.visible = false;<br/>function typeEquals(lefthand, righthand)<br/>{<br/> return (typeof(lefthand) == typeof(righthand));<br/>}</pre>
+
+ <p>
+ In the above example, there is an implicit
+ "equals.visible = true;".
+ </p>
+
+ <br/>
+
+ <h2 id="inputTypes">inputTypes and outputType Annotations</h2>
+ <br/>
+ Please refer documentation on <a
+ href="dataBinding.html">JavaScript Data Binding</a> for details.<br/>
+ <br/>
+ <h2 id="Other">Other Annotations</h2>
+
+ <p>For advanced usage, there are a number of other properties that can be used:</p>
+
+ <ul>
+ <li><b>this.targetNamespace </b>: places the components of the description
+ (WSDL 2.0, WSDL 1.1) in a specific namespace. By default, the
+ targetNamespace is <a href="http://services.mashup.wso2.org/%7bservice%20name%7d">http://services.mashup.wso2.org/{service
+ name}</a>, which is of course not guaranteed to be unique.
+ </li>
+ <li><b>this.schemaTargetNamespace</b> : sets the schema target namespace,
+ which will be used as the namespace for any wrapper elements generated by
+ the mashup server. By default the targetnamespace is <a
+ href="http://services.mashup.wso2.org/%7bservice%20name%7d?xsd">http://services.mashup.wso2.org/{service
+ name}?xsd</a>.
+ </li>
+ <li><b>this.serviceName</b> : exposes the service under an alternate name
+ (in the WSDL, try-it, documentation, etc.) By default the serviceName is
+ the name of the JavaScript file (minus the '.js'.)
+ </li>
+ <li><b>{function}.safe</b> :indicates whether repeated calls to the
+ operation cause side effects. For example, two calls to a 'bill me'
+ operation would normally result in two charges, while two calls to a
+ 'current activity' operation would not cause any harmful side-effects.
+ The safe annotation maps to the wsdlx:safe attribute, and helps determine
+ whether GET or POST is the most appropriate HTTP method to use.
+ </li>
+ <li><b>{function}.operationName</b> : exposes the function as an operation
+ under an alternate name (in the WSDL, try-it, documentation, etc.). By
+ default, the operationName is the name of the function.
+ </li>
+ </ul>
+ <p>© WSO2 Inc.</p>
+ </div>
+ </body>
</html>
\ No newline at end of file
More information about the Mashup-dev
mailing list