====== Referrers for DokuWiki ======
**Note** Bugs, feature requests, etc have moved to the discussion page for the project.

===== License =====

  * **License**: [[http://www.opensource.org/licenses/gpl-license.php|GNU GPL v2]].

It's not required, but please consider linking to [[referrers_for_dokuwiki|this page]] or the main page from your site if you like this product.


===== Download =====
Before downloading or using this product, make sure you __**understand and accept**__ the terms of the [[#license]].

After downloading, make sure to follow the [[#install]] instructions or [[#upgrading]] instructions below.

  * This is the latest version, compatible with The Latest DokuWiki:
    * Latest Version: {{:projects:referrers-04292007.zip|Referrers for Dokuwiki - April 29, 2007}}
  * These are older, unsupported versions, compatibility is not guaranteed:
    * Previous Version: <del>{{:projects:referrers-09032006.zip|Referrers for Dokuwiki - September 3, 2006}}</del>
  * Older downloads are available on request only.


===== About =====

This plugin logs referrers for your site, so you can see where your traffic comes from. The log will be located at **wiki:referrers**, so you will need to create that page for this plugin to work.

Currently the superuser will not be logged, along with some search engines and some referrer spammers. This will all be configurable in a future release.

The plugin also exports a function for use with your template, so you will have to insert the following code into your template, somewhere inside of the **<head></head>** tags.

Typically you'll want to do this for any PHP (or HTML) files containing the string "<head>"; at a minimum you can do just main.php.((If you only do main.php though you'll miss some hits to certain types of pages, so I suggest searching for head tags through all the php files in a template to make sure you get them all.))

<code php>
<?php
if (file_exists(DOKU_PLUGIN.'referrers/code.php')) include_once(DOKU_PLUGIN.'referrers/code.php');
if (function_exists('re_log_referrers')) re_log_referrers();
?>
</code>

**Note**: Inserting the code above is **required**, not optional.

**Template Authors Note**: You can insert the above code and make your template "Referrers Ready", even if your users do not use Referrers for DokuWiki (or have this plugin.)

===== Install =====

As a plugin all you need to do is unpack the file into the lib/plugins/ directory (you should end up with a lib/plugins/referrers folder.)

Remember to create a page in the **wiki** namespace called **referrers**.

===== Upgrading =====

To upgrade, remove the original lib/plugins/referrers folder, and install the new version as instructed above. You may wish to make a note of your settings first though.

===== What's New =====

==== April 29, 2007 ====
  * More referrer spam blocking is in place.
  * Better support for not logging spiders and search engines.
  * Non-standard browser/client IDs will also get logged.

==== September 3, 2006 ====
  * Initial release