[Checkins] SVN: bluebream/trunk/docs/source/gettingstarted.rst a note about @@

[Baiju M]

Log message for revision 108004:
  a note about @@
  

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

-=-
Modified: bluebream/trunk/docs/source/gettingstarted.rst
===================================================================
--- bluebream/trunk/docs/source/gettingstarted.rst	2010-01-11 07:48:17 UTC (rev 108003)
+++ bluebream/trunk/docs/source/gettingstarted.rst	2010-01-11 08:35:28 UTC (rev 108004)
@@ -73,6 +73,14 @@
 
  $ set http_proxy="http://username:password@PROXY-IP-ADDRESS:PORT"
 
+Apart from ``bluebream`` distribution, easy_install will download and
+install its dependencies.  The dependencies are:
+
+- `Sphinx-PyPI-upload <http://pypi.python.org/pypi/Sphinx-PyPI-upload>`_
+- `PasteScript <http://pypi.python.org/pypi/PasteScript>`_
+- `PasteDeploy <http://pypi.python.org/pypi/PasteDeploy>`_
+- `Paste <http://pypi.python.org/pypi/Paste>`_
+
 Creating a sample project
 -------------------------
 
@@ -157,8 +165,8 @@
 Package directory structure
 ---------------------------
 
-The default directory structure created by the "bluebream" paster
-template will looks like this::
+The default directory structure created by the ``bluebream`` paster
+project template will look like this::
 
   myproject/
   |-- bootstrap.py
@@ -191,8 +199,8 @@
 The name of toplevel directory will be always what you gave as
 project name in the wizard.  The name of egg also will be same as
 that of package name by default.  But if you want, you can change it
-to something else from "setup.py".  Here are the details about other
-files inside the project.
+to something else from ``setup.py``.  Here are the details about
+other files inside the project.
 
 +-------------------------------------------+--------------------------------------------------+
 | Directories & Files                       | Purpose                                          |
@@ -268,9 +276,10 @@
 Hello World
 -----------
 
-To create a page which displays "Hello World", you need to create a
-view and then register it using ``browser:page`` ZCML directive.  Add
-a Python file named ``myhello.py`` at
+To create a page which displays ``Hello World!``, you need to create
+a view and then register it using ``browser:page`` ZCML directive.
+
+First you need to create a Python file named ``myhello.py`` at
 ``src/mynamespace/main/myhello.py``::
 
   $ touch src/mynamespace/main/myhello.py
@@ -289,7 +298,7 @@
   class HelloView(BrowserView):
 
       def __call__(self):
-          return "Hello"
+          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
@@ -305,9 +314,23 @@
      class=".myhello.HelloView"
      />
 
-You can add this to: ``src/mynamespace/main/configure.zcml``.
-Run the application and visit: http://localhost:8080/@@hello
+You can add this to: ``src/mynamespace/main/configure.zcml``.  Now
+you can access the view by visiting this URL:
+http://localhost:8080/@@hello
 
+.. note:: The @@ symbol for view
+
+   @@ is a shortcut for ++view++.
+   (Mnemonically, it kinda looks like a pair of goggle-eyes)
+
+   To specify that you want to traverse to a view named "bar" of
+   content object "foo", you could (compactly) say .../foo/@@bar
+   instead of .../foo/++view++bar.
+
+   Note that even the '@@' is not necessary if container "foo" has no
+   element named "bar" - it only serves to disambiguate between views
+   of an object and things contained within the object.
+
 Conclusion
 ----------