MediaWiki extensions manual
CountingMarker
Release status: stable
Implementation Database , Data extraction, Special page
Description Adds special pages to view and assign the counting markers
Author(s) WikiMANNia (WikiForMentalk)
Latest version 0.5.4 (2023-05-29)
MediaWiki 1.35+ (REL1_35 branch)

1.25-1.35 (REL1_25 branch)

1.23-1.35 (REL1_23 branch)
PHP 5.6+
Database changes Yes
Tables countingmarker_author
countingmarker_counter
countingmarker_extension
countingmarker_marker
countingmarker_page
License COPYRIGHTED
Download No link
About
Example vgwort.wikimannia.org/Special:CountingMarker
Parameters
  • $wgCountingMarkerStatus
  • $wgDefaultCountLimitVGWort1
  • $wgDefaultCountLimitVGWort2
  • $wgDefaultCountThreshold1
  • $wgDefaultCountThreshold2
  • $wgDefaultTextLengthVGWort1
  • $wgDefaultTextLengthVGWort2
  • $wgDefaultTextThreshold1
  • $wgDefaultTextThreshold2
  • $wgDefaultServerSubdomain
  • $wgCountingMarkerRemoveLinkMarks
  • $wgCountingMarkerRemoveRefs
  • $wgCountingMarkerRemoveSeeAlso
  • $wgCountingMarkerRemoveWeblinks
  • $wgCountingMarkerContactURL
  • $wgCountingMarkerVgwortURL
  • $wgVgwortServerSubdomains
  • $wgVgwortStatusCategories
  • $wgDefaultBatchSize
  • $wgExportPagelistLimit
Tags
novgwort
Added rights
countingmarker_admin, countingmarker_assign, countingmarker_import, countingmarker_report, countingmarker_save, countingmarker_statistic
Hooks used
  • LoadExtensionSchemaUpdates
  • SkinAddFooterLinks
  • SkinBuildSidebar
  • PageSaveComplete
  • ParserAfterParse
  • SpecialStatsAddExtra

The CountingMarker extension provides functionality for monetising a wiki with the Verwertungs­gesellschaft Wort (Copyright collective).

Description

Anyone who is a member of the Verwertungs­gesellschaft Wort (Copyright collective) and operates a wiki faces several problems when they want to participate in the METIS programme, i.e. registering their online texts for monetization.

METIS stands for „Meldesystem für Texte auf Internet­seiten“ (“Reporting System for Texts on Internet Pages”). VG Wort requires a minimum length of the texts as well as a minimum number of article views (“hits”), which must be proven by the installation of “counting pixels” on the article page. For the installation of these pixels you can order “counting markers” from VG Wort, each of which consists of a set of public and private keys and a URL to a counting pixel on a VG Wort server.

A snippet of HTML code on how to include this counter in an HTML page is included. For web pages from the 1980s, which consisted of self-made HTML pages, it is a simple matter to insert this HTML code via copy and paste into the HTML code of the page. But how can these counters be integrated into modern content management systems, which in a very complex way assemble the pages finally delivered to the reader from database queries, templates and skins?

This task, as well as the administration of the counter marks, the assignment of the counter marks to the articles and the annual report to VG Wort are part of the functional scope of this enhancement.

Installation

  • Download and place the file(s) in a directory called CountingMarker in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php file: 
    wfLoadExtension( 'CountingMarker' );
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension(). If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'CountingMarker' );, you need to use:

require_once "$IP/extensions/CountingMarker/CountingMarker.php";

Since MediaWiki 1.25 the extension HitCounters should be installed to use the full range of functions. However, there is a basic version in which the HitCounters extension is not required.

Tested

The extension was tested with MediaWiki 1.23, 1.25, (1.27), 1.31, (1.33), 1.35.10, (1.36), (1.37), 1.38.4, 1.39.3.

Localisation

The extension is provided in "de", "en", "es".

Functional scope of the versions
Function Basic version Single-author version Multi-author version
Upload counting markers from CSV file Yes Yes Yes
Manage counting markers and assign to articles Yes Yes Yes
Change assignment of counting markers Yes Yes Yes
Create annual report Yes Yes Yes
<novgwort> tags supported Yes Yes Yes
Test mode Yes Yes Yes
Statistical functions
(in connection with the extension “HitCounters”)		 No Yes Yes
Save and archive count readings No Yes Yes
Extrapolate page views up to the end of the year No Yes Yes
Switch off the counting markers individually No Yes Yes
Block counting markers No Yes Yes
Author management (assign articles and counting markers to an author) No No Yes
Assign contribution type
(draft, article, poetry)		 No No Yes

Version history

Version 0.2.0
MediaWiki v1.23-1.33
First public release
Version 0.3.x
MediaWiki v1.25+
Remove compatibility stuff for MediaWiki before v1.25.
Version 0.2.2/0.3.2
Export function for the annual report added.
Version 0.2.3/0.3.3
Multi-author support added und user groups with individual rights defined.
Version 0.2.4/0.3.4
Stuff around lazy loading and the code-snippet of the counting marker.
Version 0.2.5/0.3.5
Compatibility stuff for MediaWiki v1.35.
Version 0.2.6/0.3.6
MediaWiki v1.25+ (v1.23+)
add Hook SkinBuildSidebar
Version 0.3.7
MediaWiki v1.35+
Replace hook SkinTemplateOutputPageBeforeExec with SkinAddFooterLinks.
Version 0.4.0
MediaWiki v1.35+
Adaptations regarding MediaWiki 1.37.
Author can select his articles in the statistics table.
Version 0.5.0
Add a <novgwort> tag.
Version 0.5.1
Adaptations regarding MediaWiki 1.39.
Replace hook PageContentSaveComplete with PageSaveComplete.
Fix a deprecated function and a css issue.
Version 0.5.2/0.5.3/0.5.4
See Change log

Issues

Other issues

There are minor issues, for example the sum of the hits of all articles in v1.25 and v1.27 is displayed incorrectly. However, since this only affects additional statistical information, which does not affect functionality, this is not a problem.

If you run a Wiki family and manage the extensions centrally (via soft links), you have the problem that the Maintenance scripts of this extension are not found. Currently, to solve this problem, these maintenance scripts can be copy & paste into the maintenance folders of the MediaWiki installations.

Backward compatibility

REL1_23
This branch (current version 0.5.4) is compatible up to MediaWiki 1.35.x.
This branch in all its versions is fully backwards compatible with MediaWiki 1.24, and except for a helping function even compatible with MediaWiki 1.23.
REL1_25
This branch (current version 0.5.4) is compatible up to MediaWiki 1.35.x.
Removed backward compatibility with versions prior to MediaWiki 1.25 is removed.
REL1_35
This branch (current version 0.5.4) is tested up to MediaWiki 1.39.3.
Removed backward compatibility with versions prior to MediaWiki 1.35 is removed.
This article is issued from Mediawiki. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.