About this file:

MIGRATING is updated with every release that requires existing SIPS
installations to be adjusted. You don't need to read this file if you're
installing SIPS for the first time.



MIGRATING FROM SIPS 0.2.3 TO 0.2.4
----------------------------------

The emailing of notifications of new story submissions can now be
disabled by setting $config["notify-submissions"] to 0 in .sipsconfig.php.

When people search stories, the returned list is now chunked up so not
all are puked out at once. You can decide how many titles will be in
each chunk by setting $config["maxhits"]. You must set this to something!

I've kind of realized that it's not entirely correct to call RSS files
"RDF" because they're stricly speaking not RDF -- they're RSS! So I've
changed every occurance of RDF into RSS. This means you must edit your
.sipsconfig.php. The following variables have been renamed:

$config["exportrdf"] -> $config["export-rss"]
$config["enablerecentrdf"] -> $config["enable-recent-rss"]
$config["rdfcachetime"] -> $config["rss-cache-time"]

If you think *that's* bad, hear this; you also have to fix every
existing box that uses RSS files. I'm talking about the files in SIPSSYS/boxes.
URLs to RSS files used to be prefixed with RDF: -- now, it must be
RSS. Use the admin section or a regular text editor.

The file <sipssys>/code/rdfparser.inc.php has been replaced by
<sipssys>/code/rssparser.inc.php, so you can safely delete the former.

Also note that the RSS files SIPS produces have been renamed as well.
<sitename>.rdf is now simply backend.rss, and <sitename>-recent.rdf
is now recent.rss. If someone syndicates your headlines you should make
sure they update their URLs. (If you think this sucks and the name change is
unnecessary, I can only say sorry; sips is still in active development
and things *will* change.)

In 0.2.4, post.php is themable. The template file is called "post" and
must be included with every theme. The only keyword in this file
is #FORM#, which will be replaced by the submission form and
story preview.



MIGRATING FROM SIPS 0.2.2 TO 0.2.3
----------------------------------

Sips 0.2.3 has timezone settings.

You have to insert a new line into SIPSSYS/users/d/default/user that reads
"Timezone::My Timezone". Substitute "My Timezone" with one of the strings
in SIPSSYS/code/timezones.inc.php. For instance, a valid line could read
"Timezone::Greenwich Mean". All new users will get this timezone as default.

Alternatively, if you haven't changed the default user file for user "default",
just use the file that comes with sips 0.2.3 :) Thisone has GMT as standard.

Topic icon handling has been improved. The image dimensions can now be
individually different -- they're detected at run-time, so you don't have to
worry about that. Also, the images must be moved to a new directory called
<htdocs>/gfx/topics (the old one was <htdocs>/gfx/news), and the file name must
be "topicname.gif", "topicname.jpg" or "topicname.png" (the old one was
"news.topicname.gif"). That's right, you can choose your favorite file format.
Burn those gifs! ;)

#TOPIC# in the frontpage template has been renamed to #TOPICICON#, so please
update your frontpage files for all your themes. Note that you can now also
use #TOPICTEXT# for a textual version with no icon graphic.

I've made a list of which permissions the various dirs and files should have,
please check with docs/INSTALL to make sure you haven't been too permissive
with the permissions :)

readmore.php has been renamed to story.php. You might want to keep both
files for a while to avoid dead links.



MIGRATING FROM SIPS 0.2.x TO 0.2.2
----------------------------------

sips is now fully themable. You need to move the files in your SIPSSYS/html
dir to a new dir called SIPSSYS/themes/themename, substituting "themename"
with a name for that theme. If you're only going to have that one theme,
you may as well call it something like "default". You may add as many themes
as you want simply by copying the files to other directories in SIPSSYS/themes
and edit them. Delete SIPSYS/html, it's deprecated and not needed.

Now, open SIPSSYS/users/d/default/user in an editor and add a line that says
"Theme::themename" - let "themename" be the name of the default theme users
will get. It can be any of the themes in SIPSSYS/themes.

This release of SIPS uses the md5 hashing algorithm instead of *nix crypt() for
storing user passwords. This means that existing users will get an error
message when trying to log in. If they've registered their e-mail address,
sips can send them a new, correct password, but in the other case they will
not be able to log in. Sorry.

$config["salt"] in .sipsconfig.php is no longer in use - you can remove it
safely.

Boxes parse RDF files slightly differently now - to indicate that the file
to be included is an RDF file, it must be prefixed with "RDF:", for instance
RDF:http://www.mysite.net/mysite.rdf.


MIGRATING FROM SIPS 0.1.2 TO 0.2.0
----------------------------------

This version of sips has changed quite a bit in some areas.

First of all, update your .sipsconfig.php file. The format has changed
slightly, but updating it should be straightforward.

One new parameter in the config file is $config["salt"]. The value of this
should be the two-character random salt that sips uses to encrypt user's
passwords. In your case, it is imperative that you set this to be the
first character of $config["sitename"] (what used to be '$sitename'). Users
may still need to set a new password.
New users should set the salt to two random characters.

Second, notice the new directory SIPSSYS/html. The files in here are
design templates for your site. You _have_ to change it to what you
want it to be, esp. siteheader. This should be a lot better than
changing the HTML in top.inc.php (which is now called site.inc.php).

Third, if you use the "Recent Stories" box, you'll no longer need
SIPSSYS/code/boxinclude/recentstories.php3. To migrate, set
$config["enablerecentrdf"] = 1 in .sipsconfig.php. Then edit your
recentstories box to include the file http://yoursite/sitename-recent.rdf
(making the obvious substitutions). You will need to edit a story or
post something new to have this file generated.
