modules/birthdays/INSTALL.txt

// $Id: INSTALL.txt,v 1.5 2008/10/01 09:05:38 maartenvg Exp $

CONTENTS OF THIS FILE
---------------------

 * More information
 * Install instruction
 * Upgrading


MORE INFORMATION
----------------

Before you install this module, you might want to read README.txt, which will
explain the functions of this module and its requirements.


INSTALL INSTRUCTIONS
--------------------

1. Place all Birthdays module files in the modules directory
   'sites/all/modules/birthdays', or when you run a multi-site installation, in the
   appropiate multi-site directory 'sites/SITENAME/modules/birthdays'.
2. Go to the modules page, and install both the Profile module and the
   Birthdays module.
3. If you already have a Profile field of type 'date' that you want to use
   for the Birthdays module, you can skip this step. Otherwise, go to
   ?q=admin/user/profile and create one. For information about the
   settings here read the 'Settings' section of README.txt.
4. Go to ?q=admin/settings/birthdays and select the Profile Field you want
   Birthdays to use. You can alter any of the other settings to your likings.
5. Optionally: Activate the menu item for the birthdays listing
   and/or activate one of the blocks.

If you used an existing Profile field for Birthdays and want to export the
already collected dates to the Birthdays module, you need to go to
?q=admin/settings/birthdays/sync. There you press the 'Copy Profile data
to Birthdays module' button, which is the topmost button. This will synchronize
the old data with the Birthdays module.


UPGRADE INSTRUCTIONS
--------------------

  Birthdays 5.x-1.x to 6.x-1.x
  ----------------------------
  Will be added later.


  Birthdays 5.x-1.x-dev (before August 10, 2007) to 5.x-1.x
  -----------------------------------------------------------
  These update instructions are for upgrading a 5.x development version prior
  to the version which integrates with the Profile module which went in at the
  10th of August, 2007.

  1. Disable (but do not uninstall) the Birthdays module.
  2. Empty the Birthdays module directory and put the new files in.
  3. Go to the modules page, and install both the Profile module and the
     Birthdays module.
  4. Run update.php.
  5. If you already have a Profile field of type 'date' that you want to use
     for the Birthdays module, you can skip this step. Otherwise, go to
     ?q=admin/user/profile and create one. For information about the
     settings here read the 'Settings' section of README.txt.
  6. Go to ?q=admin/settings/birthdays and select the Profile Field you want
     Birthdays to use. You can alter any of the other settings to your likings.
  7. Go to the Synchronisation page at ?q=admin/settings/birthdays/sync and
     click the 'Copy Birthdays date to Profile module' button, which is
     the button at the bottom. This might take a while, depending on the amount
     of users.
1	// $Id: INSTALL.txt,v 1.5 2008/10/01 09:05:38 maartenvg Exp $
2
3	CONTENTS OF THIS FILE
4	---------------------
5
6	* More information
7	* Install instruction
8	* Upgrading
9
10
11	MORE INFORMATION
12	----------------
13
14	Before you install this module, you might want to read README.txt, which will
15	explain the functions of this module and its requirements.
16
17
18	INSTALL INSTRUCTIONS
19	--------------------
20
21	1. Place all Birthdays module files in the modules directory
22	'sites/all/modules/birthdays', or when you run a multi-site installation, in the
23	appropiate multi-site directory 'sites/SITENAME/modules/birthdays'.
24	2. Go to the modules page, and install both the Profile module and the
25	Birthdays module.
26	3. If you already have a Profile field of type 'date' that you want to use
27	for the Birthdays module, you can skip this step. Otherwise, go to
28	?q=admin/user/profile and create one. For information about the
29	settings here read the 'Settings' section of README.txt.
30	4. Go to ?q=admin/settings/birthdays and select the Profile Field you want
31	Birthdays to use. You can alter any of the other settings to your likings.
32	5. Optionally: Activate the menu item for the birthdays listing
33	and/or activate one of the blocks.
34
35	If you used an existing Profile field for Birthdays and want to export the
36	already collected dates to the Birthdays module, you need to go to
37	?q=admin/settings/birthdays/sync. There you press the 'Copy Profile data
38	to Birthdays module' button, which is the topmost button. This will synchronize
39	the old data with the Birthdays module.
40
41
42	UPGRADE INSTRUCTIONS
43	--------------------
44
45	Birthdays 5.x-1.x to 6.x-1.x
46	----------------------------
47	Will be added later.
48
49
50	Birthdays 5.x-1.x-dev (before August 10, 2007) to 5.x-1.x
51	-----------------------------------------------------------
52	These update instructions are for upgrading a 5.x development version prior
53	to the version which integrates with the Profile module which went in at the
54	10th of August, 2007.
55
56	1. Disable (but do not uninstall) the Birthdays module.
57	2. Empty the Birthdays module directory and put the new files in.
58	3. Go to the modules page, and install both the Profile module and the
59	Birthdays module.
60	4. Run update.php.
61	5. If you already have a Profile field of type 'date' that you want to use
62	for the Birthdays module, you can skip this step. Otherwise, go to
63	?q=admin/user/profile and create one. For information about the
64	settings here read the 'Settings' section of README.txt.
65	6. Go to ?q=admin/settings/birthdays and select the Profile Field you want
66	Birthdays to use. You can alter any of the other settings to your likings.
67	7. Go to the Synchronisation page at ?q=admin/settings/birthdays/sync and
68	click the 'Copy Birthdays date to Profile module' button, which is
69	the button at the bottom. This might take a while, depending on the amount
70	of users.