[Checkins] SVN: bluebream/trunk/docs/source/ cross-reference (still more to do)

Baiju M baiju.m.mail at gmail.com
Tue Jan 12 21:49:45 EST 2010


Log message for revision 108090:
  cross-reference (still more to do)
  

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

-=-
Modified: bluebream/trunk/docs/source/gettingstarted.rst
===================================================================
--- bluebream/trunk/docs/source/gettingstarted.rst	2010-01-13 00:10:34 UTC (rev 108089)
+++ bluebream/trunk/docs/source/gettingstarted.rst	2010-01-13 02:49:44 UTC (rev 108090)
@@ -1,6 +1,10 @@
+.. _started-getting:
+
 Getting Started
 ===============
 
+.. _started-intro:
+
 Introduction
 ------------
 
@@ -29,6 +33,8 @@
 
 At the end, few hello world examples are also given.
 
+.. _started-preparations:
+
 Preparations
 ------------
 
@@ -54,6 +60,8 @@
 Internet is required for bootstrapping the Buildout and building the
 application.
 
+.. _started-installation:
+
 Installation
 ------------
 
@@ -81,11 +89,13 @@
 - `PasteDeploy <http://pypi.python.org/pypi/PasteDeploy>`_
 - `Paste <http://pypi.python.org/pypi/Paste>`_
 
+.. _started-sample-project:
+
 Creating a sample project
 -------------------------
 
 The ``bluebream`` package provides a template based project creation
-script based on `PasteScript
+based on `PasteScript template
 <http://pythonpaste.org/script/developer.html>`_.  Once BlueBream is
 installed, run ``paster`` command to create the project directory
 structure.  The ``create`` sub-command provided by ``paster`` will
@@ -136,6 +146,8 @@
 change the values later.  But it would be a good idea, if you provide
 good name for your project.
 
+.. _started-building:
+
 Building the application
 ------------------------
 
@@ -149,6 +161,8 @@
 
   $ ./bin/buildout
 
+.. _started-basic-usage:
+
 Basic usage
 -----------
 
@@ -162,6 +176,8 @@
 
 The server can be accessed at http://localhost:8080/ now.
 
+.. _started-directory-structure:
+
 Package directory structure
 ---------------------------
 
@@ -277,6 +293,8 @@
 The next few sections will explain how to create hello world
 applications.
 
+.. _started-example-1:
+
 Example 1: Hello World without page template
 --------------------------------------------
 
@@ -343,6 +361,8 @@
    has no element named ``bar`` - it only serves to disambiguate
    between views of an object and things contained within the object.
 
+.. _started-example-2:
+
 Example 2: Hello World with page template
 -----------------------------------------
 
@@ -395,6 +415,8 @@
 Restart your application, then visit the following URL:
 http://127.0.0.1:8080/@@hello2
 
+.. _started-example-3:
+
 Example 3: A dynamic hello world
 --------------------------------
 
@@ -481,6 +503,8 @@
 
   Hello World !
 
+.. _started-conclusion:
+
 Conclusion
 ----------
 

Modified: bluebream/trunk/docs/source/introduction.rst
===================================================================
--- bluebream/trunk/docs/source/introduction.rst	2010-01-13 00:10:34 UTC (rev 108089)
+++ bluebream/trunk/docs/source/introduction.rst	2010-01-13 02:49:44 UTC (rev 108090)
@@ -1,6 +1,10 @@
+.. _intro-intro:
+
 Introduction
 ============
 
+.. _intro-overview:
+
 Overview
 --------
 
@@ -50,10 +54,12 @@
 using BlueBream components. You suggestions and edits are always
 welcome.
 
+.. _intro-history:
+
 Brief History
 -------------
 
-.. FIXME: we can improve the history
+.. FIXME: we need to improve the history
 
 The beginning of Zope's story goes something like this, in 1996, Jim
 Fulton (CTO of Zope Corporation) was drafted to teach a class on
@@ -90,6 +96,8 @@
 
 Very recently Zope 3 project is renamed to BlueBream.
 
+.. _intro-organization:
+
 Organization of the book
 ------------------------
 
@@ -99,16 +107,17 @@
 Introduction
 ~~~~~~~~~~~~
 
-This chapter introduce BlueBream with an overview and brief history.
-Then walks through the organization of the book.  Finally, finish
-with a thanks section.
+This chapter introduce BlueBream with an :ref:`intro-overview` and
+:ref:`intro-history`.  Then walks through the
+:ref:`intro-organization`.  Finally, ends with :ref:`intro-thanks`
+section.
 
 Getting Started
 ~~~~~~~~~~~~~~~
 
-This chapter narrate the process of creating a new web application
-project using BlueBream.  Also it gives few excercises to familiarize
-the basic concepts in BlueBream.
+The :ref:`started-getting` chapter narrate the process of creating a
+new web application project using BlueBream.  Also it gives few
+excercises to familiarize the basic concepts in BlueBream.
 
 Tutorial
 ~~~~~~~~
@@ -133,6 +142,8 @@
 
 A complete reference to BlueBream.
 
+.. _intro-thanks:
+
 Thanks
 ------
 



More information about the checkins mailing list