Ophelia

================

- Nothing changed yet.

==================

- Updated project files to reflect the new secondary, GitHub home at
<https://github.com/tlotze/ophelia>.

- Updated buildout configuration to keep working with zc.buildout 1.

- Fixed a memory leak in Namespaces that would occur with Python versions
prior to 2.7.4.

================

- Use xsendfile to deliver files from disk in the event that the requested
path couldn't be traversed using the templates. This makes Ophelia
independent of a front-end server for delivering on-disk documents. As a
small trade-off, having directory listings created dynamically is presently
not possible at all, other than explicitly by writing templates and scripts.

- Dropped anything related to Apache and mod_python, continue WSGI-only.

- Dropped support for Python 2.4 and 2.5. This means the wsgiref module is a
part of the Python standard library so the egg's ``wsgiref`` extra is gone.

- Dropped the version restriction on zope.tal, updated tests. Page templates
no longer grow a trailing new-line character when rendering themselves.

- Dropped ``ophelia.tool.feed`` since it was never properly designed, tested
nor even documented.

- Dropped the ``ophelia-dump`` script which has never been really useful.

- Simplified the ``ophelia-wsgiref`` example server so that it no longer reads
a particular section of its configuration file; have Ophelia's development
buildout create a separate configuration file for the included example site.

- Added a paste application factory and some example configuration for running
Ophelia in a WSGI container configured by a paste "ini" file.

- Allow configuration settings to be passed to the WSGI application upon
initialisation.

- Added a debug mode for the WSGI application.

- Declared the ``ophelia`` package a namespace to allow contribution packages
to be called ``ophelia.xxx``.

- Deprecated the ``tools`` package as it was never designed for general use.
Need to keep them around for the sake of some known web sites using them.

- Re-organised the small example site that comes with the source.

- Re-organised tests, added programmatic tests for the WSGI interface.

- Use Python's own ``doctest`` module for tests, got rid of using
zope.testing's deprecated fork of it and thus the zope.testing dependency.

- Applied most of the conventions of ``tl.pkg`` to the package source.

- Made sure that HTTP response headers are of type ``str``.

- Fixed the locale setting for date formatting introduced in 0.3.5.

- Fixed the target location link inside the response body of WSGI redirects.

==================

- Moved the project to the Mercurial version control system with new Bitbucket
home at <https://bitbucket.org/tlotze/ophelia/>.

- Made sure that HTTP response headers are of type ``str``.

- Added a method ``MetaData.header_date`` that formats a date in RFC 2822
format and C locale regardless of the currently active locale. Also format
the expires date in the C locale always. This allows setting up web sites
with a non-C locale without risking non-ASCII characters in HTTP headers,
and non-english month names appearing in RFC 2822 dates more generally.

==================

User-visible:
- The navigation tool now allows splitting menus into blocks by inserting
menu entries with empty titles.

Bug fixes:
- Made WSGI error reporting robust against character encoding issues.

API:
- Added an optional parameter to ``process_file`` to allow executing the
script in a custom namespace.

- Added the ``xml_version`` attribute to the request as a temporary way to
achieve an XML declaration that says "version=1.0", needed by Atom feeds.

Code:
- Store the current request and file context in thread-local stacks instead
of looking them up by inspecting the execution frame stack. Inspecting the
stack was a huge time sink, responsible for 75% of a request's
``__call__`` time on one real-world site.

Organization:
- simplified the buildout configuration due to new versions of Sphinx and
tl.buildout_apache

==================

Bug fixes:
- file-specific context variables were not set during template evaluation

- fixed file positions shown in template traceback supplements skewed by
splitting off scripts from files' beginnings

API:
- added ``input`` request attribute which is a file-like object from which
to read the request body

- added ``headers`` request attribute which is a namespace of HTTP headers
with leading ``HTTP_`` removed

- optionally pre-fill ``response_headers`` namespace with response headers
set earlier by the server environment

Organization:
- added setup for generating HTML documentation using Sphinx