"""Document the API for navigation classes.
Navigation classes encapsulate reusable bits of site navigation. They are used
by layout classes. For instance, if there is a row of buttons along the top
of every page, the buttons would be stored in a navigation class, and the
layout class would make use of that navigation class. This is all very
natural if you're accustomed to server side includes. Navigation classes have
a ``__call__`` method that returns a string. I.e. they are usually Cheetah
templates that subclass aquarium.util.AquariumTemplate_. Naturally, the layout
class may pass additional arguments to the navigation class's ``__call__``
method if the method is expecting them.
Why use navigation classes? It is possible to just leave all of the navigation
in the layout classes. However, doing so results in large, unreadable,
unmaintainable layout classes. Furthermore, it makes it impossible to reuse
the navigation in subsequent layouts. Hence, use layout classes for layout
and navigation classes for navigation.
The following methods are required:
``__call__(self)``
Return the navigation in a string.
.. _aquarium.util.AquariumTemplate:
aquarium.util.AquariumTemplate.AquariumTemplate-class.html
"""
__docformat__ = "restructuredtext"
# Created: Mon Apr 2 15:59:29 PDT 2001
# Author: Shannon -jj Behrens
# Email: jjinux@users.sourceforge.net
#
# Copyright (c) Shannon -jj Behrens. All rights reserved.
|