modules/bookmarks/README.txt

Drupal bookmarks.module README.txt
==============================================================================

This module lets users with "access bookmarks" permission to have a
bookmark/hotlist block. User can add and delete bookmarks pointing
to onsite pages, plus edit the titles of existing bookmarks, in case the
default title does not fit.

Installation
------------------------------------------------------------------------------

1. Create the SQL table.
     mysql -u username -ppassword drupal < bookmarks.sql

2. Copy bookmarks.module and trash.gif under Drupal's modules/bookmarks
   directory. Drupal should automatically detect it. Enable the module via
   the administer >> modules page.

3. Enable the 'User Bookmarks' block on the administer >> blocks page.

4. Add "access bookmarks" permission to those roles, who you would like to
   add bookmark support. Note that since bookmarks are stored for users
   only, it is not possible to let anonymous users to have bookmarks.

5. If you have a custom theme, you can customize the delete icon by
   defining a themename_bookmarks_del() function (replacing 'themename'
   with the name of your theme). See the theme_bookmarks_del() implementation
   in bookmarks.module. The bookmarks block is also themeable (via
   theme_bookmarks_block()).

   Bookmarks related links will appear under the user's own menu. If you need
   to have a 'bookmark this page' link somewhere in your theme, use the
   user/$user->uid/bookmarks/add/quick URL target for the link (where
   $user->uid is the user identifier).

Authors
------------------------------------------------------------------------------

Marco Molinari <marco [at] porciletto.org>
Al Maw         <drupal [at] almaw.com>
Matt Westgate  <drupal [at] asitis.org>
Gabor Hojtsy   <goba [at] php.net> (active maintainer)

History
------------------------------------------------------------------------------

This module idea came from kuro5hin, and it was originally created by
Marco Molinari <marco [at] porciletto.org>. Updated Feb 2003 by Al Maw
<drupal [at] almaw.com> to work with Drupal CVS (clean URLs).
Also renamed "bookmarks", as that seemed a great deal more obvious.
The module was mostly rewritten in October 2003 to support arbitrary
Drupal URL bookmarks by Gabor Hojtsy (<goba [at] php.net>). Matt Westgate
rewritten the module to make it capable of handling outbound links in
February 2004.

TODO
------------------------------------------------------------------------------

There has been an interesting discussion about mixing hotlists and metadata,
so that users can give metadata to their bookmarks, but this still has to
be well discussed.
1	Drupal bookmarks.module README.txt
2	==============================================================================
3
4	This module lets users with "access bookmarks" permission to have a
5	bookmark/hotlist block. User can add and delete bookmarks pointing
6	to onsite pages, plus edit the titles of existing bookmarks, in case the
7	default title does not fit.
8
9	Installation
10	------------------------------------------------------------------------------
11
12	1. Create the SQL table.
13	mysql -u username -ppassword drupal < bookmarks.sql
14
15	2. Copy bookmarks.module and trash.gif under Drupal's modules/bookmarks
16	directory. Drupal should automatically detect it. Enable the module via
17	the administer >> modules page.
18
19	3. Enable the 'User Bookmarks' block on the administer >> blocks page.
20
21	4. Add "access bookmarks" permission to those roles, who you would like to
22	add bookmark support. Note that since bookmarks are stored for users
23	only, it is not possible to let anonymous users to have bookmarks.
24
25	5. If you have a custom theme, you can customize the delete icon by
26	defining a themename_bookmarks_del() function (replacing 'themename'
27	with the name of your theme). See the theme_bookmarks_del() implementation
28	in bookmarks.module. The bookmarks block is also themeable (via
29	theme_bookmarks_block()).
30
31	Bookmarks related links will appear under the user's own menu. If you need
32	to have a 'bookmark this page' link somewhere in your theme, use the
33	user/$user->uid/bookmarks/add/quick URL target for the link (where
34	$user->uid is the user identifier).
35
36	Authors
37	------------------------------------------------------------------------------
38
39	Marco Molinari <marco [at] porciletto.org>
40	Al Maw <drupal [at] almaw.com>
41	Matt Westgate <drupal [at] asitis.org>
42	Gabor Hojtsy <goba [at] php.net> (active maintainer)
43
44	History
45	------------------------------------------------------------------------------
46
47	This module idea came from kuro5hin, and it was originally created by
48	Marco Molinari <marco [at] porciletto.org>. Updated Feb 2003 by Al Maw
49	<drupal [at] almaw.com> to work with Drupal CVS (clean URLs).
50	Also renamed "bookmarks", as that seemed a great deal more obvious.
51	The module was mostly rewritten in October 2003 to support arbitrary
52	Drupal URL bookmarks by Gabor Hojtsy (<goba [at] php.net>). Matt Westgate
53	rewritten the module to make it capable of handling outbound links in
54	February 2004.
55
56	TODO
57	------------------------------------------------------------------------------
58
59	There has been an interesting discussion about mixing hotlists and metadata,
60	so that users can give metadata to their bookmarks, but this still has to
61	be well discussed.