---------
Upgrading
---------

This file tracks the changes required to upgrade from one version to
another while keeping your web site data.

Just like any other upgrade I highly recommend backing up your current
weblog data first (if you haven't already). If you have shell access
to the database you can use "mysqldump". Also most ISPs offer a web
based client (such as phpMyAdmin) which can "dump" the database.

There are two methods for running the SQL commands necessary to
upgrade:

* Easy Installer

Copy the setup.php and upgrade.sql into your web space and load up
setup.php in your browser. Select your current version and the script
will run all the SQL necessary to bring your database up to the
current version. Remember to remove setup.php and upgrade.sql from
your web space and copy the new weblog.inc over. Unfortunately some
changes (usually minor) can't be easily automated. Check below for any
non-essential changes to make under "edit setup".

* MySQL clients

Cut-n-paste the commands into an SQL client like the command line
"mysql" of web based "phpMyAdmin". The upgrade.sql file contains a
list of commands separated by version. Each list describes how to
upgrade the database to that particular version from the previous
version. Always run the commands from the oldest to the newest
version. Check below for non-essential changes to your weblog setup.

The following sections list changes between versions which cannot
easily be done through SQL. Of course, if you only need to make the
changes if you agree with them. If you have already heavily customised
your weblog you will need to consider each change separately.

--------------
0.9.9 -> 1.0.0
--------------

* The prefix and topic restriction parameters to Weblog() have been
  swapped. The topic restriction option is much more popular than
  prefix, so it made sense to swap them. Any page which uses either
  feature will need to be changed.
* To assist with HTML validation the attribute 'alt=""' was added to the
  IMG tag in the blank_html configuration variable.

--------------
0.9.7 -> 0.9.8
--------------

* To support text links in addition to image links on the forward and next
  buttons several variables and their values had to be changed.
  "next_icon", "prev_icon" and "blank_icon" are now called "next_html",
  "prev_html" and  "blank_html". The "nav_icon_attrs" variable was obsoleted
  by this change and will be deleted after the upgrade through setup.php.
  You will need to change the icon filenames into complete inline image HTML.
  For example a stock "next_icon" would change to the following:
    <img src="gfx/next.png" alt="[next]" width="16" height="16" border="0">
  If you made any changes to nav_icon_attrs you will want to include those
  as well.
* The control bar text has been merged into the "control" configuration
  variable. This allows greater flexibility with the control bar formatting.
  This change has made the "topic_text" configuration variable obsolete.
  The setup.php upgrade will delete the "topic_text" variable and reset
  the "control" variable to the default control bar. You will need to
  customize this variable if any changes were made to "control" or
  "topic_text" in the past.

--------------
0.9.4 -> 0.9.5
--------------

* The weblog code now outputs XHTML compliant tags, however several
  tags in the configuration may need to be updated. If you are not
  interested in XHTML you can skip this step browers will still render
  your pages correctly. Otherwise:
  - All tags must have an end tag where possible:
    <p> must be followed by </p>
  - Tags which don't have closing tags should end with " />" instead:
    <br />  or  <img src="foo.jpg" />
  - All tags and their attributes must be in lower case:
    <img src="foo.jpg />
      NOT
    <IMG SRC="foo.jpg />
  See http://www.w3.org/TR/xhtml1/ for more information.

--------------
0.9.3 -> 0.9.4
--------------

* Remove @BACKLINK@ from "articles". This will stop the "back to main"
  links from appearing on the main page.
* Add @BACKLINK@ to "more" just before @ADMIN@. Back links will not be
  displayed on the "more" page unless this change is made.
* The "reset_text" configuration variable value has become "Find all"
  to better reflect its intent.

--------------
0.9.2 -> 0.9.3
--------------

* The admin menus that were displayed at the bottom of each entry can now have
  a configurable location. You must add "@ADMIN@" to your "article" and "more"
  variables otherwise you will be unable to edit or delete entries.

--------------
0.9.1 -> 0.9.2
--------------

* In "edit setup", "@TITLE" in the "articles" variable should be
  "@TITLE@".
