Author: keith
Date: Tue Jan 15 08:22:20 2008
New Revision: 12274
Log:
Minor update more to come
Modified:
trunk/mashup/java/xdocs/adminguide.html
Modified: trunk/mashup/java/xdocs/adminguide.html
==============================================================================
--- trunk/mashup/java/xdocs/adminguide.html (original)
+++ trunk/mashup/java/xdocs/adminguide.html Tue Jan 15 08:22:20 2008
@@ -1,40 +1,73 @@
<!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>
+<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
+
+
+<div id="main-content">
+
+<h1>The Mashup Server Web Console</h1>
+
+
+<p> This document describes the WSO2 Mashup Server Web Console, which
+is accessible through https://localhost:7443 in a vanilla installation.
+The Web Console helps the user to
+perform sevaral tasks based on the
+permissions he is given. The default permissions allow annonymous users
+to search and view mashups of all users. Users who are logged
+in can comment, rate,
+tag and perform routine tasks
associated
- with creating and maintaining Mashups.
+ with creating and maintaining their Mashups.
</p>
- <p>
+
+
+<p>
<span style="font-weight: bold;">
Note:
</span>
The default
- username/password combination to log in is admin/admin. The
default
+ administrator 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>
+ <img src="images/mashup-ui.png" alt="Mashup UI"></p>
+<p>The above shows the home page of a vanilla installation. It shown
+all avalable mashups together with there descriptions and average
+rating. Once the user logs in he's home page would also display the
+mashups he has authored and his recent activities. Each user can
+customize there home page as to which queries appear on it and can even
+add new queries in a simple manner. In order to add a new query you can
+perform any arbritary search
</p>
- <h2>The Available Mashups List</h2>
- <p>
+
+<h2><br>
+</h2>
+<h2><br>
+</h2>
+<h2>Available Mashups</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
@@ -44,44 +77,69 @@
display further information and documentation.
</p>
- <p>You can also do the following:</p>
- <ol>
+
+<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"/>
+
+</ol>
+
+
+
+<p>
+ <img src="images/available_mashups.png" alt="Available Mashups
List">
</p>
- <br/>
- <h2 id="sharing">Sharing a Mashup</h2>
+ <br>
+
+
+
+<h2 id="sharing">Sharing a Mashup</h2>
+
- <p>
+
+<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 src="images/sharing.png" alt="Mashup Sharing">
+
+
+<p>Enter the http (unsecured) address of the destination server.</p>
+
+
+ <img src="images/sharing_dialog.png" alt="Mashup Sharing">
+ <br>
+
+ <br>
+
+ <br>
+
- <img alt="Mashup Sharing" src="images/sharing_dialog.png"/>
- <br/>
- <br/>
- <br/>
+
+<h2>Creating a New Mashup or Service</h2>
- <h2>Creating a New Mashup or Service</h2>
- <p>
- The Admin UI is capable of generating a skeleton JavaScript
+
+<p>
+ The Web Console is capable of generating a skeleton
JavaScript
service for
- the user. Click the <strong>Create a new Mashup</strong>
+ the user (A user should be logged in to perform this
operation). 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
@@ -97,46 +155,73 @@
</p>
- <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>
+ <img src="images/create_new_mashup.png" alt="Create a new
mashup">
</p>
- <h2>Mashup Widgets</h2>
- <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>
+
+
+<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/>
+ index.html or index.htm file within its www folder)<br>
+
</li>
- </ol>
- <p>
- <img alt="The Mashup Widget" src="images/mashup_widget.png"/>
+
+</ol>
+
+
+
+<p>
+ <img src="images/mashup_widget.png" alt="The Mashup Widget">
</p>
- <h2>Editing Mashups</h2>
- <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
@@ -148,15 +233,24 @@
the edit area.
</p>
- <p>
- <img alt="Mashup Editor Design View"
src="images/mashup_editor_design.png"/>
+
+
+<p>
+ <img src="images/mashup_editor_design.png" alt="Mashup Editor
Design View">
</p>
- <p>
- <img alt="Mashup Editor Source View"
src="images/mashup_editor_source.png"/>
+
+
+<p>
+ <img src="images/mashup_editor_source.png" alt="Mashup Editor
Source View">
</p>
- <p>© WSO2 Inc.</p>
+
+
+<p>� WSO2 Inc.</p>
+
</div>
+
+
- </body>
-</html>
\ No newline at end of file
+</body>
+</html>
_______________________________________________
Mashup-dev mailing list
[email protected]
http://www.wso2.org/cgi-bin/mailman/listinfo/mashup-dev
