[Rest2web-develop] Final Changes Committed Before Release

[Michael F. <fuz...@vo...>]

Hello all,

This is to let you know, that barring last minute bug reports or doc 
corrections, I've just done the final commit before releasing 0.5.0beta1.

This contains quite a few changes since 0.5.0alpha1, largely thanks to 
Martin Krafft. The changes since the last public release 0.4.0 are quite 
substantial.

The total changelog is (I will try to summarise it for the release 
announcement) :


Version 0.5.0 beta 1 2006/08/05
-------------------------------

Updated docs.

Moved 'pythonutils' distribution into the 'rest2web' directory for ease of
packaging.

Added a ``#!`` line to ``r2w.py``.

All rest2web imports now absolute imports.

Added 'quickstart.txt' thanks to Andrew Ittner.

Added an ``include`` standard function, this can be used to nest 
templates or
customise sections. (It will walk up the directory tree looking for the
file you specify and takes an optional argument if the file doesn't exist -
useful for templates that allow subdirectories to add to the template, or
even wrap the body.)

``make_dist.py`` now takes ``nopause`` as a command line argument 
(``make_dist.py``
is in `Subversion`_ for creating distributions.)

Default breadcrumb divider is now '>'. Breadcrumbs are also output in 
HTML
on separate lines for readability.

Fixed bug when ``final_encoding`` is ``None``.

Default config file is now called ``r2w.ini``. ``rest2web.ini`` will 
still be
supported until the next release.

Fixed bug with ``standerr`` where no logfile is used.

``print_crumbs`` can now take ``None`` for the dividers.

Added 'globalValues' to the namespace.

Experimentally added 'uservalues' and 'restindex' into each page in the
indextree. Encoding is not handled so they will be in the source encoding.

Special thanks to Martin Krafft for bugfixes and suggestions.


Version 0.5.0 alpha 2006/05/01
------------------------------

**rest2web** can now build a site with no index pages, no template and no
restindexes. This is the `force <../force_mode.html>`_ command line 
option. It can
be used to automatically build a site from a collection of ReST 
documents, and
use default templates.

``uservalues`` can be passed at the `command line <../command_line.html>`_
and in the config file. (Command line `uservalues <uservalues.html>`_ 
override
config file ones.) These uservalues are now available in every page. The
encoding of uservalues in the config file is specified by the 
``__encoding__``
value.

A ``--template-file`` (or ``-t``) command line option. (Will override 
the top
level ``template`` keyword specified in the restindex.) This allows you 
to have
alternative templates for a site; for example one for an online version and
another for distributed documentation.

New website template, created by `Fuchsiashock Design 
<http://www.fuchsiashock.co.uk>`_.

``final_encoding`` should never be ``utf8`` - should be ``utf-8`` 
instead. This
is because ``utf8`` is not recognised by browsers. (This is now 
automatically
handled.)

Added ``initialheaderlevel`` a new restindex keyword. It sets the size of
headers used in ReST documents. Can be set per page.

The ``file`` keyword has been bugfixed. It now only operates if the 
target file
doesn't exist or is different to the source file. It copies the 
timestamp along
with the file.

The `gallery plugin <gallery.html>`_ now ignores non-image files. It 
also skips
image files it can't handle (currently only animated jpgs.

**rest2web** now has three levels of verbosity, controlled from the command
line :
   
    * ``-v`` : Verbose, the default.
    * ``-a`` : Warnings and actions.
    * ``-w`` : Warnings only.

``uservalues`` can now be inserted in pages using a new syntax. Where 
this is
used, the uservalues are inserted *before* the page is rendered from ReST to
HTML. This means uservalues can be in ReST format. The syntax for single 
values
is ``{lt}* ... *>``. For multiple lines of code it is ``{lt}$ ... $>``.

Added ``modtimeiso`` value to the namespace and the ``formattime``
`standard function <../functions.html>`_.

The ``namespace`` and ``uservalues`` are both now available (as 
dictionaries)
to the macros and the standard functions.

Removed the two ``<br />`` from ``listend`` in the standard function
``minibar`` and added ``wrapper_class`` to ``print_details``.

Added ``os`` and ``sys`` to the namespace for every page.

The default crumb for index pages (if no ``page-title`` specified) is the
filename, minus the extension and turned to title case.

Removed ``urlpath`` from rest2web, because it is now in pythonutils.

It won't run in the distribution directory - need to run "make_dist.py". 
(This
only applies if fetched from `subversion 
<http://svn.rest2web.python-hosting.com>`_.