extra/cgi/cgi-docs.factor

   1 ! Copyright (C) 2009-2012 John Benediktsson
   2 ! See http://factorcode.org/license.txt for BSD license
   3 USING: assocs help.markup help.syntax ;
   4 IN: cgi
   5
   6 HELP: <cgi-form>
   7 { $values { "assoc" assoc } }
   8 { $description "Parse a CGI request into an " { $link assoc } ". Multiple parameters are passed as a list for each key." } ;
   9
  10 HELP: <cgi-simple-form>
  11 { $values { "assoc" assoc } }
  12 { $description "Parse a CGI request into an " { $link assoc } ". Only the first parameter is kept, if multiple parameters are passed." } ;
  13
  14 ARTICLE: "cgi" "CGI (Common Gateway Interface)"
  15 "The " { $vocab-link "cgi" } " can be used to parse a CGI request:"
  16 { $subsections
  17     <cgi-form>
  18     <cgi-simple-form>
  19 }
  20 { $heading "Troubleshooting" }
  21 "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):"
  22 $nl
  23 { $snippet "Quotation called with wrong stack effect effect ( -- )" } ;
  24
  25 ABOUT: "cgi"