basis/furnace/auth/features/registration/registration-docs.factor

   1 USING: help.markup help.syntax kernel ;
   2 IN: furnace.auth.features.registration
   3
   4 HELP: allow-registration
   5 { $values { "realm" "an authentication realm" } }
   6 { $description "Adds a " { $snippet "registration" } " action to an authentication realm." } ;
   7
   8 HELP: allow-registration?
   9 { $values { "?" "a boolean" } }
  10 { $description "Outputs true if the current authentication realm allows user registration." } ;
  11
  12 ARTICLE: "furnace.auth.features.registration" "User registration"
  13 "The " { $vocab-link "furnace.auth.features.registration" } " vocabulary implements an authentication feature for user registration, allowing new users to create accounts."
  14 $nl
  15 "To enable this feature, call the following word on an authentication realm:"
  16 { $subsection allow-registration }
  17 "To check if user registration is enabled:"
  18 { $subsection allow-registration? }
  19 "This feature adds a " { $snippet "register" } " action to the realm. A link to this action is inserted on the login page if the " { $vocab-link "furnace.auth.login" } " authentication realm is used. Links to this action can be inserted from other pages using the following Chloe XML snippet:"
  20 { $code
  21     "<t:if t:code=\"furnace.auth.features.registration:allow-registration?\">"
  22     "    <t:button t:action=\"$realm/register\">Register</t:button>"
  23     "</t:if>"
  24 } ;