head	1.11;
access;
symbols
	DRUPAL-6--3-0:1.11
	DRUPAL-6--3:1.11.0.2
	DRUPAL-5--3-0:1.10
	DRUPAL-5--3-0-UNSTABLE4:1.10
	DRUPAL-6--3-0-UNSTABLE4:1.10
	DRUPAL-6--3-0-RC2:1.10
	DRUPAL-5--3-0-RC2:1.10
	DRUPAL-6--3-0-RC1:1.10
	DRUPAL-5--3-0-RC1:1.10
	DRUPAL-6--3-0-test3:1.10
	DRUPAL-5--3-0-test3:1.10
	DRUPAL-5--3-0-test2:1.10
	DRUPAL-5--3:1.10.0.2
	DRUPAL-5--3-0-test1:1.10
	DRUPAL-5--2-7:1.3.6.1
	DRUPAL-5--2-6:1.3.6.1
	DRUPAL-5--2-5:1.3.6.1
	DRUPAL-5--2-4:1.3.6.1
	DRUPAL-5--2-3:1.3.6.1
	DRUPAL-5--2-2:1.3.6.1
	DRUPAL-5--2-1:1.3.6.1
	DRUPAL-5--2-0:1.3.6.1
	DRUPAL-5--1-2:1.3.6.1
	DRUPAL-5--1-1:1.3.6.1
	DRUPAL-5--1-0:1.3.6.1
	DRUPAL-5:1.3.0.6
	DRUPAL-4-7:1.3.0.4
	DRUPAL-4-5:1.1
	DRUPAL-4-6:1.3.0.2;
locks; strict;
comment	@# @;


1.11
date	2008.12.10.18.16.42;	author bdragon;	state Exp;
branches;
next	1.10;
commitid	7bc8494007854567;

1.10
date	2008.06.16.23.28.32;	author bdragon;	state Exp;
branches;
next	1.9;
commitid	9494856f7194567;

1.9
date	2008.06.16.23.13.43;	author bdragon;	state Exp;
branches;
next	1.8;
commitid	7b154856f3a14567;

1.8
date	2008.01.24.09.31.33;	author bdragon;	state Exp;
branches;
next	1.7;
commitid	481747985af04567;

1.7
date	2008.01.24.06.46.50;	author bdragon;	state Exp;
branches;
next	1.6;
commitid	596e479834494567;

1.6
date	2008.01.24.02.03.53;	author bdragon;	state Exp;
branches;
next	1.5;
commitid	7e84797f1904567;

1.5
date	2008.01.22.21.40.36;	author brmassa;	state Exp;
branches;
next	1.4;
commitid	3d22479662c64567;

1.4
date	2008.01.21.19.06.15;	author bdragon;	state Exp;
branches;
next	1.3;
commitid	55f94794ed124567;

1.3
date	2005.08.04.00.54.47;	author ankur;	state Exp;
branches
	1.3.4.1
	1.3.6.1;
next	1.2;

1.2
date	2005.08.03.23.32.33;	author ankur;	state Exp;
branches;
next	1.1;

1.1
date	2005.03.17.05.31.34;	author ankur;	state Exp;
branches;
next	;

1.3.4.1
date	2007.02.24.23.44.00;	author ankur;	state Exp;
branches;
next	;
commitid	6ea945e0cd7e4567;

1.3.6.1
date	2007.02.24.23.45.17;	author ankur;	state Exp;
branches;
next	;
commitid	727545e0cdee4567;


desc
@@


1.11
log
@doc nit: location_views is part of location.module now.
@
text
@$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.10
log
@Followup by webchick: Remove some junk that was left in.
@
text
@d1 1
a1 1
$Id: INSTALL.txt,v 1.9 2008/06/16 23:13:43 bdragon Exp $
d24 2
a25 1
- Location Views: Views integration for Location fields.
@


1.9
log
@#271347 by webchick: Revamp INSTALL.txt

Thanks!
@
text
@d1 1
a1 1
$Id: INSTALL.txt,v 1.8 2008/01/24 09:31:33 bdragon Exp $
a61 13


Step 3
------
Enable the location module on your site.

Visit the settings page for location.module and enable features for U.S.
(the only option as of now).

Finally, go to the default workflow settings for each node type and enable
(or require) location collection on a field-by-field basis. It is encouraged
that you enable postal codes and country fields for node types for which you
want to enable proximity searches.
@


