address standardization part one, finally checked in from here
[freeside.git] / httemplate / elements / xmlhttp.html
index 3f4462b..d0c7990 100644 (file)
@@ -1,3 +1,19 @@
+<%doc>
+
+Example:
+
+  include( '/elements/xmlhttp.html',
+    # required
+    'url'  => $p.'misc/something.html',
+    'subs' => [ 'subroutine' ],
+
+    # optional
+    'method' => 'GET', #defaults to GET, could specify POST
+    'key'    => 'unique', #unique key
+
+  );
+
+</%doc>
 <SCRIPT TYPE="text/javascript">
 
   function rs_init_object() {