extra/webapps/user-admin/user-admin-docs.factor

   1 USING: help.markup help.syntax db strings ;
   2 IN: webapps.user-admin
   3
   4 HELP: <user-admin>
   5 { $values { "responder" "a new responder" } }
   6 { $description "Creates a new instance of the user admin tool. This tool must be added to an authentication realm, and access is restricted to users having the " { $link can-administer-users? } " capability." } ;
   7
   8 HELP: can-administer-users?
   9 { $description "A user capability. Users having this capability may use the " { $link user-admin } " tool." }
  10 { $notes "See " { $link "furnace.auth.capabilities" } " for information about capabilities." } ;
  11
  12 HELP: make-admin
  13 { $values { "username" string } }
  14 { $description "Makes an existing user into an administrator by giving them the " { $link can-administer-users? } " capability, thus allowing them to use the user admin tool." } ;
  15
  16 ARTICLE: "furnace.auth.user-admin" "Furnace user administration tool"
  17 "The " { $vocab-link "webapps.user-admin" } " vocabulary implements a web application for adding, removing and editing users in authentication realms that use " { $link "furnace.auth.providers.db" } "."
  18 { $subsection <user-admin> }
  19 "Access to the web app itself is protected, and only users having an administrative capability can access it:"
  20 { $subsection can-administer-users? }
  21 "To make an existing user an administrator, call the following word in a " { $link with-db } " scope:"
  22 { $subsection make-admin } ;