Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Minor changes

  • Loading branch information...
commit 0171831c9e33b1d58c2dfe7ca2f1b4b7627b7e2e 1 parent 3bbd1b2
Nils Diewald authored

Showing 3 changed files with 30 additions and 19 deletions. Show diff stats Hide diff stats

  1. +3 0  Changes
  2. +13 9 Readme.pod
  3. +14 10 lib/Mojolicious/Plugin/Piwik.pm
3  Changes
... ... @@ -1,3 +1,6 @@
  1 +0.10 2013-03-03
  2 + - Improve documentation.
  3 +
1 4 0.09 2013-03-01
2 5 - Update year.
3 6 - Update comments.
22 Readme.pod
Source Rendered
@@ -103,12 +103,13 @@ instance. Defaults to the site id and the url given when the plugin
103 103 was registered.
104 104
105 105 This tag should be included at the bottom
106   -of the body tag of your website.
  106 +of the body tag of each website you want to analyse.
107 107
108 108 %= piwik_tag 'opt-out', width => 400
109 109
110   -The special C<opt-out> tag renders an iframe helping
111   -your visitors to disallow tracking via javascript.
  110 +The special C<opt-out> tag renders an
  111 +L<iframe|http://piwik.org/privacy/#toc-step-3-include-a-web-analytics-opt-out-feature-on-your-site-using-an-iframe>
  112 +helping your visitors to disallow tracking via javascript.
112 113 See the L<default tag helper|Mojolicious::Plugin::TagHelpers/tag>
113 114 for explanation of usage.
114 115
@@ -169,9 +170,10 @@ The ip address is not forwarded.
169 170 });
170 171
171 172 As the C<url> parameter is used to define the Piwik instance,
172   -the url of the requested resource to be named C<action_url>.
  173 +the url of the requested resource has to be named C<action_url>.
173 174
174   -Please remember that cookie-based opt-out can't be supported.
  175 +Please remember that cookie-based opt-out can't be supported
  176 +for the non-javascript Tracking API.
175 177
176 178 In addition to the parameters of the API references, the following
177 179 parameters are allowed:
@@ -209,15 +211,16 @@ for example C<idSite> (for analysis), C<date> (for ranges) and C<res> (for track
209 211 });
210 212
211 213 In case of an error, C<piwik_api> tries to response with a meaningsful
212   -descriptin in the hash value of C<error>.
  214 +description in the hash value of C<error>.
213 215 If an image is expected instead of a JSON object
214 216 (as for the Tracking or the C<ImageGraph> API), the image is base64
215   -encoded and mime-type prefixed in the hash value of image.
  217 +encoded and mime-type prefixed in the hash value of C<image>,
  218 +ready to be embedded as the C<src> of an C<E<lt>img /E<gt> tag.
216 219
217 220
218 221 =head1 LIMITATIONS
219 222
220   -The plugin lacks support for eCommerce tracking.
  223 +The plugin currently lacks support for eCommerce tracking.
221 224
222 225
223 226 =head1 TESTING
@@ -234,7 +237,7 @@ and run C<make test>, for example:
234 237 action_name => 'Märchen/Test'
235 238 };
236 239
237   -The user agent to be ignored is called C<Mojo-Test>.
  240 +The user agent to be ignored in your Piwik instance is called C<Mojo-Test>.
238 241
239 242
240 243 =head1 DEPENDENCIES
@@ -257,6 +260,7 @@ and/or modify it under the same terms as Perl.
257 260 Please make sure you are using Piwik in compliance to the law.
258 261 For german users,
259 262 L<this information|https://www.datenschutzzentrum.de/tracking/piwik/>
  263 +[last accessed on 2013-03-03]
260 264 may help you to design your service correctly.
261 265
262 266 This plugin was developed for
24 lib/Mojolicious/Plugin/Piwik.pm
@@ -3,7 +3,7 @@ use Mojo::Base 'Mojolicious::Plugin';
3 3 use Mojo::ByteStream 'b';
4 4 use Mojo::UserAgent;
5 5
6   -our $VERSION = '0.09';
  6 +our $VERSION = '0.10';
7 7
8 8 # Todo:
9 9 # - Better test tracking API support
@@ -408,12 +408,13 @@ instance. Defaults to the site id and the url given when the plugin
408 408 was registered.
409 409
410 410 This tag should be included at the bottom
411   -of the body tag of your website.
  411 +of the body tag of each website you want to analyse.
412 412
413 413 %= piwik_tag 'opt-out', width => 400
414 414
415   -The special C<opt-out> tag renders an iframe helping
416   -your visitors to disallow tracking via javascript.
  415 +The special C<opt-out> tag renders an
  416 +L<iframe|http://piwik.org/privacy/#toc-step-3-include-a-web-analytics-opt-out-feature-on-your-site-using-an-iframe>
  417 +helping your visitors to disallow tracking via javascript.
417 418 See the L<default tag helper|Mojolicious::Plugin::TagHelpers/tag>
418 419 for explanation of usage.
419 420
@@ -474,9 +475,10 @@ The ip address is not forwarded.
474 475 });
475 476
476 477 As the C<url> parameter is used to define the Piwik instance,
477   -the url of the requested resource to be named C<action_url>.
  478 +the url of the requested resource has to be named C<action_url>.
478 479
479   -Please remember that cookie-based opt-out can't be supported.
  480 +Please remember that cookie-based opt-out can't be supported
  481 +for the non-javascript Tracking API.
480 482
481 483 In addition to the parameters of the API references, the following
482 484 parameters are allowed:
@@ -514,15 +516,16 @@ for example C<idSite> (for analysis), C<date> (for ranges) and C<res> (for track
514 516 });
515 517
516 518 In case of an error, C<piwik_api> tries to response with a meaningsful
517   -descriptin in the hash value of C<error>.
  519 +description in the hash value of C<error>.
518 520 If an image is expected instead of a JSON object
519 521 (as for the Tracking or the C<ImageGraph> API), the image is base64
520   -encoded and mime-type prefixed in the hash value of image.
  522 +encoded and mime-type prefixed in the hash value of C<image>,
  523 +ready to be embedded as the C<src> of an C<E<lt>img /E<gt> tag.
521 524
522 525
523 526 =head1 LIMITATIONS
524 527
525   -The plugin lacks support for eCommerce tracking.
  528 +The plugin currently lacks support for eCommerce tracking.
526 529
527 530
528 531 =head1 TESTING
@@ -539,7 +542,7 @@ and run C<make test>, for example:
539 542 action_name => 'Märchen/Test'
540 543 };
541 544
542   -The user agent to be ignored is called C<Mojo-Test>.
  545 +The user agent to be ignored in your Piwik instance is called C<Mojo-Test>.
543 546
544 547
545 548 =head1 DEPENDENCIES
@@ -562,6 +565,7 @@ and/or modify it under the same terms as Perl.
562 565 Please make sure you are using Piwik in compliance to the law.
563 566 For german users,
564 567 L<this information|https://www.datenschutzzentrum.de/tracking/piwik/>
  568 +[last accessed on 2013-03-03]
565 569 may help you to design your service correctly.
566 570
567 571 This plugin was developed for

0 comments on commit 0171831

Please sign in to comment.
Something went wrong with that request. Please try again.