[Checkins] SVN: bluebream/website/docs/v1.0/introduction.rst re-align (max line length: 76)
Baiju M
baiju.m.mail at gmail.com
Wed Aug 11 02:42:18 EDT 2010
Log message for revision 115624:
re-align (max line length: 76)
Changed:
U bluebream/website/docs/v1.0/introduction.rst
-=-
Modified: bluebream/website/docs/v1.0/introduction.rst
===================================================================
--- bluebream/website/docs/v1.0/introduction.rst 2010-08-11 06:36:12 UTC (rev 115623)
+++ bluebream/website/docs/v1.0/introduction.rst 2010-08-11 06:42:17 UTC (rev 115624)
@@ -8,46 +8,44 @@
Overview
--------
-:term:`BlueBream` -- formerly known as :term:`Zope 3` -- is a web
-framework written in the Python programming language.
+:term:`BlueBream` -- formerly known as :term:`Zope 3` -- is a web framework
+written in the Python programming language.
A few features distinguish BlueBream from other Python web frameworks.
-- BlueBream is built on top of the :term:`Zope Tool Kit` (ZTK), which
- has many years of experience proving it meets the demanding
- requirements for stable, scalable software.
+- BlueBream is built on top of the :term:`Zope Tool Kit` (ZTK), which has
+ many years of experience proving it meets the demanding requirements for
+ stable, scalable software.
-- BlueBream uses the powerful and familiar :term:`Buildout` system
- written in Python.
+- BlueBream uses the powerful and familiar :term:`Buildout` system written
+ in Python.
-- BlueBream employs the Zope Object Database (:term:`ZODB`), a
- transactional object database providing extremely powerful and easy
- to use persistence.
+- BlueBream employs the Zope Object Database (:term:`ZODB`), a transactional
+ object database providing extremely powerful and easy to use persistence.
- BlueBream registers components with Zope Component Markup Language
- (:term:`ZCML`), an XML based configuration language, providing
- limitless flexibility.
+ (:term:`ZCML`), an XML based configuration language, providing limitless
+ flexibility.
-- BlueBream can also register components using :term:`GROK`, which
- adds a layer replacing the declarative configuration of ZCML with
- conventions and declarations in standard Python.
+- BlueBream can also register components using :term:`GROK`, which adds a
+ layer replacing the declarative configuration of ZCML with conventions and
+ declarations in standard Python.
-- BlueBream features the :term:`Zope Component Architecture` (ZCA)
- which implements :term:`Separation of concerns` to create highly
- cohesive reusable components (zope.component_).
+- BlueBream features the :term:`Zope Component Architecture` (ZCA) which
+ implements :term:`Separation of concerns` to create highly cohesive
+ reusable components (zope.component_).
-- BlueBream implements Python Web Server Gateway Interface
- :term:`WSGI` using :term:`Paste`, :term:`PasteScript`, and
- :term:`PasteDeploy`.
+- BlueBream implements Python Web Server Gateway Interface :term:`WSGI`
+ using :term:`Paste`, :term:`PasteScript`, and :term:`PasteDeploy`.
-- BlueBream includes a number of well tested components to implement
- common activities. A few are of these are:
+- BlueBream includes a number of well tested components to implement common
+ activities. A few are of these are:
- zope.publisher_ publishes Python objects on the web, emphasizing
:term:`WSGI` compatibility
- - zope.security_ provides a generic mechanism for pluggable
- security policies
+ - zope.security_ provides a generic mechanism for pluggable security
+ policies
- zope.testing_ and zope.testbrowser_ offer unit and functional testing
frameworks
@@ -60,8 +58,8 @@
- zope.formlib_ is a tool for automatically generating forms
BlueBream is free/open source software, owned by the :term:`Zope
-Foundation`. Bluebream is licensed under the :term:`Zope Public
-License` (BSD like, GPL compatible license).
+Foundation`. Bluebream is licensed under the :term:`Zope Public License`
+(BSD like, GPL compatible license).
.. _zope.component: http://pypi.python.org/pypi/zope.component
.. _zope.publisher: http://pypi.python.org/pypi/zope.publisher
@@ -97,25 +95,24 @@
- PyPI Page: http://pypi.python.org/pypi/bluebream
-The BlueBream developer community is an active community involved in
-the development of BlueBream itself and is looking for contributors.
+The BlueBream developer community is an active community involved in the
+development of BlueBream itself and is looking for contributors.
Development related information is documented in the `wiki
-<http://wiki.zope.org/bluebream>`_:
-http://wiki.zope.org/bluebream/ContributingToBlueBream
+<http://wiki.zope.org/bluebream/ContributingToBlueBream>`_.
-We aim to provide high quality, free online documentation for
-BlueBream. If you would like to contribute, the RestructuredText
-source for this website is available from the zope.org repository
-(please replace ``USERNAME`` with your zope.org username.)::
+We aim to provide high quality, free online documentation for BlueBream. If
+you would like to contribute, the `RestructuredText
+<http://docutils.sourceforge.net/rst.html>`_ source for this website is
+available from the zope.org repository (please replace ``USERNAME`` with
+your zope.org username.)::
svn co svn+ssh://USERNAME@svn.zope.org/repos/main/bluebream/website
-If you don't have svn commit access, please consult: `becoming a
-contributor
-<http://docs.zope.org/developer/becoming-a-contributor.html>`_
-document. If you have any questions, please contact us in mailing
-list or irc chat. We are happy to assist you with submitting the
-contributor agreement form required to become a *committer*.
+If you don't have svn commit access, please consult: `becoming a contributor
+<http://docs.zope.org/developer/becoming-a-contributor.html>`_ document. If
+you have any questions, please contact us in mailing list or irc chat. We
+are happy to assist you with submitting the contributor agreement form
+required to become a *committer*.
.. _intro-history:
@@ -124,49 +121,47 @@
.. FIXME: we need to improve the history
-Our story begins in 1996. :term:`Jim Fulton` was technical director
-at digital creations. At the International Python Conference (IPC)
-that year, Jim gave a presentation on :term:`CGI`: `Python and
-Internet Programming`_. Jim, considering CGI less than elegant,
-envisioned a better way to program for the internet in Python.
-According to legend, Jim learned CGI on the plane to the conference,
-and designed :term:`Bobo` on the plane ride back home.
+Our story begins in 1996. :term:`Jim Fulton` was technical director at
+digital creations. At the International Python Conference (IPC) that year,
+Jim gave a presentation on :term:`CGI`: `Python and Internet Programming`_.
+Jim, considering CGI less than elegant, envisioned a better way to program
+for the internet in Python. According to legend, Jim learned CGI on the
+plane to the conference, and designed :term:`Bobo` on the plane ride back
+home.
-Digital Creations then released three open-source Python software
-packages: Bobo, Document Template, and Bobopos. These packages -- a
-web publisher, a text template, and an object database -- were the
-core of *Principia*, a commercial application server. In November of
-1998, investor Hadar Pedhazur convinced Digital Creations to open
-source Principia. These packages evolved into the core components of
-Zope 2 and Digital Creations became Zope Corporation.
+Digital Creations then released three open-source Python software packages:
+Bobo, Document Template, and Bobopos. These packages -- a web publisher, a
+text template, and an object database -- were the core of *Principia*, a
+commercial application server. In November of 1998, investor Hadar Pedhazur
+convinced Digital Creations to open source Principia. These packages
+evolved into the core components of Zope 2 and Digital Creations became Zope
+Corporation.
-Since those days Zope has been under active development. It has
-evolved in several ways as the community gained experience,
-continually seeking the optimum balance between power and ease of
-use. Zope 2 emphasized rapid development, the :term:`Zope Component
-Architecture`, which is the core of Zope 3, emphasized modularity and
-configurability which proved very successful in "enterprise"
-applications requiring flexibility and scalability.
+Since those days Zope has been under active development. It has evolved in
+several ways as the community gained experience, continually seeking the
+optimum balance between power and ease of use. Zope 2 emphasized rapid
+development, the :term:`Zope Component Architecture`, which is the core of
+Zope 3, emphasized modularity and configurability which proved very
+successful in "enterprise" applications requiring flexibility and
+scalability.
-Zope 3 is now known as BlueBream. The name stems from the
-coincidence that the Z Object Publishing Environment when spelled
-`zope` is the name of a species of fish. `Blue bream`_ is another
-name for the same species.
+Zope 3 is now known as BlueBream. The name stems from the coincidence that
+the Z Object Publishing Environment when spelled `zope` is the name of a
+species of fish. `Blue bream`_ is another name for the same species.
-BlueBream combines the ZCA, Buildout into a well defined, and
-documented, that makes building powerhouse applications fun.
+BlueBream combines the ZCA, Buildout into a well defined, and documented,
+that makes building powerhouse applications fun.
-The components which comprise BlueBream are under continual
-development by an international team of experienced coders.
+The components which comprise BlueBream are under continual development by
+an international team of experienced coders.
The longer learning curve for deploying Zope 3 is overkill for some
-situations which would otherwise stand to benefit from the distilled
-wisdom of the ZCA. The Zope community has responded to this in with
-several rapidly deployable ZCA-derived frameworks, which implement
-Convention over configuration while maintaining the power of ZCA under
-the hood. Notable among these are Grok and Repoze. Take a look at
-the recent uploads to the PyPi site, it is rare to not see several zca
-projects listed.
+situations which would otherwise stand to benefit from the distilled wisdom
+of the ZCA. The Zope community has responded to this in with several
+rapidly deployable ZCA-derived frameworks, which implement Convention over
+configuration while maintaining the power of ZCA under the hood. Notable
+among these are Grok and Repoze. Take a look at the recent uploads to the
+PyPi site, it is rare to not see several zca projects listed.
.. _Convention over configuration: http://en.wikipedia.org/wiki/Convention_over_configuration
@@ -183,33 +178,31 @@
----------------------
The original intent of Zope 3 was to become a replacement for Zope 2,
-however this did not happen as planned. Instead Zope 2 continued to
-make up the majority of new Zope deployments, mostly due to the
-popularity of Plone.
+however this did not happen as planned. Instead Zope 2 continued to make up
+the majority of new Zope deployments, mostly due to the popularity of Plone.
Zope 3 was conceived as a fresh start to leave certain aspects and
limitations of its presumed predecessor `Zope 2
-<http://docs.zope.org/zope2/zope2book/>`_ behind. Zope 3 introduced
-a new component architecture to address some of the
-inheritance-based-programming limitations of Zope 2.
+<http://docs.zope.org/zope2/zope2book/>`_ behind. Zope 3 introduced a new
+component architecture to address some of the inheritance-based-programming
+limitations of Zope 2.
-The `ZCA <http://www.muthukadan.net/docs/zca.html>`_ notionally
-includes the packages named ``zope.component``, ``zope.interface``
-and ``zope.configuration``. Zope 3 added to this a large number of
-extra libraries and provided an application server that enabled
-programmers to develop standalone web applications.
+The `ZCA <http://www.muthukadan.net/docs/zca.html>`_ notionally includes the
+packages named ``zope.component``, ``zope.interface`` and
+``zope.configuration``. Zope 3 added to this a large number of extra
+libraries and provided an application server that enabled programmers to
+develop standalone web applications.
-In the meantime another wave of web frameworks appeared.
-:term:`Grok` evolved with many Zope 3 libraries at its core.
-`repoze.bfg (aka BFG) <http://bfg.repoze.org>`_ evolved around the
-ZCA. Additionally Zope 2 began to make use of the ZCA and various
-other Zope 3 packages.
+In the meantime another wave of web frameworks appeared. :term:`Grok`
+evolved with many Zope 3 libraries at its core. `repoze.bfg (aka BFG)
+<http://bfg.repoze.org>`_ evolved around the ZCA. Additionally Zope 2 began
+to make use of the ZCA and various other Zope 3 packages.
-In 2009 a group of Zope developers agreed to concentrate primarily on
-the development of the Zope 3 libraries and formed the Zope Toolkit
-(ZTK) that focused on a slim library subset of the Zope 3 project,
-which can then be efficiently utilized by web application frameworks
-on top. This development led to the following logical steps:
+In 2009 a group of Zope developers agreed to concentrate primarily on the
+development of the Zope 3 libraries and formed the Zope Toolkit (ZTK) that
+focused on a slim library subset of the Zope 3 project, which can then be
+efficiently utilized by web application frameworks on top. This development
+led to the following logical steps:
- Form a project around the remaining web application part of Zope 3
@@ -217,8 +210,8 @@
- Create an upgrade path from the former Zope 3 application server
-BlueBream can thus be seen as the successor of Zope 3 web application
-server that like Grok relies on the ZTK.
+BlueBream can thus be seen as the successor of Zope 3 web application server
+that like Grok relies on the ZTK.
.. _intro-organization-doc:
@@ -231,29 +224,27 @@
Getting Started
~~~~~~~~~~~~~~~
-The :ref:`started-getting` chapter narrate the process of creating a
-new web application project using BlueBream. It also gives a few
-exercises to demonstrate the basic concepts of BlueBream.
+The :ref:`started-getting` chapter narrate the process of creating a new web
+application project using BlueBream. It also gives a few exercises to
+demonstrate the basic concepts of BlueBream.
Concepts
~~~~~~~~
-This chapter discuss important concepts and technologies used in
-BlueBream.
+This chapter discuss important concepts and technologies used in BlueBream.
Tutorial --- Part 1
~~~~~~~~~~~~~~~~~~~
This chapter presents a tutorial exercise demonstrating how to build a
-simple ticket collector application using BlueBream. Part 1
-introduces basic BlueBream concepts.
+simple ticket collector application using BlueBream. Part 1 introduces
+basic BlueBream concepts.
Tutorial --- Part 2
~~~~~~~~~~~~~~~~~~~
-This chapter is a continuation of the ticket collector application
-tutorial excercises, providing more detail regarding forms and
-schemas.
+This chapter is a continuation of the ticket collector application tutorial
+excercises, providing more detail regarding forms and schemas.
Manual
~~~~~~
@@ -274,9 +265,9 @@
Core Development
~~~~~~~~~~~~~~~~
-This chapter contains explanations written for the core development
-team. Developers should always consult the latest documentation site
-for changes to the documentation in this section.
+This chapter contains explanations written for the core development team.
+Developers should always consult the latest documentation site for changes
+to the documentation in this section.
Reference
~~~~~~~~~
@@ -288,13 +279,12 @@
Thanks
------
-BlueBream truly stands on the shoulders of giants. Zope 3 was built
-on the concepts of Zope 2 which was built on Bobo and friends. The
-list of Zope Corporation alumni is a *Who's Who* of Python
-development, including one *Guido Van Rossum*. For more than 10 years
-contributions have come from a world-wide community. We thank you
-all. Please help us add more names to the list of contributor as we
-move forward from January 2010.
+BlueBream truly stands on the shoulders of giants. Zope 3 was built on the
+concepts of Zope 2 which was built on Bobo and friends. The list of Zope
+Corporation alumni is a *Who's Who* of Python development, including one
+*Guido Van Rossum*. For more than 10 years contributions have come from a
+world-wide community. We thank you all. Please help us add more names to
+the list of contributor as we move forward from January 2010.
.. _intro-translations:
@@ -309,7 +299,6 @@
<div id="disqus_thread"></div><script type="text/javascript"
src="http://disqus.com/forums/bluebream/embed.js"></script><noscript><a
- href="http://disqus.com/forums/bluebream/?url=ref">View the
- discussion thread.</a></noscript><a href="http://disqus.com"
- class="dsq-brlink">blog comments powered by <span
- class="logo-disqus">Disqus</span></a>
+ href="http://disqus.com/forums/bluebream/?url=ref">View the discussion
+ thread.</a></noscript><a href="http://disqus.com" class="dsq-brlink">blog
+ comments powered by <span class="logo-disqus">Disqus</span></a>
More information about the checkins
mailing list