Commits

Greg Slepak committed d55f8fc

more doc updates and removed redundant .htaccess in dragonfly-framework

Comments (0)

Files changed (6)

example-site/dragonfly-framework/.htaccess

-Options -indexes
-
-<Files ~ "\.lsp$">
-Order allow,deny
-Deny from all
-</Files>

example-site/dragonfly-framework/docs/index.html

 <p></p>
 <a href="request.lsp.html#_$GET">$GET</a>&nbsp; &nbsp; <a href="request.lsp.html#_$POST">$POST</a>&nbsp; &nbsp; <a href="request.lsp.html#_$FILES">$FILES</a>&nbsp; &nbsp; <a href="request.lsp.html#_$COOKIES">$COOKIES</a>&nbsp; &nbsp; <a href="request.lsp.html#_$BINARY">$BINARY</a>&nbsp; &nbsp; <a href="response.lsp.html"><br/><br/><h2>Module:&nbsp;response.lsp</h2></a>
 <p></p>
-<a href="response.lsp.html#Response_status">status</a>&nbsp; &nbsp; <a href="response.lsp.html#Response_header">header</a>&nbsp; &nbsp; <a href="response.lsp.html#Response_cookie">cookie</a>&nbsp; &nbsp; <a href="response.lsp.html#Request_cookie">cookie</a>&nbsp; &nbsp; <a href="utils.lsp.html"><br/><br/><h2>Module:&nbsp;utils.lsp</h2></a>
+<a href="response.lsp.html#Response_status">status</a>&nbsp; &nbsp; <a href="response.lsp.html#Response_header">header</a>&nbsp; &nbsp; <a href="response.lsp.html#Response_cookie">cookie</a>&nbsp; &nbsp; <a href="response.lsp.html#Respons_send-headers">send-headers</a>&nbsp; &nbsp; <a href="utils.lsp.html"><br/><br/><h2>Module:&nbsp;utils.lsp</h2></a>
 <p></p>
 <a href="utils.lsp.html#_regex-captcha">regex-captcha</a>&nbsp; &nbsp; <a href="utils.lsp.html#_load-files-in-dir">load-files-in-dir</a>&nbsp; &nbsp; 
 <br/><br/><center>- &part; -</center><br/>

example-site/dragonfly-framework/docs/request.lsp.html

  Use them to retrieve the GET/POST values.
  If a variable was specified, but no value assigned (i.e. <tt>/?foo</tt>), then
  the value will be an empty string (you can use <tt>empty?</tt> to check for this).
- If the variable doesn<tt>t exist, 'nil</tt> will be returned.
+ If the variable does not exist, <tt>nil</tt> will be returned.
 <br/><br/>
  The values are url decoded:
  <pre> "What+time+is+it%3f"  => "What time is it?"</pre>

example-site/dragonfly-framework/docs/response.lsp.html

 
 <br/><br/><center>- &sect; -</center><br/>
 <a name="Response_status"></a><h3><font color=#CC0000>Response:status</font></h3>
