Commits

Mike Orr committed 5bc6d3e

Add Upgrading page, reword docs home page, add requirements file.

Comments (0)

Files changed (4)

docs/_templates/index.html

 <img src="_images/webhelpers-logo.png" width="100" height="110"
 style="float:left; margin-right:1em" />
   
-<p>WebHelpers contains a wide variety of utility functions for web applications
-and other applications. It's pure Python and can be used with any web
-framework.  <strong>Version 0.6.x</strong> has been used in production sites
-since July 2008.  <strong>Version 1.0</strong> is almost finished and contains
-many enhancements while remaining compatible. (The helpers deprecated in 0.6
-are removed in 1.0, including the entire rails suite.)</p>
+<p>WebHelpers is a wide variety of utility functions for web applications and
+other applications. It can be used with any web framework.
+<strong>Version 0.6.4</strong> is the current stable version; it was released
+July 2008.  <strong>Version 1.0 beta</strong> contains many enhancements while
+remaining compatible; a final release is expected the first quarter of 2010.
+(The helpers deprecated in 0.6 are removed in 1.0, including the
+entire rails suite.  See <a href="upgrading.html">Upgrading</a>.)</p>
 
 <p>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.</p> 
+convenience functions for common tags such as form fields. The common builder
+ensures the tags are syntactically correct and prevent cross-site scripting
+attacks and double-escaping.</p> 
 
-<p>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.</p>
+<p>Other helpers perform text processing, split a large number of records into
+pages, generate Atom/RSS feeds with geographical (GIS) data, handle MIME types,
+calculate numerica 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.</p>
 
 <p>WebHelpers is pure Python and has no dependencies.  However, a few
 helpers depend on 

docs/contents.rst

 .. toctree::
    :maxdepth: 1
 
+   upgrading
    changes
    todo
    modules

docs/upgrading.rst

+Upgrading from previous versions of WebHelpers
+==============================================
+
+See `Changelog <changes.html>`_ for the full changelog.
+# Pip requirements to build WebHelpers documentation and run tests.
+#
+# Required for tests
+Nose
+Routes
+WebOb
+
+# Required for generating HTML documentation
+Sphinx
+
+# Optional for certain helpers
+Unidecode
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.