Socialshareprivacy_XH - a CMSimple_XH Plugin

Socialshareprivacy_XH facilitates to have Facebook, Twitter and Google+ buttons on your website without violating your visitor's privacy. Before any data are transmitted to Facebook, Twitter resp. Google+, the visitor has to agree explicitely. This plugin is only a wrapper around the jQuery plugin socialshareprivacy, which is developed by Heise Zeitschriften Verlag GmbH & Co. KG. Socialshareprivacy_XH doesn't provide any additional features, but is merely meant as a simple way to use and configure the jQuery plugin without the need to mess around in JavaScript files.

Please do read this documentation before you encounter any problems!

Important Notice

Socialshareprivacy_XH couldn't be tested so far in various environments. It is a so called release candidate. Use with caution!

Requirements

Socialshareprivacy_XH is a plugin for CMSimple_XH. It requires a UTF-8 encoded version and jQuery4CMSimple, which is already bundled with CMSimple_XH since version 1.4.1.

Installation

The installation is done as with many other CMSimple_XH plugins. See the CMSimple_XH wiki for further details.

  1. Backup the data on your server.
  2. Unzip the distribution on your computer.
  3. Upload the whole directory socialshareprivacy/ to your server into CMSimple_XH's plugins directory.
  4. Set write permissions to the subdirectories config/, css/, js/ and languages/.
  5. Switch to "Socialshareprivacy" in the back-end to check if all requirements are fulfilled.

Settings

The plugin's configuration is done as with many other CMSimple_XH plugins in the website's back-end. Select "Socialshareprivacy" from "Plugins".

You can change the default settings of Socialshareprivacy_XH in "Config". Hints for the options will be displayed when hovering over the help icon with your mouse.

Localization is done in "Language". You can translate the character strings to your own language, or customize them according to your needs.

The look of the Socialshareprivacy_XH can be customized in "Stylesheet".

Usage

To display the social buttons on a page or in a newsbox (the latter is possible since CMSimple_XH 1.5) insert:

{{{PLUGIN:socialshareprivacy();}}}

To display the social buttons on every page insert into your template:

<?php echo socialshareprivacy();?>

In this case it's necessary to activate "template call" in the configuration.

Note that the likes, tweets and shares refer to the currently displayed page, including all additional query parameters, i.e. what is shown in the browser's address bar. If a canonical link is contained in the (X)HTML, this will be used, however.

Limitations

The plugin requires JavaScript to be enabled in the visitor's browser; otherwise nothing will be displayed. Actually this is not really a limitation, as liking, tweeting and sharing requires JavaScript to be enabled anyway.

In old browsers which doesn't implement the JSON object (e.g. IE 7 and before), the possibility to permanently activate the buttons is not available. In browsers which doesn't understand the value "inline-block" for the "display" declaration (e.g. IE 7 and before), the layout is broken. Despite these limitations the plugin is still usable on IE 6 and 7.

License

Socialshareprivacy_XH is licensed under GPLv3.

© 2012 Christoph M. Becker

Slovak translation © 2012 Dr. Martin Sereday

Credits

Socialshareprivacy_XH is powered by socialshareprivacy. Many thanks to Heise Zeitschriften Verlag GmbH & Co. KG for releasing it under MIT license. And of course many thanks to Christian for pointing me to socialshareprivacy.

This plugin uses free applications icons from Aha-Soft. Many thanks for making these icons freely available.

And last but not least many thanks to Peter Harteg, the "father" of CMSimple, and all developers of CMSimple_XH without whom this amazing CMS wouldn't exist.