modules/bookmarks2/README.txt

Drupal bookmarks2.module README.txt
==============================================================================

This module lets users with "access bookmarks" permission to have a
bookmark 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.

Requirements
------------------------------------------------------------------------------

This module requires Drupal 4.7.

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

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

2. Copy bookmarks2.module and trash.gif under Drupal's modules/bookmarks2
   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_bookmarks2_del() function (replacing 'themename'
   with the name of your theme). See the theme_bookmarks2_del() implementation
   in bookmarks2.module. The bookmarks block is also themeable (via
   theme_bookmarks2_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/bookmarks2/add/quick URL target for the link (where
   $user->uid is the user identifier).

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

David Kent Norman <deekayen [at] deekayen {dot} net> (maintainer)
Sponsored by Advanced Automation http://www.advancedautomationinc.com/

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

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. David Kent Norman forked the bookmarks module to
bookmarks2 to add some controversial features and keep a simpler alternative.
1	Drupal bookmarks2.module README.txt
2	==============================================================================
3
4	This module lets users with "access bookmarks" permission to have a
5	bookmark 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	Requirements
10	------------------------------------------------------------------------------
11
12	This module requires Drupal 4.7.
13
14	Installation
15	------------------------------------------------------------------------------
16
17	1. Create the SQL table.
18	mysql -u username -ppassword drupal < bookmarks2.sql
19
20	2. Copy bookmarks2.module and trash.gif under Drupal's modules/bookmarks2
21	directory. Drupal should automatically detect it. Enable the module via
22	the administer >> modules page.
23
24	3. Enable the 'User Bookmarks' block on the administer >> blocks page.
25
26	4. Add "access bookmarks" permission to those roles, who you would like to
27	add bookmark support. Note that since bookmarks are stored for users
28	only, it is not possible to let anonymous users to have bookmarks.
29
30	5. If you have a custom theme, you can customize the delete icon by
31	defining a themename_bookmarks2_del() function (replacing 'themename'
32	with the name of your theme). See the theme_bookmarks2_del() implementation
33	in bookmarks2.module. The bookmarks block is also themeable (via
34	theme_bookmarks2_block()).
35
36	Bookmarks related links will appear under the user's own menu. If you need
37	to have a 'bookmark this page' link somewhere in your theme, use the
38	user/$user->uid/bookmarks2/add/quick URL target for the link (where
39	$user->uid is the user identifier).
40
41	Authors
42	------------------------------------------------------------------------------
43
44	David Kent Norman <deekayen [at] deekayen {dot} net> (maintainer)
45	Sponsored by Advanced Automation http://www.advancedautomationinc.com/
46
47	Marco Molinari <marco [at] porciletto.org>
48	Al Maw <drupal [at] almaw.com>
49	Matt Westgate <drupal [at] asitis.org>
50	Gabor Hojtsy <goba [at] php.net>
51
52	History
53	------------------------------------------------------------------------------
54
55	This module idea came from kuro5hin, and it was originally created by
56	Marco Molinari <marco [at] porciletto.org>. Updated Feb 2003 by Al Maw
57	<drupal [at] almaw.com> to work with Drupal CVS (clean URLs).
58	Also renamed "bookmarks", as that seemed a great deal more obvious.
59	The module was mostly rewritten in October 2003 to support arbitrary
60	Drupal URL bookmarks by Gabor Hojtsy (<goba [at] php.net>). Matt Westgate
61	rewritten the module to make it capable of handling outbound links in
62	February 2004. David Kent Norman forked the bookmarks module to
63	bookmarks2 to add some controversial features and keep a simpler alternative.