basis/furnace/auth/login/login-docs.factor

   1 USING: help.markup help.syntax strings ;
   2 IN: furnace.auth.login
   3
   4 HELP: <login-realm>
   5 { $values
   6      { "responder" "a responder" } { "name" string }
   7      { "realm" "a new responder" }
   8 }
   9 { $description "Wraps a responder in a new login realm with the given name. The realm must be configured before use; see " { $link "furnace.auth.realm-config" } "." } ;
  10
  11 HELP: login-realm
  12 { $class-description "The login realm class. Slots are described in " { $link "furnace.auth.realm-config" } "." } ;
  13
  14 ARTICLE: "furnace.auth.login" "Login authentication"
  15 "The " { $vocab-link "furnace.auth.login" } " vocabulary implements an authentication realm which displays a login page with a username and password field."
  16 { $subsections
  17     login-realm
  18     <login-realm>
  19 }
  20 "The " { $snippet "logout" } " action logs the user out of the realm, and a link to this action can be inserted in Chloe templates using the following XML snippet:"
  21 { $code
  22     "<t:button t:action=\"$login-realm/logout\">Logout</t:button>"
  23 } ;
  24
  25 ABOUT: "furnace.auth.login"