modules/bookroll/README.txt

//$Id$

OVERVIEW
========
Bookroll.module allows users of a site to maintain a 'reading list' of books they're working on, waiting for, etc. It's based on the code from blogroll.module, and is still pretty rough, but I'm using it on my own site.


REQUIREMENTS
============

Bookroll.module is written for Drupal 4.7. A backport might happen someday -- anyone who wants to tackle it is welcome to!
Bookroll REQUIRES Amazon.module 


INSTALLATION
============
Execute the bookroll.mysql file against your database and copy the bookroll directory to your Drupal /modules directory. Once you've enabled it, the admin/block page will have the 'Bookroll' block listed. Any suers with 'access content' permissions will be able to see books in this block. Any users with the 'maintain bookroll' permission will be able to use the 'edit' link at the bottom of the block to add, delete, and update the books in the list.

While the block and the /bookroll page list books from ALL users, users can only edit the entries THEY have added.

Book titles are not entered manually -- instead, the Amazon ASIN for each book is entered and product information is pulled from Amazon automatically.


THEMING
=======
theme_bookroll_item() and theme_bookroll_page_item() are both exposed for overriding. 


TODO
====

Better theming support for the page and block
Clean up the inline CSS bits -- add 'bookroll.css' for cleanliness
Cleaner support for multi-user scenerios (show who added what books, etc)
More actions based on current reading status (separate list by read/not read/etc)
1	//$Id$
2
3	OVERVIEW
4	========
5	Bookroll.module allows users of a site to maintain a 'reading list' of books they're working on, waiting for, etc. It's based on the code from blogroll.module, and is still pretty rough, but I'm using it on my own site.
6
7
8	REQUIREMENTS
9	============
10
11	Bookroll.module is written for Drupal 4.7. A backport might happen someday -- anyone who wants to tackle it is welcome to!
12	Bookroll REQUIRES Amazon.module
13
14
15	INSTALLATION
16	============
17	Execute the bookroll.mysql file against your database and copy the bookroll directory to your Drupal /modules directory. Once you've enabled it, the admin/block page will have the 'Bookroll' block listed. Any suers with 'access content' permissions will be able to see books in this block. Any users with the 'maintain bookroll' permission will be able to use the 'edit' link at the bottom of the block to add, delete, and update the books in the list.
18
19	While the block and the /bookroll page list books from ALL users, users can only edit the entries THEY have added.
20
21	Book titles are not entered manually -- instead, the Amazon ASIN for each book is entered and product information is pulled from Amazon automatically.
22
23
24	THEMING
25	=======
26	theme_bookroll_item() and theme_bookroll_page_item() are both exposed for overriding.
27
28
29	TODO
30	====
31
32	Better theming support for the page and block
33	Clean up the inline CSS bits -- add 'bookroll.css' for cleanliness
34	Cleaner support for multi-user scenerios (show who added what books, etc)
35	More actions based on current reading status (separate list by read/not read/etc)