########################################################################
#
# The Web DVD List Program - README
# Version 0.1.0 (welles)
#
#
# Copyright (c) 2001 Chris Carline (chris@carline.org)
#
# You may distribute under the terms of either the GNU General Public
# License or the Artistic License, as specified in the Perl README file.
#
#
########################################################################
PREAMBLE
The DVD List is a perl-based package to facilitate the lending of DVD's people have collected as an office-intranet application or between a group of friends.
It was written to replace a system that was based around a csv file that had to be manually updated, and so represents the Next Generation tool for your DVD-listing needs.
INSTALL
The DVD List program currently has the following prerequisites:
- Perl 5.005, with DBI and DBD::mysql
- LWP perl modules installed
- The NG::* modules included with this distribution
- MySQL 3.22 or above
- CGI compliant web server (e.g. Apache 1.3)
NB - Apache/mod_perl install should work under Registry, but
HAS NOT been tested. Feedback apreciated!
Recommended software
- Cygwin for Win32 machines (for the bash prompt!)
There is currently no automated install process - this will only happen if there is enough interest in the code. Which is, (frankly) unlikely! Still, if anyone wants to volunteer..!
Once the prerequistes have been installed and configured on your system, you'll need to unpack the distribution in your webserver's cgi-bin (or equivalent). This will create a directory called "dvdlist" containing all the required files.
Create a database in MySQL called "dvd" with this command from the bash prompt:
mysqladmin -u{username} -p create dvd
Which will prompt you for your password, and all being well, will create an empty database in which to hold the DVD data.
The next step is to set up the tables in the database, with the command as follows:
cat dvd.mysql | mysql -u{username} -p dvd
Again, you'll be prompted for your password. After the command has finished running, the DVD database will have been fully set up.
You should also create a database login to be used by the program.
Copy the DVDList/* directory into your /lib/perl/5.005/site_perl/ directory (or equivalent - c:\perl\site\lib under Activestate perl on win32)
You will need to edit the index.cgi to give the script a username and password on your system.
All being well, you should be able to type in the URL of the DVDList and be greeted by the welcome page - log in as the administrator with the (default) settings of username "dvdlist" and password "letmein!"
PATCHES/BUG REPORTS/FEATURE REQUESTS
Patches and bug reports should be sent to chris@carline.org. The system is currently in its infancy and I expect there will be a number of issues with the system, hopefully nothing too dreadful, but you never know! 8)
MISC
All releases will be given an arbitrary code name (in addition to an arbitrary version number) which will be the surname of a famous movie star/director. Email suggestions to chris@carline.org
ABOUT
The DVD List was written during 40-minute commutes between Luton and London (Farringdon) stations on Thameslink trains. That probably explains quite a lot 8)
KNOWN ISSUES
The statistics aren't /entirely/ accurate...
TO-DO LIST (SHORT-TERM)
- Code documentation is a necessary evil, isn't it?
- Launch "DVD List Mk2" and squish any bugs that arise from increased usage
TO-DO LIST (LONGER-TERM)
- "Loaning library" function - who's borrowing what?
- An optional chronological view, Alphabetised within each year (year stats can be sourced from IMDb)
- Personalisation - you name it, really...
- More intelligent form handling
- Discussion forum
- Integrated mail client and web browser
- Re-write in C# and port to IISAPI
RELEASE HISTORY
2001-01-31 - V0.1.0 (welles)
An important landmark - now functionally complete,
the launch version. Probably lots of bugs which will
be ironed out over a couple of months. The design has
been modified to improve navigation and consistency.
Features added:
- Those drop down boxes now do something (e.g. 'work')
- "Classic" view eradicated. Let's face it, it was shit.
- HTML sub-templates for common elements.
- Ability to update personal information
- User/DVD statistics: I can piss further than you can!
- User Biographies implemented
- "What's New" indicator
- Spurious code removal
- New module "List.pm" for list creation
- "dvdlist.cgi" renamed to "index.cgi" and all
references in templates updated to _scriptname
template tag for easy renaming in future.
- DVD Administrator ability to "nuke" a DVD Title
- DVD Administrator account to add/modify/delete users
- DVD Administrator ability to "switch" user from
admin->user and user->admin
- Lots of bugs removed (add lots of new ones added),
no doubt.
2001-01-17 - V0.0.7 (brosnan)
Very nearly approaching functional completeness (at
least in the most basic sense of the term) but not
quite there yet. Code has been tidied, restructured
and modularised, and is much better than the last
version.
Features Added:
- Created DVDList::Manipulate::DVD and
DVDList::Manipulate::Member perl modules
- Added administration functions (users can now add/
modify/delete DVDs in their collections - yay!)
- Got rid of lots of nasty perl warnings
- IMDB integration when adding a new DVD
- Improved legacy support
- Better readability in enhanced view
- Persistance in drop down lists (woohoo!)
2001-01-10 - V0.0.5 (burton)
(not publically released)
This version added session handling, member control and
this README, as well as a few tweaks and bugfixes here
and there. Not so much the actor as the wagon wheel.
2001-01-09 - V0.0.1 (smithee)
The first ever public release. Almost completely
useless. Significantly lacking. Director requested his
name removed from this release 8)
8)