modules/referertools/README.txt

Referertools -- Provides a variety of tools, based on a user's referer

Note: Referer is spelled wrong. Blame whoever put the misspelling in PHP, not
me.

Features:
    * Individual features for each referer
    * Multiple referers for each domain, depending on the complete URL
    * Custom pop up pages (which can be themed uniquely for each referer)
    * Per-referer themeing, to give special themes to special visitors
    
Installation and usage:
    * Go to admin/build/modules
    * Enabled the referertools.module
    * Go to admin/settings/referers
    * Create a new referer
    * Set the options appropriately
    * Click submit and you're done

Referer matching:
Referertools will search the database to find a matching referer based on the 
following patterns:

1. Exact match: If you wish to match a referer URI exactly, prepend the URI with
"http://" or "https://"
    Example: http://www.example.com/foobar
    Matches: http://www.example.com/foobar
    Does not match: http://www.example.com/foobar.html, http://www.example.com/

2. URI hierarchy matching: If you wish to match pages in a directory (or a
complex URI string from another drupal site), remove the protocol from the URL.
    Example: www.example.com/ 
    Matches: www.example.com/foobar, www.example.com/foobar.html,
             www.example.com/
    Does not match: example.com, www2.example.com
    
    Example: www.example.com/foobar
    Matches: www.example.com/foobar, www.example.com/foobar.html,
    Does not match: example.com, www2.example.com, www.example.com
    
3. Domain hierarchy matching: If the first two searches do not return a referer,
the module will use the domain for look ups. To use this matching system, only
include the domain (this is probably what you want for most applications).
    Example: example.com
    Matches: www.example.com/foobar, www.example.com/foobar.html,
             www.example.com/, example.com, www2.example.com
    Does not match: any other domain
    
    Example: .com
    Matches: www.cnn.com, www.ebay.com
    Does not match: www.redcross.org
    
    Example: deep.subdomain.example.com
    Matches: deep.subdomain.example.com/foobar, www.deep.subdomain.example.com
    Does not match: example.com, www2.example.com

To Do:
    * Update .install file for pgsql
    
Caveats:
    * Untested on pgsql
    * You cannot create referers from your $base_url. Sorry. Give me a good use
      case and I'll consider it.
    
Author:
    Mark Fredrickson <mark.m.fredrickson@gmail.com>

1	Referertools -- Provides a variety of tools, based on a user's referer
2
3	Note: Referer is spelled wrong. Blame whoever put the misspelling in PHP, not
4	me.
5
6	Features:
7	* Individual features for each referer
8	* Multiple referers for each domain, depending on the complete URL
9	* Custom pop up pages (which can be themed uniquely for each referer)
10	* Per-referer themeing, to give special themes to special visitors
11
12	Installation and usage:
13	* Go to admin/build/modules
14	* Enabled the referertools.module
15	* Go to admin/settings/referers
16	* Create a new referer
17	* Set the options appropriately
18	* Click submit and you're done
19
20	Referer matching:
21	Referertools will search the database to find a matching referer based on the
22	following patterns:
23
24	1. Exact match: If you wish to match a referer URI exactly, prepend the URI with
25	"http://" or "https://"
26	Example: http://www.example.com/foobar
27	Matches: http://www.example.com/foobar
28	Does not match: http://www.example.com/foobar.html, http://www.example.com/
29
30	2. URI hierarchy matching: If you wish to match pages in a directory (or a
31	complex URI string from another drupal site), remove the protocol from the URL.
32	Example: www.example.com/
33	Matches: www.example.com/foobar, www.example.com/foobar.html,
34	www.example.com/
35	Does not match: example.com, www2.example.com
36
37	Example: www.example.com/foobar
38	Matches: www.example.com/foobar, www.example.com/foobar.html,
39	Does not match: example.com, www2.example.com, www.example.com
40
41	3. Domain hierarchy matching: If the first two searches do not return a referer,
42	the module will use the domain for look ups. To use this matching system, only
43	include the domain (this is probably what you want for most applications).
44	Example: example.com
45	Matches: www.example.com/foobar, www.example.com/foobar.html,
46	www.example.com/, example.com, www2.example.com
47	Does not match: any other domain
48
49	Example: .com
50	Matches: www.cnn.com, www.ebay.com
51	Does not match: www.redcross.org
52
53	Example: deep.subdomain.example.com
54	Matches: deep.subdomain.example.com/foobar, www.deep.subdomain.example.com
55	Does not match: example.com, www2.example.com
56
57	To Do:
58	* Update .install file for pgsql
59
60	Caveats:
61	* Untested on pgsql
62	* You cannot create referers from your $base_url. Sorry. Give me a good use
63	case and I'll consider it.
64
65	Author:
66	Mark Fredrickson <mark.m.fredrickson@gmail.com>
67