modules/location/INSTALL.txt

$Id: INSTALL.txt,v 1.10 2008/06/16 23:28:32 bdragon Exp $

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

 * Introduction
 * Installation

INTRODUCTION
------------

Current maintainer: Brandon Bergren <http://drupal.org/user/53081>

Location module and its associated API allows Drupal objects, including nodes
and users, to be associated with specific physical locations.

This package consists of several modules, including:
- Location (required): Base module that provides a standard API and storage for
  location data.
- Location Add Another: Quickly add additional locations directly from a node.
- Location Fax: Add a fax number to a location.
- Location Phone: Add a phone number to a location.
- Location Search: A custom search page for locations.

For Drupal 6, Views support has been rolled directly into the base Location module.

INSTALLATION
------------

1. Copy the files to your sites/SITENAME/modules directory.

2. Enable the Location module and any desired optional modules at Administer >>
   Site building >> Modules (admin/build/modules).

3. Set user permissions for Location module at Administer >> User management >>
   Access control (admin/user/access).

4. Configure Location module's settings at Administer >> Site configuration >>
   Location (admin/settings/location). Here, you may configure settings related
   to how Location fields are displayed, how location data is gathered, what
   geocoding service is used to translate addresses to longitude and latitude
   points, and which mapping service should display them.

5. If you wish to collect location data about content, go to Administer >>
   Content management >> Content types and click "edit" on the given type, such
   as "Event". In the Locative information fieldset, expand and set your
   options accordingly.

6. (Optional) Import a postal codes database for the countries served by your
   website, to support proximity searches and other useful features. Postal
   code databases may be found in the "databases/" sub-directory of the
   Location module directory. The files are in the format of zipcodes.CC.mysql,
   where CC is a two-letter country code such as 'us' or 'de'.

   Note: If your site is using table prefixes, you will need to adjust for this
   manually, by opening the file in a text editor and replacing 'zipcodes' with
   'prefix_zipcodes' throughout.

   To import the files from the command line, enter the following:

     cd sites/SITENAME/modules/location
     mysql -u username -p database-name < database/zipcodes.us.mysql
1	$Id: INSTALL.txt,v 1.10 2008/06/16 23:28:32 bdragon Exp $
2
3	CONTENTS OF THIS FILE
4	---------------------
5
6	* Introduction
7	* Installation
8
9	INTRODUCTION
10	------------
11
12	Current maintainer: Brandon Bergren <http://drupal.org/user/53081>
13
14	Location module and its associated API allows Drupal objects, including nodes
15	and users, to be associated with specific physical locations.
16
17	This package consists of several modules, including:
18	- Location (required): Base module that provides a standard API and storage for
19	location data.
20	- Location Add Another: Quickly add additional locations directly from a node.
21	- Location Fax: Add a fax number to a location.
22	- Location Phone: Add a phone number to a location.
23	- Location Search: A custom search page for locations.
24
25	For Drupal 6, Views support has been rolled directly into the base Location module.
26
27	INSTALLATION
28	------------
29
30	1. Copy the files to your sites/SITENAME/modules directory.
31
32	2. Enable the Location module and any desired optional modules at Administer >>
33	Site building >> Modules (admin/build/modules).
34
35	3. Set user permissions for Location module at Administer >> User management >>
36	Access control (admin/user/access).
37
38	4. Configure Location module's settings at Administer >> Site configuration >>
39	Location (admin/settings/location). Here, you may configure settings related
40	to how Location fields are displayed, how location data is gathered, what
41	geocoding service is used to translate addresses to longitude and latitude
42	points, and which mapping service should display them.
43
44	5. If you wish to collect location data about content, go to Administer >>
45	Content management >> Content types and click "edit" on the given type, such
46	as "Event". In the Locative information fieldset, expand and set your
47	options accordingly.
48
49	6. (Optional) Import a postal codes database for the countries served by your
50	website, to support proximity searches and other useful features. Postal
51	code databases may be found in the "databases/" sub-directory of the
52	Location module directory. The files are in the format of zipcodes.CC.mysql,
53	where CC is a two-letter country code such as 'us' or 'de'.
54
55	Note: If your site is using table prefixes, you will need to adjust for this
56	manually, by opening the file in a text editor and replacing 'zipcodes' with
57	'prefix_zipcodes' throughout.
58
59	To import the files from the command line, enter the following:
60
61	cd sites/SITENAME/modules/location
62	mysql -u username -p database-name < database/zipcodes.us.mysql