-<b>syntax: (<font color=#CC0000>Response:status</font> [<em>int-code</em>] [<em>str-description</em>])</b><br/>
+<b>syntax: (<font color=#CC0000>Response:status</font>)</b><br/>
+<b>syntax: (<font color=#CC0000>Response:status</font> <em>int-code</em> [<em>str-description</em>])</b><br/>
+ <br>In the first syntax...
 
 <br/><br/><center>- &sect; -</center><br/>
 <a name="Response_header"></a><h3><font color=#CC0000>Response:header</font></h3>
 <b>syntax: (<font color=#CC0000>Response:header</font> <em>str-key</em>)</b><br/>
 <b>parameter: </b><em>str-key</em> - the header's name<br/>
-<br/><br/>
 <b>syntax: (<font color=#CC0000>Response:header</font> <em>str-key</em> <em>str-value</em>)</b><br/>
 <b>parameter: </b><em>str-key</em> - the header's name<br/>
 <b>parameter: </b><em>str-value</em> - the header's value<br/>
- <p>In the first syntax, returns the header matching <em>str-key</em> or,
- if <em>str-key</em> is nil, all of the headers in a list</p>
- <p>In the second syntax, sets or updates the header matching <em>str-key</em> or,
- if <em>str-value</em> is nil, deletes the header for <em>str-key</em>.</p>
+ <br>In the first syntax, returns the header matching <em>str-key</em> or,
+ if <em>str-key</em> is nil, all of the headers in a list.
+ <br>In the second syntax, sets or updates the header matching <em>str-key</em> or,
+ if <em>str-value</em> is nil, deletes the header for <em>str-key</em>.
 
 <br/><br/><center>- &sect; -</center><br/>
 <a name="Response_cookie"></a><h3><font color=#CC0000>Response:cookie</font></h3>
 <b>syntax: (<font color=#CC0000>Response:cookie</font> <em>str-key</em>)</b><br/>
 <b>parameter: </b><em>str-key</em> - the cookie's name<br/>
-<br/><br/>
-<br/><br/><center>- &sect; -</center><br/>
-<a name="Request_cookie"></a><h3><font color=#CC0000>Request:cookie</font></h3>
-<b>syntax: (<font color=#CC0000>Request:cookie</font> <em>str-key</em> <em>str-value</em> [<em>int-expires</em> [<em>str-path</em> [<em>str-domain</em> [<em>bool-http-only</em>]]]])</b><br/>
+<b>syntax: (<font color=#CC0000>Response:cookie</font> <em>str-key</em> <em>str-value</em> [<em>int-expires</em> [<em>str-path</em> [<em>str-domain</em> [<em>bool-http-only</em>]]]])</b><br/>
 <b>parameter: </b><em>str-key</em> - the cookie's name<br/>
 <b>parameter: </b><em>str-value</em> - the cookie's value<br/>
 <b>parameter: </b><em>int-expires</em> - (optional) the expiration date of the cookie as a unix timestamp; default is a session cookie<br/>
 <b>parameter: </b><em>str-domain</em> - (optional) the cookie's domain; default is the current host<br/>
 <b>parameter: </b><em>bool-http-only</em> - (optional) whether the cookie may be read by client-side scripts<br/>
  <p>In the first syntax, <tt>cookie</tt> returns the value of the cookie named <em>str-key</em> or <tt>nil</tt>. If
- <em>str-key</em> is not provided, an association list of all cookie values is returned.</p>
+ <em>str-key</em> is not provided, an association list of all cookie key/value pairs is returned.</p>
  <p>In the second syntax, <tt>cookie</tt> sets a new cookie. If <em>str-value</em> is nil then any existing
  cookie is deleted, otherwise it is updated with the value and the rest of the parameters.</p>
 
+<br/><br/><center>- &sect; -</center><br/>
+<a name="Response_send-headers"></a><h3><font color=#CC0000>Response:send-headers</font></h3>
+<b>syntax: (<font color=#CC0000>Response:send-headers</font>)</b><br/>
+ <br>Actually sends the headers (without buffering them to <tt>Dragonfly:STDOUT</tt>).
+ Normally you should never call this yourself!
 
 
 

example-site/dragonfly-framework/lib/request.lsp

 ;; Use them to retrieve the GET/POST values.
 ;; If a variable was specified, but no value assigned (i.e. '/?foo'), then
 ;; the value will be an empty string (you can use 'empty?' to check for this).
-;; If the variable doesn't exist, 'nil' will be returned.
+;; If the variable does not exist, 'nil' will be returned.
 ;; 
 ;; The values are url decoded:
 ;; <pre> "What+time+is+it%3f"  => "What time is it?"</pre>

example-site/dragonfly-framework/lib/response.lsp

 ; !Public API
 ;===============================================================================
 
-;; @syntax (Response:status [<int-code>] [<str-description>])
+;; @syntax (Response:status)
+;; @syntax (Response:status <int-code> [<str-description>])
+;; <br>In the first syntax...
 (define (status code description)
 	(if code
 		(begin
 
 ;; @syntax (Response:header <str-key>)
 ;; @param <str-key> the header's name
-;; 
 ;; @syntax (Response:header <str-key> <str-value>)
 ;; @param <str-key> the header's name
 ;; @param <str-value> the header's value
-;; <p>In the first syntax, returns the header matching <str-key> or,
-;; if <str-key> is nil, all of the headers in a list</p>
-;; <p>In the second syntax, sets or updates the header matching <str-key> or,
-;; if <str-value> is nil, deletes the header for <str-key>.</p>
+;; <br>In the first syntax, returns the header matching <str-key> or,
+;; if <str-key> is nil, all of the headers in a list.
+;; <br>In the second syntax, sets or updates the header matching <str-key> or,
+;; if <str-value> is nil, deletes the header for <str-key>.
 (define (header key)
 	(if (nil? key) headers
 		(empty? $args) (lookup key headers)
 
 ;; @syntax (Response:cookie <str-key>)
 ;; @param <str-key> the cookie's name
-;; 
-;; @syntax (Request:cookie <str-key> <str-value> [<int-expires> [<str-path> [<str-domain> [<bool-http-only>]]]])
+;; @syntax (Response:cookie <str-key> <str-value> [<int-expires> [<str-path> [<str-domain> [<bool-http-only>]]]])
 ;; @param <str-key> the cookie's name
 ;; @param <str-value> the cookie's value
 ;; @param <int-expires> (optional) the expiration date of the cookie as a unix timestamp; default is a session cookie
 ;; @param <str-domain> (optional) the cookie's domain; default is the current host
 ;; @param <bool-http-only> (optional) whether the cookie may be read by client-side scripts
 ;; <p>In the first syntax, 'cookie' returns the value of the cookie named <str-key> or 'nil'. If
-;; <str-key> is not provided, an association list of all cookie values is returned.</p>
+;; <str-key> is not provided, an association list of all cookie key/value pairs is returned.</p>
 ;; <p>In the second syntax, 'cookie' sets a new cookie. If <str-value> is nil then any existing
 ;; cookie is deleted, otherwise it is updated with the value and the rest of the parameters.</p>
 (define (cookie key)
 	)
 )
 
+;; @syntax (Response:send-headers)
+;; <br>Actually sends the headers (without buffering them to 'Dragonfly:STDOUT').
+;; Normally you should never call this yourself!
 (define (send-headers)
 	(sys-print "Status: " status-code " " (lookup status-code status-codes) "\r\n")
 	(dolist (header headers) (sys-print (first header) ": " (last header) "\r\n"))