(index ("app-init" 0) ("register-roles" 439) ("config-set!" 905) ("config-get" 1103) ("config" 1272) ("config*" 1369) ("get-meta-list-page/html" 1467) ("get-new-article-form/html" 1787) ("get-article-edit-form/html" 1967) ("add-article" 2163) ("update-article" 2357) ("get-login-form/html" 2629) ("webform-login" 2785) ("unauthorized-message/html" 3029) ("setup-db" 3255) ("enable-sqlite" 3400) ("run" 3730))
(def (sig (procedure "(app-init #!key (site-path #f) (template-path #f))" (id app-init))) (p "Initialize the application. The SITE-PATH and TEMPLATE-PATH arguments are passed to " (int-link "civet") ", and you must specify one of the two. If SITE-PATH is specified, " (tt "civet") " will find templates in the " (b "templates") " subdirectory of that path. The value of either SITE-PATH or TEMPLATE-PATH should be an absolute pathname."))
(def (sig (procedure "(register-roles #!optional (roles (%default-roles%)))" (id register-roles))) (p "Since each user has a role, you must call this procedure before creating any users. The ROLES argument, if supplied, should be a list of strings; the default value is " (tt "'(\"admin\" \"editor\" \"author\" \"member\" \"guest\")") ".") (p "NOTE: as of version 0.1, these roles have no effect, but one or more roles must be defined in order to register users."))
(def (sig (procedure "(config-set! (KEY . VALUE) ...)" (id config-set!))) (p "Set multiple variables. Each argument must be a dotted pair where KEY is a symbol and VALUE is a string or a number."))
(def (sig (procedure "(config-get KEY ...)" (id config-get))) (p "Retrieve multiple variables. Returns an alist. Any undefined variables are omitted from the result."))
(def (sig (procedure "(config KEY [VALUE])" (id config))) (p "Sets or retrieves one variable."))
(def (sig (procedure "(config*)" (id config*))) (p "Returns an alist of all defined variables."))
(def (sig (procedure "(get-meta-list-page/html SUBJECT #!optional (out (current-output-port)) (logged-in #f))" (id get-meta-list-page/html))) (p "Generate an HTML page listing all items of a particular type. SUBJECT must be one of " (tt "'tags") ", " (tt "'categories") ", " (tt "'series") ", or " (tt "'authors") "."))
(def (sig (procedure "(get-new-article-form/html #!optional (out (current-output-port)))" (id get-new-article-form/html))) (p "Generate an HTML form for creating a new article."))
(def (sig (procedure "(get-article-edit-form/html ID/ALIAS #!optional (out (current-output-port)))" (id get-article-edit-form/html))) (p "Generate an HTML form for editing an existing article."))
(def (sig (procedure "(add-article FORM-DATA #!optional (out (current-output-port)))" (id add-article))) (p "Given FORM-DATA (as an alist), this procedure adds a new article to the database."))
(def (sig (procedure "(update-article ID/ALIAS FORM-DATA #!optional (out (current-output-port)))" (id update-article))) (p "Given an ID/ALIAS for an existing article and FORM-DATA (as an alist), this procedure updates the content and metadata of the specified article."))
(def (sig (procedure "(get-login-form/html #!optional (out (current-output-port)))" (id get-login-form/html))) (p "Generate an HTML form for user login."))
(def (sig (procedure "(webform-login FORM-DATA IP #!optional (out (current-output-port)))" (id webform-login))) (p "Handler for user login via the HTML form. When the username and password are accepted, sets a session cookie in the browser."))
(def (sig (procedure "(unauthorized-message/html REFERER #!optional (out (current-output-port)))" (id unauthorized-message/html))) (p "Generates a message informing the user that the action they attempted was unauthorized."))
(def (sig (procedure "(setup-db DB-FILE #!optional (force #f))" (id setup-db))) (p "Opens DB-FILE and sets up all tables for the application."))
(def (sig (procedure "(enable-sqlite DB-FILE CONTENT-PATH)" (id enable-sqlite))) (p "Configures the database layer to use the procedures in this egg. DB-FILE is the Sqlite3 database file, which should be the same file as specified in " (tt "setup-db") ". CONTENT-PATH is a directory where article content files will be stored."))
(def (sig (procedure "(run LISTEN-PORT #!optional (testing #f))" (id run))) (p "Runs the FastCGI server on LISTEN-PORT, which may be either a TCP port (integer) or a unix socket (string). See the " (int-link "fastcgi") " documentation for more information. The TESTING parameter disables the HTTPS-only requirement for secured resources."))
