[Checkins] SVN: bluebream/trunk/docs/source/ - Add glossary
Baiju M
baiju.m.mail at gmail.com
Tue Jan 12 07:23:43 EST 2010
Log message for revision 108056:
- Add glossary
- Bit rephrasing in introduction
Changed:
A bluebream/trunk/docs/source/glossary.rst
U bluebream/trunk/docs/source/index.rst
U bluebream/trunk/docs/source/introduction.rst
-=-
Added: bluebream/trunk/docs/source/glossary.rst
===================================================================
--- bluebream/trunk/docs/source/glossary.rst (rev 0)
+++ bluebream/trunk/docs/source/glossary.rst 2010-01-12 12:23:43 UTC (rev 108056)
@@ -0,0 +1,49 @@
+.. _glossary:
+
+Glossary
+========
+
+.. glossary::
+
+ Setuptools
+ Using `Setuptools
+ <http://peak.telecommunity.com/DevCenter/setuptools>`_ developers
+ can distribute Python packages. It creates :term:`Egg`
+ deployment format. Setuptools is built on top of ``distutils``,
+ a built-in Python module. There is a community developed fork of
+ Setuptools called :term:`Distribute`.
+
+ Egg
+ Egg is a deployment format created by :term:`Setuptools`.
+
+ Buildout
+ A Python based `Build system created by Jim Fulton
+ <http://www.buildout.org>`_. Buildout's `PyPI page
+ <http://pypi.python.org/pypi/zc.buildout>`_ has more detailed
+ documentation.
+
+ Zope 2
+ `The Z Object Publishing Framework <http://zope2.zope.org>`_, a
+ Python based web application server.
+
+ Zope
+ A developer community which created many frameworks and Python
+ libraries. The term Zope was originally to refer :term:`Zope 2`.
+
+ Zope Component Architecture
+ `Zope Component Architecture
+ <http://muthukadan.net/docs/zca.html>`_ (ZCA) is a Python
+ framework for supporting component based design and programming
+
+ Distribute
+ A community developed fork of term:`Setuptools` project.
+
+ Zope Tool Kit
+ The `Zope Tool Kit <http://docs.zope.org/zopetoolkit>`_ (ZTK) is
+ a set of libraries intended for reuse by projects to develop web
+ applications or web frameworks.
+
+ Zope Foundation
+ The `Zope Foundation <http://foundation.zope.org>`_ is a
+ not-for-profit organisation that provides support for the Zope
+ community and the Zope platform and its associated software.
Modified: bluebream/trunk/docs/source/index.rst
===================================================================
--- bluebream/trunk/docs/source/index.rst 2010-01-12 11:53:44 UTC (rev 108055)
+++ bluebream/trunk/docs/source/index.rst 2010-01-12 12:23:43 UTC (rev 108056)
@@ -11,6 +11,7 @@
faq
howto/index
reference
+ glossary
Indices and tables
==================
@@ -18,3 +19,4 @@
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
+* :ref:`glossary`
Modified: bluebream/trunk/docs/source/introduction.rst
===================================================================
--- bluebream/trunk/docs/source/introduction.rst 2010-01-12 11:53:44 UTC (rev 108055)
+++ bluebream/trunk/docs/source/introduction.rst 2010-01-12 12:23:43 UTC (rev 108056)
@@ -4,27 +4,47 @@
Overview
--------
-BlueBream is a web framework written in Python programming language.
-BlueBream is a thin layer on top of Zope Tool Kit (ZTK). Normally,
-BlueBream applications are developed using a Python based build
-system called Buildout. BlueBream use the Zope component
-architecture (ZCA) for "separation of concerns" and to create
-reusable components (zope.component). BlueBream has an object
-publisher (zope.publisher), web server (zope.server), transactional
-object database (ZODB), an XML based configuration language for
-registering components (ZCML), flexible security architecture with
-pluggable security policies (zope.security), unit and functional
-testing frameworks (zope.testing, zope.testbrowser), XHTML-compliant
-templating language (zope.pagetemplate), schema engine and automatic
-form generation machinery (zope.schema, z3c.form) and many other
-packages.
-
-Previously BlueBream was known as "Zope 3". The development of this
-project started in 2002. BlueBream is a ZPL (BSD like, GPL
-compatible license) licensed free/open source software. It was
+**BlueBream** is a web framework written in Python programming
+language. BlueBream is a free/open source software, licensed under
+Zope Public License (BSD like, GPL compatible license) owned by
+:term:`Zope Foundation`. BlueBream was known as **Zope 3** in the
+past. The development of BlueBream started in 2002. BlueBream was
developed by the Zope community with the leadership of Jim Fulton. A
-brief history is given in the next section.
+brief history is given in the next section. There are many
+attractive features which make BlueBream unique among Python web
+frameworks.
+- BlueBream is built on top of :term:`Zope Tool Kit` (ZTK). In fact,
+ ZTK is derived from BlueBream.
+
+- BlueBream use and recommend to use :term:`Buildout` -- a build
+ system written in Python.
+
+- BlueBream support WSGI and use Paste (PasteScript & PasteDeploy).
+
+- BlueBream use :term:`Zope Component Architecture` (ZCA) for
+ `separation of concerns` and to create highly cohesive reusable
+ components (zope.component).
+
+- BlueBream has an object publisher (zope.publisher)
+
+- BlueBream has transactional object database (ZODB)
+
+- BlueBream has an XML based configuration language for registering
+ components (ZCML)
+
+- BlueBream has flexible security architecture with pluggable
+ security policies (zope.security)
+
+- BlueBream has unit and functional testing frameworks (zope.testing,
+ zope.testbrowser),
+
+- BlueBream has XHTML-compliant templating language
+ (zope.pagetemplate)
+
+- BlueBream has schema engine and automatic form generation machinery
+ (zope.schema, zope.formlib)
+
The main aim of this book is to create a free online book about
BlueBream. This book will cover how to develop web applications
using BlueBream components. You suggestions and edits are always
More information about the checkins
mailing list