Mike Orr avatar Mike Orr committed 733678d

Add Development doc page; modify other overview pages.

Comments (0)

Files changed (6)

docs/contents.rst

 WebHelpers Documentation
 ========================
 
+All helpers are organized into subpackages.
+
 .. toctree::
    :maxdepth: 1
    
-   modules/__init__
    modules/constants
    modules/containers
    modules/date
    modules/text
    modules/util
 
+Metadata
+++++++++
+
+WebHelpers was originally created as a utility package for Pylons. Many of the
+helpers were ported from Ruby on Rails. Version 0.6 introduced the HTML tag
+builder and deprecated the rails helpers; new subpackages were added to replace
+the rails helpers. Version 1.0 builds on this with many additional helpers.
+
+.. toctree::
+   :maxdepth: 1
+
+   upgrading
+   changes
+   third_party
+   development
+   todo
+
 Non-essential subpackages
 +++++++++++++++++++++++++
 
     modules/textile
 
 
-Metadata
-++++++++
-
-.. toctree::
-   :maxdepth: 1
-
-   upgrading
-   changes
-   todo
-   modules
-   third_party
-
 
 Indices and tables
 ==================

docs/development.rst

+Development
+===========
+
+WebHelpers development is coordinated on the 
+`pylons-discuss <http://groups.google.com/pylons-discuss>`_ list.  Proposals
+for new helpers and offers to help with coding or documentation are always
+welcome.  Please post any bug reports or outlines for new helpers to the
+`bug tracker <http://bitbucket.org/bbangert/webhelpers/issues>`_.
+
+New helpers are considered if they conform to the following criteria:
+
+* Is it useful in a wide variety of applications, especially web applications?
+
+* Does it avoid dependencies outside the Python standard library, especially
+  C extensions which are hard to install on Windows and Macintosh?
+
+* Is it too small to be released as its own project, and is there no other
+  Python project more appropriate for it?
+
+* Does it work on all Python versions from 2.4 to the latest 2.x? 
+  (Python 3 is not yet supported.)
+
+* A small number of Pylons-specific helpers are accepted for the
+  ``webhelpers.pylonslib`` package. These are ones that offer significant
+  advantages over framework-neutral implementations, are too peripheral for the
+  Pylons core, and are too widely useful to exclude. The docstring should
+  explain how to port it to another web framework.

docs/modules.rst

-:mod:`webhelpers` -- WebHelpers module 
-================================================
-
-.. image:: webhelpers-logo.png
-   :width: 100
-   :height: 110
-   :align: left
-
-.. automodule:: webhelpers
-
-Module Contents
----------------
-
-..
-    <tr><th>constants</th><td>Countries &amp; states for address forms
-    </td></tr>
-    <tr><th>containers</th><td>Helpers for collections</td></tr>
-    <tr><th>date</th><td>Date/time helpers</td></tr>
-    <tr><th>feedgenerator</th><td>Create RSS or Atom feeds</td></tr>
-    <tr><th>html</th><td>HTML tags and form tags</td></tr>
-    <tr><th>markdown/textile</th><td>Convert
-    wiki-like text to HTML</td></tr>
-    <tr><th>media</th><td>Image files</td></tr>
-    <tr><th>mimehelper</th><td>MIME types</td></tr>
-    <tr><th>misc/util</th><td>Other helpers</td></tr>
-    <tr><th>number</th><td>Formatters and statistics</td></tr>
-    <tr><th>paginate</th><td>Display records a pageful at a time
-    </td></tr>
-    <tr><th>pylonslib</th><td>Helpers for Pylons</td></tr>
-    <tr><th>text</th><td>Text processing</td></tr>
-    </table>
-
-<p>WebHelpers is pure Python and has no dependencies.  However, a few
-helpers depend on 
-<a href="http://routes.groovie.org/">Routes</a>, 
-, 
-<a href="http://python.org/pypi/Unidecode/">unidecode</a>, 
-<a href="http://pythonpaste.org/webob/">WebOb</a>
-as noted in their documentation.  The Pylons helpers are designed for <a
-href="http://pylonshq.com/">Pylons</a>' request/response/session objects but
-can easily be ported to another web framework.  WebHelpers comes with an
-extensive set of unit tests.</p>
-
-<p>For support/question/patches, please use the `
-<a href="http://groups.google.com/group/pylons-discuss">Pylons mailing list</a>.</p>
-

docs/modules/__init__.rst

-:mod:`webhelpers`
-=================
-
-.. automodule:: webhelpers
-
-.. currentmodule:: webhelpers

docs/upgrading.rst

-Upgrading from previous versions of WebHelpers
-==============================================
+Upgrading from previous versions
+================================
 
 See `Changelog <changes.html>`_ for the full changelog.

webhelpers/__init__.py

-"""WebHelpers contains a wide variety of functions for web applications.
-It's pure Python and can be used with any web framework, and many of the
-helpers are also useful in non-web applications.
-
-WebHelpers includes the widely-used HTML tag builder with smart escaping and
-convenience functions for common tags. These ensure the HTML tags are
-syntactically correct and prevent cross-site scripting attacks. Convenience
-functions for form input tags and other common tags are provided.
-
-Other helpers perform text processing, display records a pageful at a time,
-generate Atom/RSS feeds with geographical (GIS) data, handle MIME types,
-calculate statistics, and more.  There are also high-level container types,
-including a value counter and accumulator.  There are lists of country names,
-country codes, US states, Canadian provinces, and UK counties.
-
-WebHelpers requires Python 2.4 or higher. It has not yet been tested with 
-Python 3.  WebHelpers has no formal dependencies; however, a few individual
-helpers depend on 
-`Routes <http://routes.groovie.org/>`_, 
-`Unidecode <http://python.org/pypi/Unidecode/>`_, 
-`WebOb <http://pythonpaste.org/webob>`_, or
-`Pylons <a href="http://pylonshq.com/>`_,
-as noted in their documentation.
-
-The main criteria for adding new helpers are: 
-
-* Is it useful in a wide variety of applications, especially web applications?
-
-* Does it avoid dependencies outside the Python standard library, especially
-  C extensions which are hard to install on Windows and Macintosh?
-
-* Is it too small to be released as its own project, and is there no other
-  Python project more appropriate for it?
-
-WebHelpers was originally created as a utility package for Pylons. Many of the
-helpers were ported from Ruby on Rails. Version 0.6 introduced the HTML tag
-builder and deprecated the rails helpers; new subpackages were added to replace
-the rails helpers. Version 1.0 builds on this with many additional helpers.
+"""WebHelpers is wide variety of functions for web applications and other
+applications.
 """
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.