Author: jonathan Date: Mon Jan 28 04:44:04 2008 New Revision: 13076 Log:
Typos. Modified: trunk/mashup/java/xdocs/adminguide.html trunk/mashup/java/xdocs/imhostobject.html Modified: trunk/mashup/java/xdocs/adminguide.html ============================================================================== --- trunk/mashup/java/xdocs/adminguide.html (original) +++ trunk/mashup/java/xdocs/adminguide.html Mon Jan 28 04:44:04 2008 @@ -70,12 +70,12 @@ <p>The above shows the home page of a vanilla installation (Once you've logged in in that is). It shown -all available mashups together with there descriptions and average +all available mashups together with their descriptions and average rating (The rating displayed in the foreground is the rating you've given the mashup while the one in the background represents the 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 +customize their home page as to which queries appear on it and can even add new queries in a simple manner. Any query performed using advanced search can be added to your homepage and you can arrange the results according to your wishes.</p> Modified: trunk/mashup/java/xdocs/imhostobject.html ============================================================================== --- trunk/mashup/java/xdocs/imhostobject.html (original) +++ trunk/mashup/java/xdocs/imhostobject.html Mon Jan 28 04:44:04 2008 @@ -19,17 +19,16 @@ <h3>1.0 Introduction</h3> <p>The IM object allows users to send out Instant Messages from -there -mashups. It helps you notify users of certain events and acts -as a brigde between mashups and users. Supported IM protocols are MSN, +their +mashups. It helps notify users of certain events and acts +as a bridge between mashups and users. Supported IM protocols are MSN, AIM, ICQ, Jabber and Yahoo.</p> <p>Note : The Mashup Server does not ship the library used by the yahoo protocol. If you wish to use the Yahoo protocol, please download the <a href="https://sourceforge.net/project/showfiles.php?group_id=76691";>ymsg -(Yahoo Instant Messager and Chat protocols)</a> library from and -add it to the lib directory of the Mashup Server. Please note that this -would need a restart of the server.</p> +(Yahoo Instant Messager and Chat protocols)</a> library and +add it to the lib directory of the Mashup Server and restart the server.</p> <h3>1.1 Example</h3> @@ -56,27 +55,27 @@ <h4>2.1 IM Object Constructor </h4> -<p>The IM Object which has a single constructor taken in the -protocol to be used as an argument to it. Supported values are "msn", +<p>The IM Object which has a single constructor which takes as an argument the +protocol to be used. Supported values are "msn", "aim", "icq", "jabber" and "yahoo".</p> <h4>2.2 IM login method</h4> <p>The login method of the IM object takes two different forms. It allows the user to specify account details in the server.xml in -which case you dont have to parse any arguments into the login method, -or it allow the user to specify the account details each and everytime +which case you don't have to parse any arguments into the login method, +or it allows the user to specify the account details each time the login method is called.</p> <ol> <li> - <p>In the first instance the login method takes no parameters + <p>In the first instance the login method takes no parameters beyond the protocol value and uses account information specified in the server.xml. Using a -configuration such as this is usefull if you want to use a IM account +configuration such as this is useful if you want to use a IM account to send out Instant Messages from your mashups. It also reduces the hassle of having to key in the account details each time you need -a new im object.</p> +a new IM object.</p> <div class="code">var im = new IM("msn");<br> @@ -122,16 +121,16 @@ </Jabber><br> </IMConfig></div> - <p>Note: Changed to the -server.xml requires a server restart.</p> + <p>Note: Changes to the +server.xml require a server restart.</p> </li> <li> - <p>The second instance unlike the first requires the user -to provide the account details each time he invokes the login function. The plus point is that no server configuration is + <p>The second instance, unlike the first, requires the user +to provide the account details each time he invokes the login function. The benefit is that no server configuration is needed and you can use diffent accounts when ever you need. The -configuration details should be given as follws,<br> +configuration details should be given as follows:<br> </p> @@ -143,7 +142,7 @@ <p>Note : If the configuration details are given in the server.xml and the user uses the above method, -the details given by the user when invoking the login method gets +the details given by the user when invoking the login method take precedence.</p> </li> @@ -171,7 +170,7 @@ <td><b>void login(</b>)</td> - <td>The accound details pertaining to the protocol is taken from + <td>The account details pertaining to the protocol is taken from the server.xml and those credentials are used to log the user into the IM server.<br> <span style="font-style: italic;"> im.login();</span></td> @@ -206,9 +205,9 @@ <td><span style="font-weight: bold;">void disconnect()</span></td> <td>Logs the user out of the IM server.<br> -Note: The AIM and ICQ protocols does not allow users to log in and out +Note: The AIM and ICQ protocols do not allow users to log in and out frequently. In such a situation these two protocols block the user for -a breif time (Around 10 Minutes).<br> +a brief time (Around 10 Minutes).<br> <span style="font-style: italic;"> im.disconnect();</span></td> </tr> @@ -223,11 +222,11 @@ <br> -<h3>3.0 Using the IM object in conjection with the session object</h3> +<h3>3.0 Using the IM object in conjunction with the session object</h3> <br> If you expect your mashup to send out IMs frequestly it may not be optimal to login each time you need to send a message. Such situations -can be combated by using the IM object in conjunction with the session +can be avoided by using the IM object in conjunction with the session object. The following is an example of such a usage.<br> <br> @@ -271,7 +270,7 @@ </div> -<p>� WSO2 Inc.</p> +<p>© 2007-2008 WSO2 Inc.</p> </body> </html> _______________________________________________ Mashup-dev mailing list [email protected] http://www.wso2.org/cgi-bin/mailman/listinfo/mashup-dev
