Advanced inclusion of Smart Code and Custom URLs
================================================

The filters provided by this module can be used to limit which pages do and do
not get the VWO Smart Code added to them. They are however quite simple, and
only provide a single global Custom URL.

You probably have a much better way of calculating which pages the code should
be included than this module could supply. For that reason, the inclusion of
the Smart Code can be goverened by a small custom module based on the template
in this directory.

The VWO system also includes URL fitlers, which can also be limiting. For that
reason, Custom URLs are an option. Any page, regardless of its real URL can
report to VWO a compeltely different, possibly fake one.

For more details on Custom URLs, please read the blog entry on the subject:
  https://vwo.com/blog/custom-urls-ab-multivariate-tests/

nota bene
---------

The Smart Code will only ever be added once to a page, with the first Custom
URL given.

To ensure that your custom module is the only one attempting to add the code,
you should disable the automatic filtering by setting "Enable Visual Website
Optimizer" to "Disabled".

The Smart Code Checker provided on VWO website may not pick up that the VWO
javascript has been added to the site.

Using this example as a starting point
--------------------------------------

1.  Choose a machine name for your module. It should not clash with any themes
or existing d.o modules. eg. If your name was Paul, vwo_paul_filter. We will
call it EXAMPLE from now on.

2.  Make a directory in one of the module directories listed below, in order
of most specific to least:
    * sites/<sitedir>/modules/EXAMPLE
    * sites/default/modules/EXAMPLE
    * sites/all/modules/EXAMPLE

3.  Copy the two example files here to your module directory, and remove the
.txt extension from the end.
    * vwoexample.info.txt -> <moduledir>/EXAMPLE.info
    * vwoexample.module.txt -> <moduledir>/EXAMPLE.module

4.  Check your module isn't called EXAMPLE.module, but rather something like
vwo_paul_filter.module as we chose earlier.

5.  Edit EXAMPLE.module and replace all instances of "EXAMPLE" with the
machine name chosen for the module eg. vwo_paul_filter.

6.  Edit EXAMPLE.module to include the Smart Code on whatever pages you desire
with whatever Custom URL (or not).

7.  Enable the module and ensure it is adding Smart Code were expected.

