[Checkins] SVN: bluebream/trunk/docs/source/ expand few more section

Baiju M baiju.m.mail at gmail.com
Thu Jan 14 11:52:36 EST 2010


Log message for revision 108124:
  expand few more section
  

Changed:
  U   bluebream/trunk/docs/source/gettingstarted.rst
  U   bluebream/trunk/docs/source/introduction.rst
  U   bluebream/trunk/docs/source/tutorial.rst

-=-
Modified: bluebream/trunk/docs/source/gettingstarted.rst
===================================================================
--- bluebream/trunk/docs/source/gettingstarted.rst	2010-01-14 16:50:47 UTC (rev 108123)
+++ bluebream/trunk/docs/source/gettingstarted.rst	2010-01-14 16:52:35 UTC (rev 108124)
@@ -312,26 +312,26 @@
 Example 1: Hello World without page template
 --------------------------------------------
 
-To create a page which displays ``Hello World!``, you need to create
-a view and then register it using ``browser:page`` ZCML directive.
-By default, the default page which you are getting when you access:
-http://localhost:8080 is a page registerd like this.  You can see the
-registration inside ``configure.zcml``, the name of view will be
-``index``.  You can access the default page by explicitly mentioning
-the view name in the URL like this: http://localhost:8080/@@index.
-You can refer the :ref:`howto-default-view` HOWTO for more details
-about how the default view for a container object is working.  The
-term *view* and *page* can be used almost use interchangeably in the
-browser context.  But, *view* is very low level, and can be used to
-refer XMLRPC, REST and other views.
+To create a web page which displays ``Hello World!``, you need to
+create a page and then register it using ``browser:page`` ZCML
+directive.  In BlueBream, we call it as *Browser Page* or more
+generic term, *View* which can be used to refer XMLRPC, REST and
+other views.  By default, the default page which you are getting when
+you access: http://localhost:8080 is a page registerd like this.  You
+can see the registration inside ``configure.zcml``, the name of view
+will be ``index``.  You can access the default page by explicitly
+mentioning the page name in the URL like this:
+http://localhost:8080/@@index.  You can refer the
+:ref:`howto-default-view` HOWTO for more details about how the
+default view for a container object is working.
 
 First you need to create a Python file named ``myhello.py`` at
 ``src/mynamespace/main/myhello.py``::
 
   $ touch src/mynamespace/main/myhello.py
 
-You can define your browser view inside this module.  All browser
-views should implement
+You can define your browser page inside this module.  All browser
+pages should implement
 ``zope.publisher.interfaces.browser.IBrowserView`` interface.  An
 easy way to do this would be to inherit from
 ``zope.publisher.browser.BrowserView`` which is already implementing
@@ -346,8 +346,8 @@
       def __call__(self):
           return "Hello World!"
 
-Now you can register this view for a particular interface.  So that
-it will be available as a browser view for any object which implement
+Now you can register this page for a particular interface.  So that
+it will be available as a browser page for any object which implement
 this.  At this point you can register this for root folder which is
 implementing ``zope.site.interfaces.IRootFolder`` interface.
 
@@ -427,14 +427,10 @@
 available for any content, rendered by the template helloworld.pt,
 and this page is public.  This kind of XML configuration is very
 common in BlueBream and you will need it for every page or component.
-If you feel extremely uncomfortable with XML, you should try `Grok
-<http://grok.zope.org>`_, which adds a layer on top of ZTK, replacing
-declarative configuration with conventions and declarations in
-Python.
 
 In the above example, instead of using
 ``zope.site.interfaces.IRootFolder`` interface, we used ``*``.  So,
-this view will be available for all content objects.
+this view will be available for all objects.
 
 Restart your application, then visit the following URL:
 http://127.0.0.1:8080/@@hello2

Modified: bluebream/trunk/docs/source/introduction.rst
===================================================================
--- bluebream/trunk/docs/source/introduction.rst	2010-01-14 16:50:47 UTC (rev 108123)
+++ bluebream/trunk/docs/source/introduction.rst	2010-01-14 16:52:35 UTC (rev 108124)
@@ -37,7 +37,10 @@
 - BlueBream has transactional object database (ZODB)
 
 - BlueBream has an XML based configuration language for registering
-  components (ZCML)
+  components (ZCML).  If you feel extremely uncomfortable with XML,
+  you should try `Grok <http://grok.zope.org>`_, which adds a layer
+  on top of ZTK, replacing declarative configuration with conventions
+  and declarations in Python.
 
 - BlueBream has flexible security architecture with pluggable
   security policies (zope.security)

Modified: bluebream/trunk/docs/source/tutorial.rst
===================================================================
--- bluebream/trunk/docs/source/tutorial.rst	2010-01-14 16:50:47 UTC (rev 108123)
+++ bluebream/trunk/docs/source/tutorial.rst	2010-01-14 16:52:35 UTC (rev 108124)
@@ -270,6 +270,54 @@
 
 - ``log`` -- All log files goes here.
 
+Let's look at the main ``[buildout]`` part details now::
+
+  [buildout]
+  develop = .
+  extends = versions.cfg
+  parts = app
+          zope_conf
+          test 
+
+The second option ``develop`` says to buildout that, the current
+directory is a Python distribution source, i.e., there is a
+``setup.py`` file.  Buildout will inspect the ``setup.py`` and add
+create develop egg link inside ``develop-eggs`` directory.  The link
+file should contain path to location where the Python package is
+residing.  So, buildout will make sure that the packages is always
+importable.  The value of ``develop`` option could be a relative
+path, as given above or absolute path to some directory.  You can
+also add multiple lines to ``develop`` option with different paths.
+
+The ``extends`` option says buildout to include the full content of
+``versions.cfg`` file as part the configuration.  The
+``versions.cfg`` is another Buildout configuration file which
+contains the release numbers of different dependencies.  You can add
+multiple lines to ``extends`` option to include multiple
+configuration files.
+
+The ``parts`` option list all the parts to be built by Buildout.
+Buildout expects a recipe for each parts listed here.  So, you cannot
+include ``config`` part here as it doesn't have any recipe.
+
+Now let's look at the ``app`` part::
+
+  [app]
+  recipe = zc.recipe.egg
+  eggs = ticketcollector
+         z3c.evalexception>=2.0
+         Paste
+         PasteScript
+         PasteDeploy
+  interpreter = breampy
+
+This part takes care of all the eggs required for the application to
+function.  Majority of the dependencies will come as part of the main
+appliation egg.  The option ``eggs`` list all the eggs.  The first
+egg, ``ticketcollector`` is the main locally developing egg.
+
+.. FIXME: need to add ``[zope_conf]`` and ``[test]`` parts here.
+
 Now you can the ``bin/buildout`` command.  This will take some time
 to download packages from PyPI.  When you run buildout, it will show
 something like this::
@@ -294,6 +342,10 @@
 
 - The ``test`` command can be used to run the test runner.
 
+Now we have a project source where we can continue developing this
+application.  Now onwards, you need to do the remaining things
+manually.
+
 .. _tut-app-object:
 
 Creating the application object



More information about the checkins mailing list