Move wizard.scripts module to plugins, added hooks accordingly.

[wizard.git] / doc / plugin.rst

diff --git a/doc/plugin.rst b/doc/plugin.rst
index 86d95240171597f4c888342277ab5f6e2318d206..c30fc5df4deba002a1ab9133c45039e2ea985b53 100644 (file)
--- a/doc/plugin.rst
+++ b/doc/plugin.rst
@@ -43,7 +43,7 @@ For more information on how to create an application, check
 
 .. todo::
 
-    The below plugins are not implemented by Wizard yet.
+    Plugins marked with prototype todo messages are not complete yet.
 
 ``wizard.strategy``
 -------------------
@@ -59,6 +59,16 @@ able to be determined from an application's configuration files.
 
 .. todo:: Prototype
 
+``wizard.deploy.web``
+---------------------
+
+Used to fill in a user's web URL if it is not able to be determined from
+an application's configuration files.  Plugin should be a function that
+takes a single required argument ``dir``, which is the directory to
+determint the web URL(s) for, and return a list or generator of
+:class:`urlparse.ParseResult` objects or URL strings of possible web locations
+for an application.
+
 ``wizard.user.email``
 ---------------------
 
@@ -87,3 +97,15 @@ resolve the username from a UID.  Use this hook to implement an
 alternative ``passwd`` lookup.
 
 .. todo:: Prototype
+
+``wizard.user.quota``
+---------------------
+
+Plugin for :func:`wizard.user.quota`.  Wizard has safeguards for
+avoiding exceeding user quotas when an automated upgrade is being
+performed.  Unfortunately, methods for enforcing quotas are frequently
+highly system dependent.  Use this hook to implement quota usage and
+limit reporting.  Plugin should be a function that takes a single
+required argument ``dir``, which is the directory to determine the quota
+for, and return a tuple ``(quota usage, quota limit)`` or ``(0, None)``
+if it could not determine quota.