basis/furnace/furnace-docs.factor

   1 USING: help.markup help.syntax ;
   2 IN: furnace
   3
   4 ARTICLE: "furnace.persistence" "Furnace persistence layer"
   5 { $subsections "furnace.db" }
   6 "Server-side state:"
   7 { $subsections
   8     "furnace.sessions"
   9     "furnace.conversations"
  10     "furnace.asides"
  11     "furnace.presentation"
  12 } ;
  13
  14 ARTICLE: "furnace.presentation" "Furnace presentation layer"
  15 "HTML components:"
  16 { $subsections
  17     "html.components"
  18     "html.forms"
  19 }
  20 "Content templates:"
  21 { $subsections
  22     "html.templates"
  23     "html.templates.chloe"
  24     "html.templates.fhtml"
  25     "furnace.boilerplate"
  26 }
  27 "Other types of content:"
  28 { $subsections
  29     "furnace.syndication"
  30     "furnace.json"
  31 } ;
  32
  33 ARTICLE: "furnace.load-balancing" "Load balancing and fail-over with Furnace"
  34 "The Furnace session manager persists sessions to a database. This means that HTTP requests can be transparently distributed between multiple Factor HTTP server instances, running the same web app on top of the same database, as long as the web applications do not use mutable global state, such as global variables. The Furnace framework itself does not use any mutable global state." ;
  35
  36 ARTICLE: "furnace" "Furnace framework"
  37 "The " { $vocab-link "furnace" } " vocabulary implements a full-featured web framework on top of the " { $link "http.server" } ". Some of its features include:"
  38 { $list
  39     "Session management capable of load-balancing and fail-over"
  40     "Form components and validation"
  41     "Authentication system with basic authentication or login pages, and pluggable authentication backends"
  42     "Easy Atom feed syndication"
  43     "Conversation scope and asides for complex page flow"
  44 }
  45 "Major functionality:"
  46 { $subsections
  47     "furnace.actions"
  48     "furnace.alloy"
  49     "furnace.persistence"
  50     "furnace.presentation"
  51     "furnace.auth"
  52     "furnace.load-balancing"
  53 }
  54 "Utilities:"
  55 { $subsections
  56     "furnace.referrer"
  57     "furnace.redirection"
  58     "furnace.extension-points"
  59     "furnace.misc"
  60 }
  61 "Related frameworks:"
  62 { $subsections
  63     "db"
  64     "xml"
  65     "http.server"
  66     "logging"
  67     "urls"
  68 } ;
  69
  70 ABOUT: "furnace"