Description

ProLitteris remunerates authors and publishers in Switzerland and Liechtenstein for texts published online (“Onlinewerke entschädigen”, also called “Verteilung Online”). Views are counted with a counting pixel on each text, and the publisher reports the texts to ProLitteris.

This plugin does both from within WordPress:

fetches counting pixels from ProLitteris and keeps a pool of unassigned ones
assigns a pixel to each post and renders it on the page, in the paywall variant if you tell it a post is behind a paywall
builds the report from the post: title, plain text, authors and image originators with their ProLitteris member numbers
reports posts from the block editor sidebar, or automatically every hour
shows in the posts list which posts are reported, ready to report or too short
adds the ProLitteris member number and name to user profiles, and an image originator to media files

You need a contract with ProLitteris for “Onlinewerke entschädigen” and the API credentials of your ProLitteris account. This plugin is not affiliated with or endorsed by ProLitteris.

Developers

Filters and actions, for example to enable more post types, add co-authors or prevent pixels on certain posts, are documented in the repository on GitHub.

External services

This plugin connects to the web service of ProLitteris (“OWEN”, https://owen.prolitteris.ch), which is needed to take part in “Onlinewerke entschädigen”. Nothing is sent before the integration is enabled and the credentials are entered.

Fetching counting pixels: every hour, and when an editor refills the pool from the dashboard, the plugin requests as many new counting pixels as are missing from the pool. The request carries your ProLitteris credentials.
Reporting a text: when a post is reported, from the block editor or automatically, the plugin sends its title, its plain text, its counting pixel and, for every author and image originator, the ProLitteris member number, first name, last name and WordPress user id.
Counting views: every post with a counting pixel embeds an image loaded from a ProLitteris server (*.owen.prolitteris.ch). The visitor’s browser loads it, transmitting the visitor’s IP address, the page address and browser information. ProLitteris has the views counted by Kantar GmbH using the Scalable Central Measurement Method (SZM).

The service is provided by ProLitteris, Swiss Copyright Society for Literature and Visual Art, Zurich: terms of use, privacy policy. The plugin suggests a paragraph for your own privacy policy under Settings Privacy.

Screenshots

The ProLitteris sidebar in the block editor: the post's counting pixel and the report with its text, authors and image originators, ready to be sent. — The ProLitteris sidebar in the block editor: the post’s counting pixel and the report with its text, authors and image originators, ready to be sent.

The ProLitteris column in the posts list shows which posts are reported, ready to report or too short. — The ProLitteris sidebar in the block editor: the post’s counting pixel and the report with its text, authors and image originators, ready to be sent.

Installation

Install the plugin through the “Plugins” screen in WordPress, or upload the palasthotel-integration-for-prolitteris folder to /wp-content/plugins/.
Activate it.
Go to Settings ProLitteris, enable the integration and enter your member number, username and password.
Enter the ProLitteris member number and name of each author on their user profile.

The connection can also be configured in wp-config.php, which takes precedence over the settings page:

define( 'PRO_LITTERIS_ENABLED', true );
define( 'PRO_LITTERIS_SYSTEM', 'https://owen.prolitteris.ch' );
define( 'PRO_LITTERIS_CREDENTIALS', 'member number:username:password' );
define( 'PRO_LITTERIS_AUTO_MESSAGES', true );

FAQ

Which posts get a pixel?: Posts of the post type post. More post types can be added with the pro_litteris_post_types filter.
Why can a post not be reported?: ProLitteris only remunerates texts with at least 1500 characters, and every author needs a ProLitteris member number and a first and last name on their profile. Hover the icon in the ProLitteris column of the posts list to see the reason.
What happened to the plugin “ProLitteris” (pro-litteris)?: It is this plugin. Up to version 1.6.4 it was only available on GitHub, installed in the folder pro-litteris. Since 2.0.0 it has a new name, folder and text domain and is published on wordpress.org: deactivate the old plugin before activating this one. Pixels, reports and settings are kept, they are stored in the database. If you configured it in wp-config.php, rename the constants: PH_PRO_LITTERIS to PRO_LITTERIS_ENABLED, PH_PRO_LITTERIS_SYSTEM to PRO_LITTERIS_SYSTEM and PH_PRO_LITTERIS_CREDENTIALS to PRO_LITTERIS_CREDENTIALS; the old names are no longer read. PRO_LITTERIS_AUTO_MESSAGES stays as it is.

Reviews

There are no reviews for this plugin.

Contributors & Developers

“Palasthotel Integration for ProLitteris” is open source software. The following people have contributed to this plugin.

Translate “Palasthotel Integration for ProLitteris” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

2.1.1

Bug Fixes
* name the dashboard widget ProLitteris like the rest of the plugin (2d44cd0)
* report automatically and list on the dashboard only posts with the minimum length (7e65f5c)

2.1.0

⚠ BREAKING CHANGES
* the plugin folder, main file and text domain are now palasthotel-integration-for-prolitteris. Installs of 2.0.0 (folder integration-for-prolitteris) have to deactivate it and install this one; pixels, reports and settings are kept.

Features
* get translations from translate.wordpress.org, translate the editor sidebar (98495c0)
* rename to “Palasthotel Integration for ProLitteris” (ab4ea39)

Bug Fixes
* address the wordpress.org review (pixels only when enabled, admin notices, translations) (c2b47c2)
* render and assign counting pixels only with the integration enabled (fcdc4bd)
* show the plugin’s admin notices to administrators only, on the plugins screen and dashboard (4789515)

Miscellaneous
* release 2.1.0 (e471a85)

2.0.1

Bug Fixes
* declare Tested up to only in readme.txt (d86c8b5)
* declare Tested up to only in readme.txt (bf68c6e)

2.0.0

⚠ BREAKING CHANGES
* PALASTHOTEL_COMPOSER_CENTRAL, the palasthotel/central_autoloader_loaded action and PH_CENTRAL_AUTOLOADER_DEBUG no longer have any effect. Install the plugin from wordpress.org (or wpackagist-plugin/integration-for-prolitteris) instead of from the Git repository.
* rename the constants in wp-config.php, the old names are no longer read and the integration stays off without them: PH_PRO_LITTERIS PRO_LITTERIS_ENABLED, PH_PRO_LITTERIS_SYSTEM PRO_LITTERIS_SYSTEM, PH_PRO_LITTERIS_CREDENTIALS PRO_LITTERIS_CREDENTIALS. PRO_LITTERIS_AUTO_MESSAGES is unchanged.
* new plugin folder, main file and text domain. Deactivate “ProLitteris” (pro-litteris) before activating “Integration for ProLitteris”. Namespace, classes, hooks, REST fields, options, meta and tables are unchanged, so data and project code keep working.

Features
* add bootstrap to check for central autoloader (c342d70)
* introduce ph-central-autoloader-debug constant (4ae8792)
* name all wp-config.php constants PRO_LITTERIS_* (2d6ec71)
* ship as “Integration for ProLitteris” for wordpress.org (850270c)

Bug Fixes
* bug where it couldn’t find the autoloader (e36c8da)
* declare the properties of Pixel (ec8d070)
* error counting when reporting pixel (67ddaf5)
* escape and translate the admin output, keep names with apostrophes (7841d8e)
* escape the pixel url, error titles and attachment author options (7f8e527)
* expose only the pixel of the pro_litteris REST field to visitors (88d6ff4)
* limit the ProLitteris dashboard widget to editors, add a nonce (660b6c7)
* load the editor sidebar from @wordpress/editor, update the WordPress packages (542ff00)
* remove dynamic property declaration (8fe06f2)
* verify the TLS certificate of the ProLitteris API (6b6c0fb)

Code Refactoring
* drop the support for the Palasthotel central autoloader (c86488e)

1.6.4

Fix: Remove dynamic property declaration

1.6.2

Feature: Add support for Palasthotel central autoloader

1.6.1

Update: Rework file structure

1.6.0

Feature: filter for paywall pixel variant

1.5.0

Feature: Post reporting updatable

1.4.0

Feature: Always add pixels, but limit reporting if conditions are not met

1.3.2

Bugfix: Ignore invalid user id as participants
Update: packages

1.3.1

Images from gallery blocks with innerBlock images are detected
Dependency updates

1.3.0

Update: Default min chars count for pixels is now 1500 instead of 2000
Feature: Two new action before and after the message text body is generated

1.2.6

Bugfix: User meta won’t be saved
Performance issue fix

1.2.5

Optimization: Push message error logging

1.2.4

Optimization: place referrer meta tag in header
Bugfix: database year -1 breaks query

1.2.3

Feature: Add image authorship to ProLitteris reporting.

1.2.2

Bugfix: Gutenberg script was enqueued even if no rest endpoint for post type existed

1.2.1

Feature: Migrate support

1.2.0

Gutenberg: Moved meta box into Gutenberg sidebar
Performance: Moved data to custom tables

1.1.1

First release