doc/plugins/contrib/tracking.mdwn

   1 [[!template id=plugin name=tracking author="[[BerndZeimetz]]"]]
   2 [[!toc]]
   3 [[!tag plugins]] [[!tag patch]] [[!tag wishlist]]
   4
   5 ## NAME
   6
   7 IkiWiki::Plugin::tracking - enable google/piwik visitor tracking
   8
   9 ## SYNOPSIS
  10
  11     # activate the plugin
  12     add_plugins => [qw{goodstuff tracking ....}],
  13
  14     # to use Piwik:
  15     piwik_id => '1',
  16     piwik_https_url => "https://ssl.example.com/piwik/",
  17     piwik_http_url => "http://www.example.com/piwik/",
  18
  19     # to use Google Analytics:
  20     google_analytics_id => "UA-xxxxxx-x"
  21
  22 ## DESCRIPTION
  23
  24 This plugin includes the necessary tracking codes for Piwik and/or Google Analytics on all pages. Tracking codes will only be included if the necessary config options are set. The plugin could be enhanced to support goals/profiles and similar things, but I do not plan to do so.
  25
  26 ## DOWNLOAD
  27
  28 * single files: [tracking.pm](https://git.bzed.at/raw/~bzed/ikiwiki.git/tracking/IkiWiki!Plugin!tracking.pm) [piwik.tmpl](https://git.bzed.at/raw/~bzed/ikiwiki.git/tracking/templates!piwik.tmpl) [google_analytics.tmpl](https://git.bzed.at/raw/~bzed/ikiwiki.git/tracking/templates!google_analytics.tmpl)
  29 * browse repository: <https://git.bzed.at/tree/~bzed%2Fikiwiki.git/tracking>
  30 * git repo: `git://git.bzed.at/~bzed/ikiwiki.git` or <https://git.bzed.at/r/~bzed/ikiwiki.git> (Use the tracking branch)