basis/furnace/auth/features/deactivate-user/deactivate-user-docs.factor

   1 USING: help.markup help.syntax kernel ;
   2 IN: furnace.auth.features.deactivate-user
   3
   4 HELP: allow-deactivation
   5 { $values { "realm" "an authentication realm" } }
   6 { $description "Adds a " { $snippet "deactivate-user" } " action to an authentication realm." } ;
   7
   8 HELP: allow-deactivation?
   9 { $values { "?" "a boolean" } }
  10 { $description "Outputs true if the current authentication realm allows user profile deactivation." } ;
  11
  12 ARTICLE: "furnace.auth.features.deactivate-user" "User profile deactivation"
  13 "The " { $vocab-link "furnace.auth.features.deactivate-user" } " vocabulary implements an authentication feature for user profile deactivation, allowing users to voluntarily deactivate their account."
  14 $nl
  15 "To enable this feature, call the following word on an authentication realm:"
  16 { $subsections allow-deactivation }
  17 "To check if deactivation is enabled:"
  18 { $subsections allow-deactivation? }
  19 "This feature adds a " { $snippet "deactivate-user" } " action to the realm, and a link to this action can be inserted in Chloe templates using the following XML snippet:"
  20 { $code
  21     "<t:if t:code=\"furnace.auth.features.deactivate-user:allow-deactivation?\">"
  22     "    <t:button t:action=\"$realm/deactivate-user\">Deactivate user</t:button>"
  23     "</t:if>"
  24 } ;
  25
  26 ABOUT: "furnace.auth.features.deactivate-user"