1.8
log
@Re-integration.
@
text
@d1 1
a1 1
$Id: INSTALL.txt,v 1.6 2008/01/24 02:03:53 bdragon Exp $
d3 13
a15 7
Step 1
------
To support proximity searches and most useful features, you will need a
postal codes database for each country for which you plan to use a file from
the "supported/" directory. The database structure can be loaded from the
database/zipcodes.mysql file, and the data can be loaded from
database/zipcodes.CC.mysql (where CC is the two-letter country code).
d17 8
a24 6
As of this post, only U.S. and German postal codes are supported. A single
zipcodes table holds all the zipcodes. To create the zipcodes table using
the database/zipcodes.mysql file from within the location tarball, feed
these dumps to your database. If your site is using a prefix for database
table names, make sure to adjust accordingly. Careful, the postal code dump
for the US is a few MB.
d26 2
a27 1
  mysql -u username -ppassword -h localhost database-name < modules/location/database/zipcodes.mysql
d29 1
a29 1
To make use of the U.S. postalcodes:
d31 2
a32 1
  mysql -u username -ppassword -h localhost database-name < modules/location/database/zipcodes.us.mysql
d34 2
a35 1
To make use of the German postal codes:
d37 5
a41 1
  mysql -u username -ppassword -h localhoost database-name < modules/location/database/zipcodes.de.mysql
d43 4
a46 5
where "username", "password" are the username/loging and "database-name" are
the parameters to login to your Drupal site's database. You can leave out
"-h localhost" if your MySQL server runs on the same site as your Apache.
However, replace 'localhost' in "-h localhost" if your MySQL server is on a
different machine.
d48 5
a52 4
Step 2
------
In the "modules/" directory, create a subdirectory called "location/" which
itself contains a subdirectory called "supported/".
d54 3
a56 1
Download "location.inc" to "modules/location/"
d58 1
a58 1
Download "location.module" to "modules/location/"
d60 2
a61 1
Download "earth.inc" to "modules/location/"
a62 2
Download "supported/location.us.inc" to "modules/location/supported/" (for
support of US locations)
@


1.7
log
@I hate to do this, but that first patch was just unacceptable.

It is going to be faster to merge in the last 6 pages of changes by hand.

Revert (sans a few files) to DRUPAL-5 again and start over.
@
text
@d1 2
a58 2


@


1.6
log
@Normalizing file headers, ensuring all the $Id$ tags work (Somehow a bunch of files got -kk'd in CVS so the tag expansion wasn't working), changing documentation around.
@
text
@a0 2
$Id$

