Author: keith Date: Sat Jul 19 00:11:51 2008 New Revision: 19618 URL: http://wso2.org/svn/browse/wso2?view=rev&revision=19618
Log: Adding documentation on system.wwwURL Modified: trunk/mashup/java/xdocs/systemhostobject.html Modified: trunk/mashup/java/xdocs/systemhostobject.html URL: http://wso2.org/svn/browse/wso2/trunk/mashup/java/xdocs/systemhostobject.html?rev=19618&r1=19617&r2=19618&view=diff ============================================================================== --- trunk/mashup/java/xdocs/systemhostobject.html (original) +++ trunk/mashup/java/xdocs/systemhostobject.html Sat Jul 19 00:11:51 2008 @@ -1,5 +1,6 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html><head><!-- +<html><head> +<!-- ~ Copyright 2005-2008 WSO2, Inc. (http://wso2.com) ~ ~ Licensed under the Apache License, Version 2.0 (the "License"); @@ -14,10 +15,10 @@ ~ See the License for the specific language governing permissions and ~ limitations under the License. --> - <meta http-equiv="content-type" content=""><title>System Host Object</title> -<link href="css/mashup-docs.css" rel="stylesheet" type="text/css" media="all"></head> +<link href="css/mashup-docs.css" rel="stylesheet" type="text/css" media="all"> +</head> <body> <div id="main-content"> <h1>System Host Object</h1> @@ -44,7 +45,8 @@ function uuid setTimeout (String javascriptCode/Function javascriptFunctionName, -Number startInMilliSeconds);<br> function void +Number startInMilliSeconds);<br> + function void clearTimeout(String uuid);<br> <span style="font-weight: normal;"> function @@ -53,7 +55,7 @@ function XML getXML(String url);<br> function void log(String logmessage, [Optional] -String logLevel);<span style="font-weight: normal;"></span><br style="font-weight: bold;"> +String logLevel);<br> readonly property string wwwURL;<span style="font-weight: normal;"></span><br style="font-weight: bold;"> }</p> <h3>2.2 API Documentation </h3> <table class="MsoTableGrid" style="margin-left: 0.5in; border-collapse: collapse;" border="1" cellpadding="5" cellspacing="0"> @@ -64,7 +66,9 @@ <td> Supported in version</td> </tr> <tr> -<td><b>void include(string scriptPath*</b>);</td> +<td><span style="font-weight: bold;">function</span> +<span style="font-weight: bold;"></span><b>void +include(string scriptPath*</b>);</td> <td> Imports the external scripts given as the arguments. Paths of the scripts to be imported can be given using a comma separated list @@ -85,7 +89,9 @@ <td> 0.1</td> </tr> <tr> -<td><b>void wait([optional int time])</b></td> +<td><span style="font-weight: bold;">function</span> +<span style="font-weight: bold;"></span><b>void +wait([optional int time])</b></td> <td> Waits for the execution of the script for the given time in milliseconds or waits for 10 milliseconds when the time is not given. <br clear="all"> @@ -222,6 +228,18 @@ system.log("Message", "error");</span></td> <td>1.5</td> </tr> +<tr> +<td><b>readonly property string wwwURL;</b></td> +<td>Returns the base address of the calling mashup. Could +be usefull when a user wants to return a URL to a feed that it has +created. Using this function will make sure that the feed URL would not +break when a mashup is shared to another Mashup Server.<br> +Assuming the user bob has created a feed called bobsFeed.xml in a +mashup called feedExample.<br> +<span style="font-style: italic;"> + var bobsFeed = system.wwwURL + "/bobsFeed.xml";</span></td> +<td>1.5</td> +</tr> </tbody> </table> <h3>3.0 References</h3> _______________________________________________ Mashup-dev mailing list [email protected] http://wso2.org/cgi-bin/mailman/listinfo/mashup-dev
