Removing translation directories
[project/privatemsg.git] / INSTALL.txt
1 Readme
2 ------
3
4 This is my first Drupal module: a very basic private messaging module. It allows your site's visitors to send private messages to each other. It does not use Jabber at all (but could be fun to use it). Features:
5
6  - read/write/delete messages
7  - reply to message with quoting
8  - new messages support (block and page)
9  - folders
10  - pruning
11  - contact list
12  - option to get mail if you have unread messages
13
14 If you want to create a link to send a user a message, use:
15 l(t("send private message"), "privatemsg/msgto/$user->uid"))
16
17 Send comments to marco@porciletto.org.
18
19
20 Requirements
21 ------------
22
23 This module requires Drupal CVS circa 22/5/03, and should work with the upcoming Drupal 4.2.
24
25
26 Installation
27 ------------
28
29 1. Create the SQL tables.
30      mysql -u username -ppassword drupal < privatemsg.sql
31
32 2. Copy the privatemsg.module to the Drupal modules/ directory. Drupal should automatically detect it. Enable in administration/site configuration/modules.
33
34 3. Check "access private messages" in "roles and permissions" in the administration; anonymous users should not have permission. You can also change something in "settings and filters".
35
36 4. If you make a theme, you can add support for private messaging in your theme calling privatemsg_get_link(); for example:
37    if (function_exists("privatemsg_get_link")) echo "<A HREF=\"".privatemsg_get_link($comment->name)."\">private message</A>";
38    Of course you can use a fancy small icon instead of text link. A good place could be comments, near the name.
39    
40 5. Enjoy!
41
42
43 Author
44 ------
45
46 Marco Molinari <marco@porciletto.org>
47