ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / 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](http://git.recluse.de/?p=users/bzed/ikiwiki.git;a=blob;f=IkiWiki/Plugin/tracking.pm;hb=refs/heads/tracking) [piwik.tmpl](http://git.recluse.de/?p=users/bzed/ikiwiki.git;a=blob;f=templates/piwik.tmpl;hb=refs/heads/tracking) [google_analytics.tmpl](http://git.recluse.de/?p=users/bzed/ikiwiki.git;a=blob;f=templates/google_analytics.tmpl;hb=refs/heads/tracking)
29 * browse repository: <http://git.recluse.de/?p=users/bzed/ikiwiki.git;a=shortlog;h=refs/heads/tracking>
30 * git repo: `git://git.recluse.de/users/bzed/ikiwiki.git` or <http://git.recluse.de/repos/users/bzed/ikiwiki.git> (Use the tracking branch)