Heise Shariff

Heise Shariff

Classification

rx_shariff

Version

6.0

Language

en

Description

The rx_shariff extension provides easy integration of Heise Shariff into TYPO3 CMS and includes the frontend scripts as well as the PHP data backend to retrieve social media stats.

Keywords

Social Media, JavaScript, GooglePlus, Twitter, Facebook, LinkedIn, Reddit, StumbleUpon, Flattr, Pinterest, Xing

Copyright

Reelworx GmbH

Author

Markus Klein

Email

support@reelworx.at

License

This document is published under the Open Content License available from http://www.opencontent.org/opl.shtml

Rendered

Mon, 12 May 2025 14:55:41 +0000

The content of this document is related to TYPO3, a GNU/GPL CMS/Framework available from www.typo3.org.

Table of Contents

What does it do?

This extension provides a ready-to-use integration of the social media buttons of Heise Shariff. The focus of these buttons is to provide more privacy for the website visitor.

Shariff Screenshot

More information about Shariff in general can be found here: https://github.com/heiseonline/shariff

Provided components

This extension ships the frontend part of Shariff, which comprises the CSS and JS to render the buttons, as well as the backend part, which allows to fetch the current stats of a social media provider (like count).

For easy integration a Fluid viewhelper is provided, which makes integration into Fluid templates a piece of cake. Editors can use the provided plugin, to conveniently place the social media buttons on page.

Technically, the backend part is implemented by using a TYPO3 eID script, whose data is loaded by a JS AJAX request of the frontend part. The retrieved count values are stored in the TYPO3 cache.

The extension is based on shariff (version 1.23.0) and shariff-backend-php (version 5.0.0).

Installation

Install the extension via Extension Manager as usual.

The provided Javascript requires jQuery to be loaded. You have to take care of this on your own. The example below shows that too.

Configuration

You can configure the extension in the Extension Manager. It allows to set most of the options for the backend module as documented here: https://github.com/heiseonline/shariff-backend-php

JavaScript and CSS integration

The extension also ships the Frontend Javascript and default styles of Shariff. You can simple add one of the four available static templates:

  • Shariff: Include Shariff and jQuery
  • Shariff: Include Shariff, font-awesome and jQuery
  • Shariff: Include Shariff without jQuery
  • Shariff: Include Shariff, font-awesome without jQuery

jQuery is included by using the local jQuery version shipped with the TYPO3 CMS Core.

If you want, you can also simply integrate them manually in your own page template:

page = PAGE

page.javascriptLibs.jQuery = 1
page.javascriptLibs.jQuery.version = latest
page.javascriptLibs.jQuery.source = local

page.includeJSFooter.shariff = EXT:rx_shariff/Resources/Public/Css/shariff.min.js
page.includeCSS.shariff = EXT:rx_shariff/Resources/Public/Css/shariff.min.css
# or you may use the following for include font-awesome too
# page.includeCSS.shariff = EXT:rx_shariff/Resources/Public/Css/shariff.complete.css
Copied!

Frontend usage

The extension provides multiple ways to use Shariff in frontend.

Pure TypoScript

For TypoScript usage, the extension provides a default typolink setup to generate the necessary backend-url. The setup can be used like this:

lib.shariffBackendUrl < plugin.rx_shariff.data-backend-url
Copied!

Fluid viewhelper

Additionally the extension provides a Fluid viewhelper to easily integrate Shariff into your HTML template.

<div xmlns:rx="http://typo3.org/ns/Reelworx/RxShariff/ViewHelper">
	<rx:shariff data="{url: 'http://example.com/'}" services="whatsapp,facebook" enableBackend="true" />
</div>
Copied!

Optionally you can define all data attributes available for Shariff.

Example usages can be found here: http://heiseonline.github.io/shariff/

Frontend plugin

Simply add a new content element to a page and select the "Shariff Social Icons" plugin. Adjust the configuration as needed.

Nice to know

News integration

You can also easily use this extension within your News extension template. Simply paste the viewhelper into your Detail.html template, include one of the static templates and you are ready to go.

Support and Contributing

Known issues

None, at the moment.

Support

Support questions are usually answered in the official TYPO3 channels. That is the English mailinglist/forum and the typo3-cms Slack channel.

In case of errors check the log fies in typo3temp/logs/ for more details.

Bug reports

Please get in touch first if you think you found a bug, so we can check together.

The issue tracker can be found at https://forge.typo3.org/projects/extension-rx_shariff

Coding

Contributions and ideas are very welcome.

The contribution workflow follows the Core rules and therefore uses Gerrit: https://review.typo3.org/

Git repository: https://git.typo3.org/TYPO3CMS/Extensions/rx_shariff.git

To clone your copy consider using the awesome Gerrit-Git-Helper: http://www.wwwision.de/githelper/#TYPO3CMS/Extensions/rx_shariff.git

Change Log

Version 6.0.0

  • Updated shariff-backend to version 5.0.0
  • Attention: PHP support is now 5.5 - 7.0

Version 5.2.0

  • Updated shariff to version 1.23.0

Version 5.1.1

  • Fix URL encoding of Facebook again

Version 5.1.0

  • Updated shariff to version 1.22.0
  • Updated to shariff-backend version 3.0.1
  • Fix URL encoding issues for some stat providers

Version 5.0.2

  • Fix PHP syntax error in PHP <= 5.4

Version 5.0.1

  • Fix various issues with FlexForms

Version 5.0.0

  • Updated to shariff-backend version 2.0.0
  • Removed Twitter support for backend due to termination of the API by Twitter.

Version 4.1.0

  • Updated shariff to version 1.21.0
  • PSR-7 compliant eID handling for CMS 7

Version 4.0.0

  • Breaking: Stylesheets have been moved to new Public/Css directory
  • Updated shariff to version 1.20.0
  • Updated shariff-php to version 1.6.0

Version 3.0.0

  • Breaking: Javascript is included as normal footer JS and not as footer lib
  • Updated shariff to version 1.18.0

Version 2.4.0

  • Updated shariff to version 1.17.1

Version 2.3.0

  • Declare compatibility with CMS 7.4
  • Add composer.json
  • Updated shariff to version 1.16.0

Version 2.2.0

  • Updated shariff to version 1.15.0

Version 2.1.0

  • Regression fix: Use guzzle 5.3 (6.0 slipped in by accident)
  • Updated shariff to version 1.14.0

Version 2.0.0

  • Update shariff backend to version 1.5.0
  • Use native TYPO3 caching framework instead of bundled one
  • Add Frontend plugin with FlexForms configuration

Version 1.8.0

  • Added static TypoScript templates
  • New "services" attribute for the viewhelper to ease syntax

Version 1.7.0

  • Update shariff JS to version 1.13.0

Version 1.6.0

  • Update shariff JS to version 1.12.0

Version 1.5.1

  • Removes wrong information from the documentation

Version 1.5

  • Update shariff JS to version 1.11.0
  • Improved documentation
  • TYPO3 CMS 7.2 support

Version 1.4

  • Update shariff JS to version 1.10.0

Version 1.3

  • Update shariff JS to version 1.9.3

Version 1.2

  • Update shariff JS to version 1.8.0

Version 1.1

  • Important bugfix for viewhelper
  • Update shariff JS to version 1.7.4 (fixes IE problems)

Version 1.0

Initial release