[Checkins] SVN: zope3book/trunk/source/ Added few indices
Baiju M
baiju.m.mail at gmail.com
Mon Feb 23 09:09:55 EST 2009
Log message for revision 97166:
Added few indices
Changed:
U zope3book/trunk/source/browser-pages.rst
U zope3book/trunk/source/browser-resouces.rst
U zope3book/trunk/source/component-architecture.rst
U zope3book/trunk/source/content-components.rst
U zope3book/trunk/source/development-tools.rst
U zope3book/trunk/source/getting-started.rst
U zope3book/trunk/source/interfaces.rst
U zope3book/trunk/source/introduction.rst
U zope3book/trunk/source/testing.rst
U zope3book/trunk/source/virtual-hosting.rst
-=-
Modified: zope3book/trunk/source/browser-pages.rst
===================================================================
--- zope3book/trunk/source/browser-pages.rst 2009-02-23 13:58:39 UTC (rev 97165)
+++ zope3book/trunk/source/browser-pages.rst 2009-02-23 14:09:54 UTC (rev 97166)
@@ -1,6 +1,9 @@
Browser Pages
=============
+.. index:: browser page
+.. index:: browser view
+.. index:: view component; component
Introduction
------------
@@ -16,6 +19,8 @@
Hello, World !
+.. index:: registration; browser page
+
Here is how to register a page for `IFolder` interface::
<browser:page
@@ -96,6 +101,11 @@
Template Attribute Language (TAL)
---------------------------------
+.. index:: TAL ; page template
+
+.. index::
+ single: template attribute language ; page template
+
* Attribute-based templating language
* Allows designer to modify templates without having to worry about TAL
* Works only well for XML
@@ -252,6 +262,8 @@
TALES Namespaces
~~~~~~~~~~~~~~~~
+.. index:: TALES ; page template
+
TALES namespaces effectively specify the expression type. The default
is the path TALES namespace. See TALES Specification 1.3
Modified: zope3book/trunk/source/browser-resouces.rst
===================================================================
--- zope3book/trunk/source/browser-resouces.rst 2009-02-23 13:58:39 UTC (rev 97165)
+++ zope3book/trunk/source/browser-resouces.rst 2009-02-23 14:09:54 UTC (rev 97166)
@@ -1,6 +1,7 @@
Browser Resources
=================
+.. index:: browser resource
Introduction
------------
@@ -15,6 +16,9 @@
File Resource
-------------
+.. index::
+ single: file resource; browser resource
+
The first goal is to register a simple plain-text file called
`resource.txt` as a browser resource. The first step is to create
this file anywhere you wish on the filesystem, and adding the
@@ -53,6 +57,9 @@
Image resource
--------------
+.. index::
+ single: image resource; browser resource
+
If you have an image resource, you might want to use different
configuration. Create a simple image called `img.png` and register
it as follows::
@@ -82,6 +89,9 @@
Directory resource
------------------
+.. index::
+ single: directory resource; browser resource
+
If you have many resource files to register, it can be very tedious
to write a single directive for every resource. For this purpose the
`resourceDirectory` is provided, with which you can simply declare an
@@ -110,6 +120,9 @@
ZRT resource
------------
+.. index::
+ single: zrt resource; browser resource
+
While working with CSS and JavaScript resource files, it would be
useful if it works locally as well as with Zope 3. This will help us
to test those files without running application server. Zope
Modified: zope3book/trunk/source/component-architecture.rst
===================================================================
--- zope3book/trunk/source/component-architecture.rst 2009-02-23 13:58:39 UTC (rev 97165)
+++ zope3book/trunk/source/component-architecture.rst 2009-02-23 14:09:54 UTC (rev 97166)
@@ -1,6 +1,9 @@
Component Architecture
======================
+.. index::
+ single: ZCA; component
+
`Zope Component Architecture (ZCA)` is a framework for supporting
component based design and programming. It is very well suited to
developing large Python software systems. The ZCA is not specific to
@@ -65,9 +68,12 @@
$ ./bin/mypython
>>> import zope.component
+
Adapters
--------
+.. index::
+ single: adapter; component
Implementation
~~~~~~~~~~~~~~
@@ -130,6 +136,9 @@
Registration
~~~~~~~~~~~~
+.. index::
+ single: registration; component
+
To use this adapter component, you have to register this in a
component registry also known as site manager. A site manager
normally resides in a site. A site and site manager will be more
@@ -185,6 +194,9 @@
Querying adapter
~~~~~~~~~~~~~~~~
+.. index::
+ single: querying adapter; component
+
Retrieving registered components from component registry is achieved
through two functions available in `zope.component` package. One of
them is `getAdapter` and the other is `queryAdapter`. Both functions
@@ -296,6 +308,9 @@
Utility
-------
+.. index::
+ single: utility; component
+
Now you know the concept of interface, adapter and component registry.
Sometimes it would be useful to register an object which is not
adapting anything. Database connection, XML parser, object returning
@@ -371,6 +386,9 @@
Named utility
~~~~~~~~~~~~~
+.. index::
+ single: named utility; component
+
When registering a utility component, like adapter, you can use a
name. As mentioned in the previous section, a utility registered with
a particular name is called named utility.
@@ -380,6 +398,9 @@
>>> greet = Greeter()
>>> gsm.registerUtility(greet, IGreeter, 'new')
+.. index::
+ single: querying utility; component
+
In this example you registered the utility with a name as providing
the `IGreeter` interface. You can look up the interface with either
`queryUtility` or `getUtility`::
Modified: zope3book/trunk/source/content-components.rst
===================================================================
--- zope3book/trunk/source/content-components.rst 2009-02-23 13:58:39 UTC (rev 97165)
+++ zope3book/trunk/source/content-components.rst 2009-02-23 14:09:54 UTC (rev 97166)
@@ -1,6 +1,7 @@
Content Components
==================
+.. index:: content component; component
Introduction
------------
@@ -542,3 +543,6 @@
Functional testing
------------------
+
+Summary
+-------
Modified: zope3book/trunk/source/development-tools.rst
===================================================================
--- zope3book/trunk/source/development-tools.rst 2009-02-23 13:58:39 UTC (rev 97165)
+++ zope3book/trunk/source/development-tools.rst 2009-02-23 14:09:54 UTC (rev 97166)
@@ -10,6 +10,8 @@
Eggs and setuptools
-------------------
+.. index:: egg, setuptools
+
Eggs_ are Python's new distribution format. We can make Python
packages in Egg format using setuptool package. To install an egg,
you can use easy_install_. An easy way to automate the installtion
@@ -26,6 +28,8 @@
Buildout
--------
+.. index:: buildout
+
The Buildout project provides support for creating applications,
especially Python applications. It provides tools for assembling
applications from multiple parts, Python or otherwise. An
@@ -54,6 +58,9 @@
Buildout recipes
----------------
+.. index::
+ single: recipe; buildout
+
Buildout recipes are distributed in egg formats. Some examples of
recipes are:
Modified: zope3book/trunk/source/getting-started.rst
===================================================================
--- zope3book/trunk/source/getting-started.rst 2009-02-23 13:58:39 UTC (rev 97165)
+++ zope3book/trunk/source/getting-started.rst 2009-02-23 14:09:54 UTC (rev 97166)
@@ -19,6 +19,8 @@
Python installation
-------------------
+.. index:: installation
+
The Zope community has always recommended using a custom built Python
for development and deployment. Both Python 2.4 and 2.5 should work
for Zope 3.4 KGS packages. As of now, the author reccomend using
@@ -71,6 +73,8 @@
Buildout
--------
+.. index:: buildout
+
Introduction
~~~~~~~~~~~~
@@ -143,6 +147,8 @@
Setting up development sandbox
------------------------------
+.. index:: sandbox
+
To demonstrate the concepts, tools and techniques, we are going to
develop a ticket collector application. The application can be used
for issue/bug tracking. To begin the work, first create a directory
@@ -363,6 +369,8 @@
Using ZMI
~~~~~~~~~
+.. index:: ZMI
+
After running your instance, If you open a web browser and go to
`http://localhost:8080 <http://localhost:8080>`_ you'll see the ZMI
(Zope Management Interface ).
Modified: zope3book/trunk/source/interfaces.rst
===================================================================
--- zope3book/trunk/source/interfaces.rst 2009-02-23 13:58:39 UTC (rev 97165)
+++ zope3book/trunk/source/interfaces.rst 2009-02-23 14:09:54 UTC (rev 97166)
@@ -5,6 +5,8 @@
Introduction
------------
+.. index:: interface
+
Interfaces are objects that specify (document) the external behavior
of objects that "provide" them. An interface specifies behavior
through:
@@ -43,6 +45,9 @@
Types of contract
-----------------
+.. index::
+ single: contract; interface
+
:"I can do X": Describing the ability to do something is the classical
definition of an API. Those abilities are defined and implemented as
methods.
@@ -249,6 +254,9 @@
Marker interfaces
-----------------
+.. index::
+ single: marker interface; interfaces
+
An interface can be used to declare that a particular object belongs
to a special type. An interface without any attribute or method is
called marker interface.
@@ -267,6 +275,9 @@
Invariants
----------
+.. index::
+ single: invariant; interfaces
+
Sometimes you will be required to use some rule for your component
which involve one or more normal attributes. These kind of rule is
called `invariants`. You can use `zope.interface.invariant` for
Modified: zope3book/trunk/source/introduction.rst
===================================================================
--- zope3book/trunk/source/introduction.rst 2009-02-23 13:58:39 UTC (rev 97165)
+++ zope3book/trunk/source/introduction.rst 2009-02-23 14:09:54 UTC (rev 97166)
@@ -85,6 +85,8 @@
Brief history
-------------
+.. index:: 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
common gateway interface (CGI) programming, despite not knowing very
Modified: zope3book/trunk/source/testing.rst
===================================================================
--- zope3book/trunk/source/testing.rst 2009-02-23 13:58:39 UTC (rev 97165)
+++ zope3book/trunk/source/testing.rst 2009-02-23 14:09:54 UTC (rev 97166)
@@ -14,6 +14,9 @@
Unit testing
------------
+.. index::
+ single: unit testing; testing
+
Unit test can be written using `unittest`, `zope.unittest`, `nose`,
`py.test` etc. Another approach to write unit test is using doctest.
Doctest-based unit tests are the most used way to write unit tests in
@@ -96,6 +99,9 @@
Running tests
-------------
+.. index::
+ single: running tests; testing
+
The Buildout recipe named `zc.recipe.testrunner` would be convenient
for running test cases. It will create a script to run the test
cases. For a typical project you can add `test` part in
@@ -108,6 +114,9 @@
recipe = zc.recipe.testrunner
eggs = ticketcollector [test]
+.. index::
+ single: test runner; testing
+
Here the package names is assumed as `ticketcollector` (this is the
name you given in `setup.py`). Also here I assume that there is an
`extras_require` argument for `setup` function in `setup.py`.
@@ -117,7 +126,6 @@
'zope.testbrowser',
]),
-
By conventions your test modules are put in `tests` module under each
package. But the doctest files can be placed in the package itself.
For example if the package is `ticketcollector`, then, the main
Modified: zope3book/trunk/source/virtual-hosting.rst
===================================================================
--- zope3book/trunk/source/virtual-hosting.rst 2009-02-23 13:58:39 UTC (rev 97165)
+++ zope3book/trunk/source/virtual-hosting.rst 2009-02-23 14:09:54 UTC (rev 97166)
@@ -1,6 +1,9 @@
Setting Up Virtual Hosting
==========================
+.. index::
+ single: virtual hosting; apache
+
Introduction
------------
More information about the Checkins
mailing list