[Checkins] SVN: grok/trunk/doc/reference/ document grok.IApplicationInitializedEvent

[Kevin Teague]

Log message for revision 105838:
  document grok.IApplicationInitializedEvent

Changed:
  U   grok/trunk/doc/reference/events.rst
  U   grok/trunk/doc/reference/index.rst
  A   grok/trunk/doc/reference/utils.rst

-=-
Modified: grok/trunk/doc/reference/events.rst
===================================================================
--- grok/trunk/doc/reference/events.rst	2009-11-18 18:05:19 UTC (rev 105837)
+++ grok/trunk/doc/reference/events.rst	2009-11-18 18:05:34 UTC (rev 105838)
@@ -18,7 +18,24 @@
 
         The subject of the event taking place.
 
+:class:`IApplicationInitializedEvent`
+=====================================
 
+A Grok Application has been created with success and is now ready
+to be used.
+
+This event can be used to trigger the creation of contents or other tasks
+that require the application to be fully operational : utilities installed
+and indexes created in the catalog.
+
+.. class:: grok.IApplicationInitializedEvent
+
+    Interface to subscribe to application initialization.
+
+    .. attribute:: object
+
+        The application that has just been initialized.
+
 :class:`IObjectModifiedEvent`
 =============================
 
@@ -213,7 +230,19 @@
         def __init__(self, object):
             self.object = object
 
+:class:`ApplicationInitializedEvent`
+=====================================
 
+Event object to send after an application has been created.
+
+.. class:: grok.ApplicationInitializedEvent
+
+    Default event implementation of the `grok.IApplicationInitializedEvent` interface.
+
+    .. attribute:: object
+
+        The application that has just been initialized.
+
 :class:`ObjectModifiedEvent`
 ============================
 

Modified: grok/trunk/doc/reference/index.rst
===================================================================
--- grok/trunk/doc/reference/index.rst	2009-11-18 18:05:19 UTC (rev 105837)
+++ grok/trunk/doc/reference/index.rst	2009-11-18 18:05:34 UTC (rev 105838)
@@ -18,6 +18,7 @@
    directives.rst
    decorators.rst
    functions.rst
+   utils.rst
    events.rst
    exceptions.rst
    testing.rst

Added: grok/trunk/doc/reference/utils.rst
===================================================================
--- grok/trunk/doc/reference/utils.rst	                        (rev 0)
+++ grok/trunk/doc/reference/utils.rst	2009-11-18 18:05:34 UTC (rev 105838)
@@ -0,0 +1,42 @@
+*********
+Utilities
+*********
+
+The :mod:`grok.util` module provides functions which are less commonly
+used, and so are not available for import directly from the :mod:`grok` module.
+
+:func:`grok.util.make_checker`
+==============================
+
+.. function:: grok.util.make_checker(factory, view_factory, permission, method_names=None)
+
+    Make a checker for a view_factory associated with factory.
+
+    These could be one and the same for normal views, or different
+    in case we make method-based views such as for JSON and XMLRPC.
+
+:func:`grok.util.safely_locate_maybe`
+=====================================
+
+.. function:: grok.util.safely_locate_maybe(obj, parent, name)
+
+    Set an object's __parent__ (and __name__) if the object's
+    __parent__ attribute doesn't exist yet or is None.
+
+    If the object provides ILocation, __parent__ and __name__ will be
+    set directly.  A location proxy will be returned otherwise.
+
+:func:`grok.util.applySkin`
+===========================
+
+.. function:: grok.util.applySkin(request, skin, skin_type)
+
+    Change the presentation skin for this request.
+
+:func:`grok.util.create_application`
+====================================
+
+.. function:: grok.util.create_application(factory, container, name)
+
+    Creates an application and triggers the events from
+    the application lifecycle.