[Checkins] SVN: bluebream/trunk/docs/source/ outline for docs

[Baiju M]

Log message for revision 107639:
  outline for docs
  

Changed:
  A   bluebream/trunk/docs/source/faq.rst
  A   bluebream/trunk/docs/source/gettingstarted.rst
  U   bluebream/trunk/docs/source/index.rst
  A   bluebream/trunk/docs/source/introduction.rst
  A   bluebream/trunk/docs/source/reference.rst
  A   bluebream/trunk/docs/source/tutorial.rst

-=-
Added: bluebream/trunk/docs/source/faq.rst
===================================================================
--- bluebream/trunk/docs/source/faq.rst	                        (rev 0)
+++ bluebream/trunk/docs/source/faq.rst	2010-01-04 17:44:48 UTC (rev 107639)
@@ -0,0 +1,2 @@
+FAQ
+===

Added: bluebream/trunk/docs/source/gettingstarted.rst
===================================================================
--- bluebream/trunk/docs/source/gettingstarted.rst	                        (rev 0)
+++ bluebream/trunk/docs/source/gettingstarted.rst	2010-01-04 17:44:48 UTC (rev 107639)
@@ -0,0 +1,2 @@
+Getting Started
+===============

Modified: bluebream/trunk/docs/source/index.rst
===================================================================
--- bluebream/trunk/docs/source/index.rst	2010-01-04 17:39:53 UTC (rev 107638)
+++ bluebream/trunk/docs/source/index.rst	2010-01-04 17:44:48 UTC (rev 107639)
@@ -1,11 +1,16 @@
 Welcome to BlueBream's documentation!
 =====================================
 
-Contents:
-
 .. toctree::
+   :numbered:
    :maxdepth: 2
 
+   introduction
+   gettingstarted
+   tutorial
+   reference
+   faq
+
 Indices and tables
 ==================
 

Added: bluebream/trunk/docs/source/introduction.rst
===================================================================
--- bluebream/trunk/docs/source/introduction.rst	                        (rev 0)
+++ bluebream/trunk/docs/source/introduction.rst	2010-01-04 17:44:48 UTC (rev 107639)
@@ -0,0 +1,3 @@
+Introduction
+============
+

Added: bluebream/trunk/docs/source/reference.rst
===================================================================
--- bluebream/trunk/docs/source/reference.rst	                        (rev 0)
+++ bluebream/trunk/docs/source/reference.rst	2010-01-04 17:44:48 UTC (rev 107639)
@@ -0,0 +1,285 @@
+Reference
+=========
+
+zope.app.wsgi
+-------------
+
+- getWSGIApplication
+
+::
+
+  def getWSGIApplication(configfile, schemafile=None, features=(),
+                         requestFactory=HTTPPublicationRequestFactory,
+                         handle_errors=True):
+      db = config(configfile, schemafile, features)
+      application = WSGIPublisherApplication(db, requestFactory, handle_errors)
+
+      # Create the application, notify subscribers.
+      notify(interfaces.WSGIPublisherApplicationCreated(application))
+
+      return application
+
+The first argument "configfile" should an absolute path to
+"zope.conf" file.  All other arguments are optional.  The
+"schemafile" argument value will be the ZConfig schema (XXX: what is
+ZConfig) file.  By default the value for "schemafile" will be
+"schema/schema.xml" defined inside "zope.app.appsetup".
+
+..
+   It looks like the number of databases mentioned in "zope.conf" is
+   not considered, Zope will use only one::
+
+     # Connect to and open the database, notify subscribers.
+     db = appsetup.multi_database(options.databases)[0][0]
+
+   Is there any use case for opening multiple database configuration
+   ?  May be for mounting ?
+
+zope.annotation
+---------------
+
+zope.app.applicationcontrol
+---------------------------
+
+zope.app.appsetup
+-----------------
+
+zope.app.authentication
+-----------------------
+
+zope.app.basicskin
+------------------
+
+zope.app.broken
+---------------
+
+zope.app.component
+------------------
+
+zope.app.container
+------------------
+
+zope.app.content
+----------------
+
+zope.app.debug
+--------------
+
+zope.app.dependable
+-------------------
+
+zope.app.error
+--------------
+
+zope.app.folder
+---------------
+
+zope.app.form
+-------------
+
+zope.app.generations
+--------------------
+
+zope.app.i18n
+-------------
+
+zope.app.interface
+------------------
+
+zope.app.locales
+----------------
+
+zope.app.localpermission
+------------------------
+
+zope.app.pagetemplate
+---------------------
+
+zope.app.principalannotation
+----------------------------
+
+zope.app.publication
+--------------------
+
+zope.app.publisher
+------------------
+
+zope.app.renderer
+-----------------
+
+zope.app.rotterdam
+------------------
+
+zope.app.schema
+---------------
+
+zope.app.security
+-----------------
+
+zope.app.server
+---------------
+
+zope.app.testing
+----------------
+
+zope.app.twisted
+----------------
+
+zope.app.zopeappgenerations
+---------------------------
+
+zope.authentication
+-------------------
+
+zope.broken
+-----------
+
+zope.browser
+------------
+
+zope.browsermenu
+----------------
+
+zope.browserpage
+----------------
+
+zope.browserresource
+--------------------
+
+zope.cachedescriptors
+---------------------
+
+zope.component
+--------------
+
+zope.componentvocabulary
+------------------------
+
+zope.configuration
+------------------
+
+zope.container
+--------------
+
+zope.contenttype
+----------------
+
+zope.copy
+---------
+
+zope.copypastemove
+------------------
+
+zope.datetime
+-------------
+
+zope.deferredimport
+-------------------
+
+zope.deprecation
+----------------
+
+zope.dottedname
+---------------
+
+zope.dublincore
+---------------
+
+zope.error
+----------
+
+zope.event
+----------
+
+zope.exceptions
+---------------
+
+zope.filerepresentation
+-----------------------
+
+zope.formlib
+------------
+
+zope.hookable
+-------------
+
+zope.i18n
+---------
+
+zope.i18nmessageid
+------------------
+
+zope.interface
+--------------
+
+zope.lifecycleevent
+-------------------
+
+zope.location
+-------------
+
+zope.minmax
+-----------
+
+zope.pagetemplate
+-----------------
+
+zope.password
+-------------
+
+zope.principalannotation
+------------------------
+
+zope.principalregistry
+----------------------
+
+zope.processlifetime
+--------------------
+
+zope.proxy
+----------
+
+zope.ptresource
+---------------
+
+zope.publisher
+--------------
+
+zope.schema
+-----------
+
+zope.security
+-------------
+
+zope.securitypolicy
+-------------------
+
+zope.server
+-----------
+
+zope.session
+------------
+
+zope.site
+---------
+
+zope.size
+---------
+
+zope.structuredtext
+-------------------
+
+zope.tal
+--------
+
+zope.tales
+----------
+
+zope.testbrowser
+----------------
+
+zope.testing
+------------
+
+zope.traversing
+---------------

Added: bluebream/trunk/docs/source/tutorial.rst
===================================================================
--- bluebream/trunk/docs/source/tutorial.rst	                        (rev 0)
+++ bluebream/trunk/docs/source/tutorial.rst	2010-01-04 17:44:48 UTC (rev 107639)
@@ -0,0 +1,2 @@
+Tutorial
+========