]> gitweb.factorcode.org Git - factor.git/commitdiff
cgi: add some docs.
authorJohn Benediktsson <mrjbq7@gmail.com>
Thu, 25 Oct 2012 02:19:14 +0000 (19:19 -0700)
committerJohn Benediktsson <mrjbq7@gmail.com>
Thu, 25 Oct 2012 02:20:02 +0000 (19:20 -0700)
extra/cgi/cgi-docs.factor

index 75561912b35302948da50c2e53e988e3e7c17d2d..fe11db89502825d749feeeb13f34d9a9cd56302f 100644 (file)
@@ -10,3 +10,16 @@ HELP: <cgi-form>
 HELP: <cgi-simple-form>
 { $values { "assoc" assoc } }
 { $description "Parse a CGI request into an " { $link assoc } ". Only the first parameter is kept, if multiple parameters are passed." } ;
+
+ARTICLE: "cgi" "CGI (Common Gateway Interface)"
+"The " { $vocab-link "cgi" } " can be used to parse a CGI request:"
+{ $subsections
+    <cgi-form>
+    <cgi-simple-form>
+}
+{ $heading "Troubleshooting" }
+"If the CGI script leaves elements on the stack, you'll get an error like the following (after running all of the code in your script):"
+$nl
+{ $snippet "Quotation called with wrong stack effect effect ( -- )" } ;
+
+ABOUT: "cgi"