You are viewing a plain text version of this content. The canonical link for it is here.
Posted to xap-commits@incubator.apache.org by bb...@apache.org on 2007/01/27 23:20:08 UTC

svn commit: r500679 - in /incubator/xap/trunk/buildsystem/doc: images/arrow.gif images/background.gif index.html

Author: bbuffone
Date: Sat Jan 27 15:20:07 2007
New Revision: 500679

URL: http://svn.apache.org/viewvc?view=rev&rev=500679
Log:
changed template to have the right image links.

Added:
    incubator/xap/trunk/buildsystem/doc/images/arrow.gif   (with props)
    incubator/xap/trunk/buildsystem/doc/images/background.gif   (with props)
Modified:
    incubator/xap/trunk/buildsystem/doc/index.html

Added: incubator/xap/trunk/buildsystem/doc/images/arrow.gif
URL: http://svn.apache.org/viewvc/incubator/xap/trunk/buildsystem/doc/images/arrow.gif?view=auto&rev=500679
==============================================================================
Binary file - no diff available.

Propchange: incubator/xap/trunk/buildsystem/doc/images/arrow.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: incubator/xap/trunk/buildsystem/doc/images/background.gif
URL: http://svn.apache.org/viewvc/incubator/xap/trunk/buildsystem/doc/images/background.gif?view=auto&rev=500679
==============================================================================
Binary file - no diff available.

Propchange: incubator/xap/trunk/buildsystem/doc/images/background.gif
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Modified: incubator/xap/trunk/buildsystem/doc/index.html
URL: http://svn.apache.org/viewvc/incubator/xap/trunk/buildsystem/doc/index.html?view=diff&rev=500679&r1=500678&r2=500679
==============================================================================
--- incubator/xap/trunk/buildsystem/doc/index.html (original)
+++ incubator/xap/trunk/buildsystem/doc/index.html Sat Jan 27 15:20:07 2007
@@ -2,7 +2,7 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional">
 
 <head>
-<title>Apache XAP - Documentation</title>
+	<title>Apache XAP - Documentation</title>
 	<style type="text/css">
       <!--
           @import url(stylesheet.css);
@@ -13,6 +13,9 @@
           @import url(main.css);
       -->
     </style>
+	<style>
+	.cell {background-color: #eeeeee; padding: 3px; margin 2px; font-size: 10pt;}
+	</style>
 </head>
 
 <html>
@@ -60,8 +63,7 @@
 				<td valign=top style="padding: 0px; margin: 0px;">
 				<div
 					style="font-size: 11px; font-family: tahoma, Helvetica, sans-serif; white-space: nowrap;">&nbsp;
-				<a style="color: orange;" href="index.php@cid=1054.html"><b>API
-				Documentation</b></a><br>
+				<div style="color: orange;"><b>API Documentation</b></div>
 				<div
 					style="vertical-align: middle; background-image: url(images/menu.gif); background-repeat: no-repeat; background-position: top; height: 18px; padding: 1px; margin-bottom: 1px; margin-top: 12px;"><b>&nbsp;&nbsp;&nbsp;Application</b></div>
 				<img src="images/menu_bullet.gif" border=0
@@ -131,6 +133,55 @@
 			
 			<!-- THIS IS WHERE ALL THE STUFF GOES -->
 		
+<div style="font-size: 16px; color: #9999aa; font-weight: bold;">Welcome to the XAP Interface Documentation</div>
+<br /><br />
+This documentation provides detail on the JavaScript interfaces available in XAP.
+
+<br /><br />
+
+<b>Request Service</b>
+<table>
+<tr valign=top><td width=100 class=cell>RequestService</td><td class=cell width=400>The primary interface for synchronous and asynchronous network requests</td></tr>
+<tr valign=top><td width=100 class=cell>NetServiceListener</td><td class=cell width=400>Callback mechanism</td></tr>
+
+<tr valign=top><td width=100 class=cell>HttpRequest</td><td class=cell width=400>Low level http request object</td></tr>
+</table>
+
+<br /><br />
+
+<b>Session and Event</b>
+<table>
+<tr valign=top><td width=100 class=cell>ClientSession</td><td class=cell width=400>Root object for accessing client information</td></tr>
+<tr valign=top><td width=100 class=cell>ClientEvent</td><td class=cell width=400>Client event information</td></tr>
+<tr valign=top><td width=100 class=cell>Container</td><td class=cell width=400>Root container object</td></tr>
+
+<tr valign=top><td width=100 class=cell>DocumentContainer</td><td class=cell width=400>Maintains the various DOMs including the UI DOM</td></tr>
+</table>
+
+<br /><br />
+<b>DOM API</b>
+<table>
+<tr valign=top><td width=100 class=cell>Document</td><td class=cell width=400>DOM</td></tr>
+<tr valign=top><td width=100 class=cell>XapElement</td><td class=cell width=400>DOM Element</td></tr>
+</table>
+
+<br /><br />
+<b>Macro</b>
+<table>
+<tr valign=top><td width=100 class=cell>Macro</td><td class=cell width=400>Macro container</td></tr>
+</table>
+
+<br /><br />
+<b>Logging Interface</b>
+<table>
+<tr valign=top><td width=100 class=cell>LogFactory</td><td class=cell width=400>Provides general purpose loggng</td></tr>
+<tr valign=top><td width=100 class=cell>LogFactory.ConsoleLog</td><td class=cell width=400>Class for writing debug information to the console</td></tr>
+
+</table>
+
+<br/><br/>
+<span style="font-weight: bold;"><img src="images/arrow.gif">&nbsp;To view the interfaces, select from the menu at the left.</span>
+
 			
 			<!-- THIS IS WHERE ALL THE STUFF GOES -->