"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "docs/users_guide/libraries.rst" between
cheetah3-3.1.0.tar.gz and cheetah3-3.2.0.tar.gz

About: Cheetah3 is a template engine and code generation tool for e.g. for Web development or Java, SQL, LaTeX, form email ... (written in Python).

libraries.rst  (cheetah3-3.1.0):libraries.rst  (cheetah3-3.2.0)
Batteries included: templates and other libraries Batteries included: templates and other libraries
================================================= =================================================
(libraries)
Cheetah comes "batteries included" with libraries of templates, Cheetah comes "batteries included" with libraries of templates,
functions, classes and other objects you can use in your own functions, classes and other objects you can use in your own
programs. The different types are listed alphabetically below, programs. The different types are listed alphabetically below,
followed by a longer description of the SkeletonPage framework. followed by a longer description of the SkeletonPage framework.
Some of the objects are classes for specific purposes (e.g., Some of the objects are classes for specific purposes (e.g.,
filters or error catchers), while others are standalone and can be filters or error catchers), while others are standalone and can be
used without Cheetah. used without Cheetah.
If you develop any objects which are generally useful for Cheetah If you develop any objects which are generally useful for Cheetah
sites, please consider posting them on the wiki with an sites, please consider posting them on the wiki with an
announcement on the mailing list so we can incorporate them into announcement on the mailing list so we can incorporate them into
the standard library. That way, all Cheetah users will benefit, and the standard library. That way, all Cheetah users will benefit, and
it will encourage others to contribute their objects, which might it will encourage others to contribute their objects, which might
include something you want. include something you want.
ErrorCatchers ErrorCatchers
------------- -------------
(libraries.ErrorCatchers)
Module {Cheetah.ErrorCatchers} contains error-handling classes Module {Cheetah.ErrorCatchers} contains error-handling classes
suitable for the {#errorCatcher} directive. These are debugging suitable for the {#errorCatcher} directive. These are debugging
tools that are not intended for use in production systems. See tools that are not intended for use in production systems. See
section errorHandling.errorCatcher for a description of the error section errorHandling.errorCatcher for a description of the error
catchers bundled with Cheetah. catchers bundled with Cheetah.
FileUtils FileUtils
--------- ---------
(libraries.FileUtils)
Module {Cheetah.FileUtils} contains generic functions and classes Module {Cheetah.FileUtils} contains generic functions and classes
for doing bulk search-and-replace on several files, and for finding for doing bulk search-and-replace on several files, and for finding
all the files in a directory hierarchy whose names match a glob all the files in a directory hierarchy whose names match a glob
pattern. pattern.
Filters Filters
------- -------
(libraries.Filters)
Module {Filters} contains filters suitable for the {#Filter} Module {Filters} contains filters suitable for the {#Filter}
directive. See section output.filter for a description of the directive. See section output.filter for a description of the
filters bundled with Cheetah. filters bundled with Cheetah.
SettingsManager SettingsManager
--------------- ---------------
(libraries.SettingsManager)
The {SettingsManager} class in the {Cheetah.SettingsManager} module The {SettingsManager} class in the {Cheetah.SettingsManager} module
is a baseclass that provides facilities for managing application is a baseclass that provides facilities for managing application
settings. It facilitates the use of user-supplied configuration settings. It facilitates the use of user-supplied configuration
files to fine tune an application. A setting is a key/value pair files to fine tune an application. A setting is a key/value pair
that an application or component (e.g., a filter, or your own that an application or component (e.g., a filter, or your own
servlets) looks up and treats as a configuration value to modify servlets) looks up and treats as a configuration value to modify
its (the component's) behaviour. its (the component's) behaviour.
SettingsManager is designed to: SettingsManager is designed to:
skipping to change at line 93 skipping to change at line 83
module module
Cheetah uses {SettingsManager} to manage its configuration Cheetah uses {SettingsManager} to manage its configuration
settings. {SettingsManager} might also be useful in your own settings. {SettingsManager} might also be useful in your own
applications. See the source code and docstrings in the file applications. See the source code and docstrings in the file
{src/SettingsManager.py} for more information. {src/SettingsManager.py} for more information.
Templates Templates
--------- ---------
(libraries.templates)
Package {Cheetah.Templates} contains stock templates that you can Package {Cheetah.Templates} contains stock templates that you can
either use as is, or extend by using the {#def} directive to either use as is, or extend by using the {#def} directive to
redefine specific { blocks}. Currently, the only template in here redefine specific { blocks}. Currently, the only template in here
is SkeletonPage, which is described in detail below in section is SkeletonPage, which is described in detail below in section
libraries.templates.skeletonPage. (Contributed by Tavis Rudd.) libraries.templates.skeletonPage. (Contributed by Tavis Rudd.)
Tools Tools
----- -----
(libraries.Tools)
Package {Cheetah.Tools} contains functions and classes contributed Package {Cheetah.Tools} contains functions and classes contributed
by third parties. Some are Cheetah-specific but others are generic by third parties. Some are Cheetah-specific but others are generic
and can be used standalone. None of them are imported by any other and can be used standalone. None of them are imported by any other
Cheetah component; you can delete the Tools/ directory and Cheetah Cheetah component; you can delete the Tools/ directory and Cheetah
will function fine. will function fine.
Some of the items in Tools/ are experimental and have been placed Some of the items in Tools/ are experimental and have been placed
there just to see how useful they will be, and whether they attract there just to see how useful they will be, and whether they attract
enough users to make refining them worthwhile (the tools, not the enough users to make refining them worthwhile (the tools, not the
users :). users :).
skipping to change at line 162 skipping to change at line 148
representing a tree of hyperlinks to every page in the site (or representing a tree of hyperlinks to every page in the site (or
section, or application...), and also a string containing the section, or application...), and also a string containing the
current URL. Two methods 'menuList' and 'crumbs' return current URL. Two methods 'menuList' and 'crumbs' return
output-ready HTML showing an indented menu (hierarchy tree) or output-ready HTML showing an indented menu (hierarchy tree) or
crumbs list (Yahoo-style bar: home > grandparent > parent > crumbs list (Yahoo-style bar: home > grandparent > parent >
currentURL). Contributed by Ian Bicking. currentURL). Contributed by Ian Bicking.
Utils Utils
----- -----
(libraries.Utils)
Package {Cheetah.Utils} contains non-Cheetah-specific functions and Package {Cheetah.Utils} contains non-Cheetah-specific functions and
classes that are imported by other Cheetah components. Many of classes that are imported by other Cheetah components. Many of
these utils can be used standalone in other applications too. these utils can be used standalone in other applications too.
Current Utils include: Current Utils include:
This is inherited by {Template} objects, and provides the method, This is inherited by {Template} objects, and provides the method,
{.cgiImport} method (section webware.cgiImport). {.cgiImport} method (section webware.cgiImport).
A catch-all module for small functions. A catch-all module for small functions.
skipping to change at line 197 skipping to change at line 181
If you want this feature, read the docstring in the source and let If you want this feature, read the docstring in the source and let
us know on the mailing list what you'd like this method to do. us know on the mailing list what you'd like this method to do.
Contributed by Mike Orr. Contributed by Mike Orr.
Functions to verify the type of a user-supplied function argument. Functions to verify the type of a user-supplied function argument.
Contributed by Mike Orr. Contributed by Mike Orr.
Cheetah.Templates.SkeletonPage Cheetah.Templates.SkeletonPage
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
(libraries.templates.skeletonPage)
A stock template class that may be useful for web developers is A stock template class that may be useful for web developers is
defined in the {Cheetah.Templates.SkeletonPage} module. The defined in the {Cheetah.Templates.SkeletonPage} module. The
{SkeletonPage} template class is generated from the following {SkeletonPage} template class is generated from the following
Cheetah source code: Cheetah source code:
:: ::
##doc-module: A Skeleton HTML page template, that provides basic structure a nd utility methods. ##doc-module: A Skeleton HTML page template, that provides basic structure a nd utility methods.
############################################################################ #### ############################################################################ ####
#extends Cheetah.Templates._SkeletonPage #extends Cheetah.Templates._SkeletonPage
 End of changes. 9 change blocks. 
18 lines changed or deleted 0 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)