Author: channa Date: Thu Sep 25 23:23:57 2008 New Revision: 22104 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=22104
Log: Adding a quick start to the mashup documentation, to be shipped with the distribution. MASHUP-480. Added: trunk/mashup/java/xdocs/images/console_out.png (contents, props changed) trunk/mashup/java/xdocs/images/create_new.png (contents, props changed) trunk/mashup/java/xdocs/images/mash_editor_hellow.png (contents, props changed) trunk/mashup/java/xdocs/images/mashup_details_hellow.png (contents, props changed) trunk/mashup/java/xdocs/images/mooshup_self_reg.png (contents, props changed) trunk/mashup/java/xdocs/images/my_mashups_hellow.png (contents, props changed) trunk/mashup/java/xdocs/images/tray_ico.JPG (contents, props changed) trunk/mashup/java/xdocs/quickstart.html Modified: trunk/mashup/java/xdocs/images/helloworld_tryit.png Added: trunk/mashup/java/xdocs/images/console_out.png URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/console_out.png?pathrev=22104 ============================================================================== Binary file. No diff available. Added: trunk/mashup/java/xdocs/images/create_new.png URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/create_new.png?pathrev=22104 ============================================================================== Binary file. No diff available. Modified: trunk/mashup/java/xdocs/images/helloworld_tryit.png URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/helloworld_tryit.png?rev=22104&r1=22103&r2=22104&view=diff ============================================================================== Binary files. No diff available. Added: trunk/mashup/java/xdocs/images/mash_editor_hellow.png URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/mash_editor_hellow.png?pathrev=22104 ============================================================================== Binary file. No diff available. Added: trunk/mashup/java/xdocs/images/mashup_details_hellow.png URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/mashup_details_hellow.png?pathrev=22104 ============================================================================== Binary file. No diff available. Added: trunk/mashup/java/xdocs/images/mooshup_self_reg.png URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/mooshup_self_reg.png?pathrev=22104 ============================================================================== Binary file. No diff available. Added: trunk/mashup/java/xdocs/images/my_mashups_hellow.png URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/my_mashups_hellow.png?pathrev=22104 ============================================================================== Binary file. No diff available. Added: trunk/mashup/java/xdocs/images/tray_ico.JPG URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/images/tray_ico.JPG?pathrev=22104 ============================================================================== Binary file. No diff available. Added: trunk/mashup/java/xdocs/quickstart.html URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/quickstart.html?pathrev=22104 ============================================================================== --- (empty file) +++ trunk/mashup/java/xdocs/quickstart.html Thu Sep 25 23:23:57 2008 @@ -0,0 +1,158 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> + <!-- + ~ Copyright 2005-2008 WSO2, Inc. (http://wso2.com) + ~ + ~ Licensed 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. + --> + <meta http-equiv="content-type" content=""> + <title>Quick Start Guide</title> + <link href="css/mashup-docs.css" rel="stylesheet" type="text/css" + media="all"> +</head> + +<body style="direction: ltr;"> + +<div id="main-content"> +<h1>Quick Start Guide</h1> + +<p>The WSO2 Mashup Server allows you to acquire web based information from a +variety of sources such as web services, web pages, databases or feeds, +combine it in interesting and useful ways before exposing the result again as +a web service or page, feed or a Google gadget. Your Mashup can even interact +with users via e-mails, instant messages and desktop alerts. This guide and +access to a Mashup Server should be all you need to start creating your own +personalized web services in minutes.</p> + +<h2>Getting Started</h2> + +<p>Since you may be viewing this document on-line or in a local installation, +let me stat off by stating that you can either setup a WSO2 Mashup Server +locally or register yourself at our <a href="http://mooshup.com";>community +site</a> and start writing your Mashups.</p> + +<h3>Setting Up Locally</h3> + +<p>If you’ve already got <a +href="http://java.sun.com/javase/downloads/index.jsp";>Java</a> (Version 1.5 +preferred) installed on your PC and an environment variable pointing to your +<a href="https://localhost:7443/docs/setting-java-home.html";>Java Home</a> +defined, simply download the <a +href="http://dist.wso2.org/products/mashup/wso2-mashup-server-1.5.1.zip";>Binary +Distribution</a> of the Mashup Server, unzip it in a local folder and run the +wso2mashup batch file (on Windows) or shell script (on Linux) found in the +'bin' directory to get it running. </p> + +<p>If you're on Windows, you can download and run the <a +href="http://dist.wso2.org/products/mashup/wso2-mashup-server-1.5.1-setup.exe";>Installer</a> +instead, which lets you click through a wizard, to setup and run the server +as a Windows Service. You should do fine just clicking on next at each step, +going with the default options.</p> + +<h3>Confirming that the Server is Up</h3> + +<p>If you used the Windows Installer, you will see a new icon in the system +tray that will indicate server status. </p> + +<p><img alt="Tray Icon" src="images/tray_ico.JPG" width="22" height="19"></p> + +<p>If you unzipped a distribution, the console or log file will show you the +progress of the server startup.</p> + +<p><img alt="Console" src="images/console_out.png" width="1291" +height="464"></p> + +<p>Once the server has started, open up the admin console on your browser. +You can use the ‘Administration’ right-click-menu item of the +tray icon if you used the Windows Installer or access <a +href="http://localhost:7762/";>localhost</a> on the default http or https port +(typically 7762 and 7443) with IE or Firefox. You will see the provisioning +screen below on first startup. </p> + +<p><img alt="Provisioning" src="images/provisioning.png" width="1006" +height="601"></p> + +<p>To setup the primary account, just type in a user name and preferably an +e-mail ID, along with a 5 or more character password and click 'Create +Account'.</p> + +<h3>Registering on Mooshup.com</h3> + +<p>Use the 'Sign Up' link on the home page to access the self registration +page, where you can create your own account and complete the process by +clicking on the verification link mailed to the e-mail ID you specify.</p> + +<p><img alt="Self Reg" src="images/mooshup_self_reg.png" width="70%"></p> + +<h2>Creating Your First Mashup</h2> + +<p>Regardless of whether you're using the community site or your local +system, once you login, you should see a welcome page with the options shown +below.</p> + +<p><img alt="Home Page" src="images/mashup-ui.png" width="1002" +height="885"></p> + +<p>Use the ‘Create a new mashup’ option of the 'Management tasks' +pane to create your first mashup. You will be prompted for a name, and when +you click 'create' a basic mashup will be created for you and displayed in +the Mashup editor.</p> + +<p><img alt="Prompt for Name" src="images/create_new.png" width="365" +height="136"></p> + +<h3>Saving and Testing the Mashup</h3> + +<p>The auto generated Mashup is a fully functional JavaScript service. Like +any other 'hello world' program it does nothing useful, but proves that you +have everything in place to write a Mashup that can. </p> + +<p><img alt="Hello World in Editor" src="images/mash_editor_hellow.png" +width="1016" height="687"></p> + +<p>Use the 'Save Changes' button and you will get back to the welcome page, +but with your newly created Mashup displayed under 'My Mashups'. </p> + +<p><img alt="My Mashups" src="images/my_mashups_hellow.png" width="686" +height="96"></p> + +<p>Clicking on the name of the Mashup here will take you to the Mashup +details page.</p> + +<p><img alt="Mashup Details" src="images/mashup_details_hellow.png" +width="1007" height="513"></p> + +<p>Here you can start, stop, edit or delete the service using the options in +the 'Management Tasks' pane. More importantly, you can try out your Service's +single operation using the 'Try the Service' link.</p> + +<p><img alt="TryIt HelloW" src="images/helloworld_tryit.png" height="300" +width="420"></p> + +<p>If you get a response from the service when you try it, pat yourself on +the back, you've written your first mashup!</p> + +<h2>Adding the Interesting Bits</h2> + +<p>Now that you've seen how easy it is to write a service, you can start on +getting it to actually do something. </p> + +<p></p> +</div> + +<div id="main-content1"> +<p>© 2007-2008 WSO2 Inc.</p> +</div> +</body> +</html> _______________________________________________ Mashup-dev mailing list [email protected] http://mailman.wso2.org/cgi-bin/mailman/listinfo/mashup-dev
