Source

WebHelpers / README.txt

WebHelpers
++++++++++++

WebHelpers provides functions useful in web applications: generating HTML tags,
showing results a pageful at a time, etc.  It may be used with any web
framework or template engine.  

The biggest difference between WebHelpers 0.6 and previous versions is the new
HTML tag generator with smart escaping, and the new helpers written to replace
the deprecated ``webhelpers.rails``.  A brief summary of the module layout is
below; see the docstrings in the source for documentation.

``constants``
    Country codes, states and provinces.

``containers``
    High-level container objects and dict/list helpers.

``date``
    Date/time helpers.  These currently format strings based on dates.

``feedgenerator``
    A syndication feed library, used for generating RSS, Atom, etc.
    Ported from Django.

``html``
    A package of HTML-related helpers.

    ``html.builder``
        A library for generating HTML tags with smart escaping.  All
        public symbols are imported into ``webhelpers.html``.

    ``converters``
        Text-to-HTML converters.

    ``tags``
        High-level HTML tags, including form tags, hyperlinks, and 
        Javascript/CSS links.  The ``ModelTags`` class builds input
        tags from database records (for any kind of database).

    ``tools``
        Helpers producing chunks of HTML.

``markdown``
    A text to HTML converter.  Normally invoked via
    ``webhelpers.tools.markdown()``.  (If you use this library directly, you
    may have to wrap the results in ``literal()`` to prevent double escaping.)

``misc``
    Miscellaneous helpers that are neither text, numeric, container, or date.

``number``
    Numeric helpers and number formatters.

``paginate``
    A tool for letting you view a large sequence a screenful at a time,
    with previous/next links.
    
``string24``
    The ``string`` module from Python 2.4.  Useful if you're running on
    Python 2.3.

``tags``
    Helpers producing simple HTML tags.

``text``
    Helpers producing string output, suitable for both HTML and non-HTML
    applications.

``textile``
    Another text to HTML converter.  Normally invoked via
    ``webhelpers.tools.textilize()``.  (If you use this library directly, you
    may have to wrap the results in ``literal()`` to prevent double escaping.)

``tools``
    Helpers producing complex chunks of HTML.

``util``
    Miscellaneous functions.

The following modules/packages are deprecated and will be removed in a future
version of WebHelpers:

``commands``
    Contains a ``distutils`` plugin to compress Javascript/CSS for
    transmission. This version is buggy; the WebHelpers developers are
    investigating alternatives.

``hinclude``
    Client-side include via Javascript. Deprecated because it uses 
    ``webhelpers.rails`` and is trivial.

``htmlgen``
    Older version of ``webhelpers.html``, without smart escaping.

``pagination``
    Older version of ``webhelpers.paginate``.

``rails``
    A large number of functions ported from Rails.  Most of these have been
    reimplemented in other WebHelpers modules to take advantage of
    ``webhelpers.html`` and smart escaping.  (Some of the rails functions are
    prone to double HTML escaping.)  Includes the "Prototype" and
    "Scriptaculous" Javascript libraries, which are unsupported.  This package
    depends on Routes.

WebHelpers is package aimed at providing helper functions for use within web
applications.

These functions are intended to ease web development with template languages by
removing common view logic and encapsulating it in re-usable modules as well as
occasionally providing objects for use within controllers to assist with common
web development paradigms.

For support/question/patches, please use the `Pylons mailing list
<http://groups.google.com/group/pylons-discuss>`_.

Requirements
------------

WebHelpers does not have any install dependencies, but some functions depend
on third-party libraries.

Routes_

    Version >= 1.7 but < 2.0 must be installed and running in the current
    web framework for:

    - webhelpers.html.tags (required only for ``javascript_link()``,
      ``stylesheet_link()``, or ``auto_discovery_link()`` functions).
    - webhelpers.paginate
    - webhelpers.pagination
    - webhelpers.rails
    - the regression tests in the source distribution

    Currently Pylons_, TurboGears_, and Aquarium_ support Routes.
    (WebHelpers is not 

    A future version of WebHelpers will be compatible with Routes 2, which is
    still in development.

Pylons_

    The ``Flash`` class in ``webhelpers.session`` imports ``pylons.session``.
    The class can easily be reimplemented in another web framework.

.. _Routes:  http://routes.groovie.org/
.. _Pylons:  http://pylonshq.com/
.. _TurboGears:  http://turbogears.org/
.. _Aquarium:  http://aquarium.sourceforge.net/
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.