Guide: Tallytoo-Wall for WordPress
Features
The Tallytoo-Wall plugin for WordPress integrates the tallytoo monetisation flow into your website.
Using this plugin, you can choose to monetise your content in three different ways:
- A paywall: this option replaces your content tagged with the shortcode tallytoo-paywall with a paywall that includes the tallytoo button. To access the content, the user must spend a tallytoo point. If the user has no points, the tallytoo overlay will appear allowing the user to earn some points.
Adding a tallytoo paywall to your content using a shortcode The resulting paywall that is created in the place of your content. - A donate-wall: this option looks like a paywall, but your users can choose to skip the payment. You can use the tallytoo-donatewall shortcode.
Adding a tallytoo donate-wall to your content using a shortcode The resulting donate-wall that is created in the place of your content. Note the link allowing the user to skip the donation. - A donation request: This option allows you to simply add a request for donation at the beginning, the in middle, or at the end of your content, using the tallytoo-donate shortcode. This option does not lock your content.
Adding a tallytoo donate request to your content using a shortcode The resulting donation request that is created in your content.
You can place short-codes wherever you wish, in pages or posts. You decide which content to monetise using a paywall, or just by donation, with the flexibility to combine all three solutions on the same website.
Installation
Before you can start using the Tallytoo-Wall plugin you need to create a publisher account. For more information you can follow this step-by-step guide.
Download and install the Tallytoo-Wall WordPress plugin
The tallytoo-wall plugin is an open-source project that adds the tallytoo button to your WordPress site. Click here for the latest Tallytoo-Wall release.
Click on the Source Code (zip) link in order to download the WordPress package.
Log in to your WordPress website admin console.
Go to Plugins → Add new → Upload Plugin, and choose the .zip file you downloaded in the previous step.
Once the plugin is installed, click Activate to activate the tallytoo-wall plugin. A new tallytoo menu will appear in your admin console.
Register your plugin
The first thing you need to do is go to the Registration menu, and paste the API key that you created in the tallytoo publisher console into the field “Publisher API key”. Hit Save Settings.
If your configuration is set up correctly, you can now go to the Paywall menu, and the tallytoo button will appear in the default paywall template:
If you do not see the blue tallytoo button, you can open the JavaScript console to see what might have gone wrong:
Configure your paywall, your donate-wall or your donation request
The Paywall, Donate-wall, or Donate-inline menus allow you to totally customise the paywall, with the message you wish to use to incite your readers to pay or donate, as well as specify the theming of your paywall. Update the html and css, click Save Settings and check how your new paywall appears in the preview.
Where indicated, you need to keep the [tallysection], [tallybutton] or [tallyskip] codes, since the tallytoo-wall plugin will replace these with the correct code for adding the tallytoo button.
The tallytoo button is loaded in an iframe where the [tallybutton] code is found. The button is fully responsive and will expand to the size of the element you give to it.
Since the tallytoo button is loaded in an iframe, you cannot style it directly using css. However, you have full control over its features, as explained in the next section.
Configure the tallytoo-button
The Appearance menu allows you to customise all visual aspects of the tallytoo button, with the exception of:
- The tallytoo logo: this is unmodifiable, since the tallytoo brand is essential to the user-trust in our system and the attribution and spending of points
- The text on the button: which is modified according to the current state of the user account. This text is available in English or French, and is automatically selected based on the user’s browser settings.
Hit Save Settings to view your changes to the tallytoo button.
Test your wall
Before activating the tallytoo features on your website, we recommend that you test the integration so that you can confirm that the paywall appears correctly on your site, and integrates seamlessly with your theme.
To do this, start by creating a page or post, and changing the Visibility of your page or post to Private. Now only you, the admin, can see that page. This is the perfect playground for testing the button. Add a bunch of content!
The tallytoo-wall plugin adds four icons to the Visual Editor as well as the Text Editor :
Select a block of text, and click one of these buttons.
Your text will be wrapped in the correct shortcode for creating a pay-wall, a donate-wall, or a donation request.
The plugin also provides a fourth shortcode that will add a fade effect to the selected block (use this on the paragraph preceding a paywall, for example). Note: this fade effect is styled with the class .tt-fadeover in the Paywall, Donate-wall or Donate menus.
Currently, if you preview your test page, the paywall will appear, but not the tallytoo button. This is because your publisher account is still deactivated. You can either activate your account directly, or first do some tests using a test user.
Test using test users (optional)
Note: this process works in Firefox and Chrome, but has limited functionality in Safari.
Before activating tallytoo on your site, we can test the entire user flow, from viewing the button, to earning points, to spending points and accessing your content.
To do this, leave your account the the Inactive state for now, and head to the Test Users menu.
A test user can be created that either has points, or has zero points. This user will exist for approximately 3 hours before being deactivated (or you can delete it when you are done). All point earning and point spending will not be recorded.
Make sure you are in the same navigator as your WordPress Test page.
Click on Impersonate of the user you wish to log in as. You will be taken to the login page, where you must enter the password shown in the control panel.
If you refresh your Test page, the tallytoo button will appear.
If you logged in as a test user with points, you can click the tallytoo button, which will test spending a point and unlocking your content.
If you logged in as a test user with points, you can click the tallytoo button, which should open a full-screen overlay, in which a test advert will appear.
Click on Earn a point to simulate earning a point. You can close the overlay, and then test spending this point to unlock your content.
Please verify that the tallytoo overlay totally covers the elements in your page. If certain elements appear on top, you can increase the z-index value of the overlay in the Registration menu of the Tallytoo-Wall plugin in WordPress.
Activate tallytoo on your website
Return to the tallytoo publisher control panel. On the left menu, select your publisher name, and then click the Activate button.
Best effort
The Tallytoo-Wall WordPress plugin is a best-effort system, meaning that the paywall, donate-wall or donate request will only appear if a monetisation option exists for the current user. For the paywall to appear:
- The user must already have sufficient points to pay for the content OR
- There must be an ad in the tallytoo inventory that allows the user to earn some points
If neither of these conditions are true, by default, the paywall, donate-wall, or donate-request will not appear.
You can choose to lock your user out by un-checking the option Allow free access in the Registration menu of the Tallytoo-Wall plugin.