d5 1
a5 1
the "countries/" directory. The database structure can be loaded from the
d35 1
a35 1
itself contains a subdirectory called "countries/".
d43 1
a43 1
Download "countries/location.us.inc" to "modules/location/countries/" (for
d57 2
@


1.5
log
@Misc:
* Rename the "supoported" directory to "countries" on code
@
text
@d1 2
a58 2


@


1.4
log
@Start of a new era.

Pull DRUPAL-5 up to HEAD.

HEAD is now the development branch up to 3.0.
@
text
@d5 1
a5 1
the "supported/" directory. The database structure can be loaded from the
d35 1
a35 1
itself contains a subdirectory called "supported/".
d43 1
a43 1
Download "supported/location.us.inc" to "modules/location/supported/" (for
@


1.3
log
@Adding a little clarification to the INSTALL.txt file.
@
text
@d3 12
a14 21
To use this project, feed the location.mysql to your database.  If your site
is using a prefix for database table names, make sure to adjust accordingly.

  mysql -u username -ppassword -h localhost database-name < modules/location/location.mysql

where "username", "password" are the username/loging and "database-name" are
the parameters to login to your Drupal site's database.  You can leave out
"-h localhost" if your MySQL server runs on the same site as your Apache.
However, replace 'localhost' in "-h localhost" if your MySQL server is on a 
different machine.

IMPORTANT:
To support proximity searches and most useful features, you will need a postal codes
database for each country for which you plan to use a file from the "supported/"
directory. The database structure can be loaded from the database/zipcodes.mysql 
file, and the data can be loaded from database/zipcodes.CC.mysql (where CC is the 
two-letter country code).

As of this post, only U.S. and German postal codes are supported.  A single zipcodes 
table holds all the zipcodes.  To create the zipcodes table using the database/zipcodes.mysql 
file from within the location tarball:
d26 5
a30 2
Feed these dumps to your database as well, adjusting for prefixes.  Careful, the
postal code dump for the US is a few MB.
d34 2
a35 2
In the "modules/" directory, create a subdirectory called "location/" which itself
contains a subdirectory called "supported/".
d38 1
d40 1
d42 3
a44 1
Download "supported/location.us.inc" to "modules/location/supported/" (for support of US locations)
d49 8
a56 4
Visit the settings page for location.module and enable features for U.S. (the only option as of now).
Finally, go to the default workflow settings for each node type and enable (or require location collection
on a field-by-field basis... it is encouraged that you enable postal codes and country fields for node types
for which you want to enable proximity searches.
@


1.3.6.1
log
@Removing obsolete files.  Patch courtesy of 'Darren Oh' in
http://drupal.org/node/30542
@
text
@d3 21
a23 12
To support proximity searches and most useful features, you will need a
postal codes database for each country for which you plan to use a file from
the "supported/" directory. The database structure can be loaded from the
database/zipcodes.mysql file, and the data can be loaded from
database/zipcodes.CC.mysql (where CC is the two-letter country code).

As of this post, only U.S. and German postal codes are supported. A single
zipcodes table holds all the zipcodes. To create the zipcodes table using
the database/zipcodes.mysql file from within the location tarball, feed
these dumps to your database. If your site is using a prefix for database
table names, make sure to adjust accordingly. Careful, the postal code dump
for the US is a few MB.
d35 2
a36 5
where "username", "password" are the username/loging and "database-name" are
the parameters to login to your Drupal site's database. You can leave out
"-h localhost" if your MySQL server runs on the same site as your Apache.
However, replace 'localhost' in "-h localhost" if your MySQL server is on a
different machine.
d40 2
a41 2
In the "modules/" directory, create a subdirectory called "location/" which
itself contains a subdirectory called "supported/".
a43 1

a44 1

d46 1
a46 3

Download "supported/location.us.inc" to "modules/location/supported/" (for
support of US locations)
d51 4
a54 8

Visit the settings page for location.module and enable features for U.S.
(the only option as of now).

Finally, go to the default workflow settings for each node type and enable
(or require) location collection on a field-by-field basis. It is encouraged
that you enable postal codes and country fields for node types for which you
want to enable proximity searches.
@


1.3.4.1
log
@Removing obsolete files.  Patch courtesy of 'Darren Oh' in
http://drupal.org/node/30542
@
text
@d3 21
a23 12
To support proximity searches and most useful features, you will need a
postal codes database for each country for which you plan to use a file from
the "supported/" directory. The database structure can be loaded from the
database/zipcodes.mysql file, and the data can be loaded from
database/zipcodes.CC.mysql (where CC is the two-letter country code).

As of this post, only U.S. and German postal codes are supported. A single
zipcodes table holds all the zipcodes. To create the zipcodes table using
the database/zipcodes.mysql file from within the location tarball, feed
these dumps to your database. If your site is using a prefix for database
table names, make sure to adjust accordingly. Careful, the postal code dump
for the US is a few MB.
d35 2
a36 5
where "username", "password" are the username/loging and "database-name" are
the parameters to login to your Drupal site's database. You can leave out
"-h localhost" if your MySQL server runs on the same site as your Apache.
However, replace 'localhost' in "-h localhost" if your MySQL server is on a
different machine.
d40 2
a41 2
In the "modules/" directory, create a subdirectory called "location/" which
itself contains a subdirectory called "supported/".
a43 1

a44 1

d46 1
a46 3

Download "supported/location.us.inc" to "modules/location/supported/" (for
support of US locations)
d51 4
a54 8

Visit the settings page for location.module and enable features for U.S.
(the only option as of now).

Finally, go to the default workflow settings for each node type and enable
(or require) location collection on a field-by-field basis. It is encouraged
that you enable postal codes and country fields for node types for which you
want to enable proximity searches.
@


1.2
log
@Updating install instruction for more detail.
@
text
@d6 1
a6 1
  mysql -u username -ppassword -h localhost database-name < location.mysql
d17 7
a23 1
directory. 
d25 1
a25 6
As of this post, only U.S. and German postal codes are supported.  However, you will
need a database of postal codes.  A single zipcodes table holds all the
zipcodes.  To create the zipcodes table using the database/zipcodes.mysql file
from within the location tarball:

  mysql -u username -ppassword -h localhost database-name < zipcodes.mysql
d29 1
a29 1
  mysql -u username -ppassword -h localhost database-name < zipcodes.us.mysql
d33 1
a33 1
  mysql -u username -ppassword -h localhoost database-name < zipcodes.de.mysql
d43 4
a46 5
Download "location.inc" to "location/"
Download "location.module" to "location/"
Download "earth.inc" to "location/"
Download "supported/location.us.inc" to "location/supported/"
(NOTE: "supported/location.ca.inc" for Canada is not yet complete).
@


1.1
log
@Project renamed from 'address' to 'location'.
@
text
@d6 8
d19 8
a26 3
As of this post, only U.S. postal codes are supported.  However, you will need a
database of postal codes.  A database dump for a U.S. postal codes table can be
found at http://trac.civicspacelabs.com/cgi-bin/trac.cgi/file/trunk/database/zipcodes.mysql
d28 7
a34 1
Feed this dump to your database as well, adjusting for prefixes.  Careful, the
d52 1
a52 1
Finally, go to the default workflow settings for each node type and enable (or require0 location collection
d56 1
@

