View counting markers

Use

The usage is shown in its basic features on the main page of this extension. These links are enabled depending on the rights assigned to the user. The tasks are distributed as follows:

1. VG Wort author

   The author obtains his counting markers from VG Wort, imports them and then assigns them to an article.

   For the assignment, the assignment table and the page view statistics can be used to provide potentially suitable articles with a counting marker. The assignment page can also be accessed from an article via the “assign” link in the assignment page.

2. counting marker reporter

   The reporter can save the count readings and create an annual report.

   On the page “determine plain text”, the data required for the annual report can be extracted, including the unformatted text of the article with text length.

3. administrator of counting markers

   The administrator can edit the settings of this extension, change (correct) the assignment of articles to authors or edit counting markers subsequently.

   The administrator can alter the groups this user is in, thus adding the user to the groups “VG Wort author” or “counting marker reporter”, or removing the user from these groups.

4. Statistics

   In conjunction with the “Hitcounter” extension and the saved counts from the previous year, it is possible to estimate which articles will achieve the required number of clicks at the end of the year. Based on text length and the number of clicks already achieved, a status is calculated and displayed. (See the table on the right.)

The management of the droits des groupes d’utilisateurs is done by a bureaucrate.

For understanding: This program extension uses two user concepts that have nothing to do with each other. One is the “user” of this wiki and the other is the “author” at VG Wort.
The “user” of the wiki is used to log in, edit articles and use the wiki-internal rights management. None of this has anything to do with VG Wort.
The “author” registered with VG Wort can upload counters, manage them and assign them to articles. The VG Wort counters, their link to an “author” and to an article have nothing to do with the wiki and its “users”.
In terms of the programme, it should be noted that both the Wiki “user” and the VG Wort “author” have their own ID number, which must be kept apart.
For the users of this programme extension, logging in to the wiki is not sufficient to manage counters. To do so, they must first register as a VG Wort “author” in the author administration. The authorisation to do so is granted by the aforementioned “bureaucrat” of the Wiki.

The <novgwort> tag can be used to exclude parts of the text (for example quotations) for the report to VGWort.

Droits des groupes d’utilisateurs

The droits des groupes d’utilisateurs are assigned by default as follows:

1. „*“ (Not registered readers):
   • Read the info page (this page)
   • No further rights
2. „user“ (logged-in users):
   • „countingmarker_statistic“ (Access to statistics)
3. „vgwortauthor“:
   • Edit personal VG Wort data. (Name, registration number)
   • „countingmarker_assign“ (Counting marker assignment)
   • „countingmarker_import“ (Import of counting markers)
4. „vgwortreporter“:
   • „countingmarker_report“ (Create annual report)
   • „countingmarker_save“ (Save count readings)
5. „vgwortsysop“:
   • „countingmarker_admin“ (Change general settings)
   • „countingmarker_import“ (Import of counting markers)
   • „countingmarker_save“ (Save count readings)

These settings can be changed in the file “LocalSettings.php”.

Report status

An overview of the status of the articles in terms of text length and number of clicks achieved supports a targeted allocation of counters. The following ten levels are distinguished:

The articles can be selected in the overview tables via their status. Count limit 1 is defined for a text length of 1500 and 1800 clicks, count limit 2 for a text length of 750 and 10000 clicks.

Change Log

• Neu in Version 0.3.6:
  1. Bedienung, droits des groupes d’utilisateurs
  2. Dem Wartungsskript „saveCounterValues.php“ wurde eine Option „Save the page_counter column for image files also“ hinzugefügt.
• Neu in Version 0.3.7:
  1. Neuer Entwicklungszweig (Branch) für MediaWiki 1.35.x
  2. Hook „SkinTemplateOutputPageBeforeExec“ ersetzt durch „SkinAddFooterLinks“.
  3. Die Rückwärtskompatibilität für MediaWiki <1.35.3 wird aufgegeben.
• Neu in Version 0.3.7.1:
  1. Verbesserte Fehlerbehandlung in Klasse „ManageMarker“. Es wird nun ausgewiesen, wenn einer Zählmarke eine ungültige Artikel-ID zugewiesen wurde.
  2. Auf der Seite „About this extension“ wurde mehr Text übersetzt.
• Neu in Version 0.3.7.2:
  1. Die Spalte mit dem Eintrag „PAGEID“ wurde aus Übersicht der Mediendateien entfernt, da diese nur für die Zuweisung von Zählmarken zu Artikeln von Belang ist.
  2. In der „multi“-Version wurde in der Übersicht der Artikel eine Spalte mit der Autoren-ID hinzugefügt.
  3. Auch Besuchern ohne Rechte wird nun angezeigt, wie viele Artikel im Bestand sind und wieviele Aufrufe insgesamt im aktuellen Jahr erzielt wurden.
• Neu in Version 0.3.7.3:
  1. Die URL zur VG Wort-Seite wurde aus den „i18n“-Dateien entfernt und in eine konfigurierbare globale Variable verlegt.
  2. Der Inklude-Pfad für die Datei „maintenance/Maintenance.php“ wurde in den Wartungs­skripten korrigiert.
  3. Fehlgeschlagene Datenbank-Abfragen werden in den Wartungs­skripten nun abgefangen.
• Neu in Version 0.3.7.4:
  1. Quellkodepflege: alter, toter Kode entsorgt.
  2. Die Wartungsskripte „updateArticleStatus.php“ und „updateTextlength.php“ wurden von der Erweiterung „HitCounters“ entkoppelt.
• Neu in Version 0.3.7.5:
  1. Bedienungsanleitung überarbeitet und ergänzt.
  2. Kompatibilität mit MediaWiki REL1_37 hergestellt.
• Neu in Version 0.3.7.6:
  1. Feinabstimmung bei den Benutzer­gruppen­rechten.
• Neu in Version 0.3.7.7:
  1. Umbenennungen von Variabeln von „user“ zu „wiki_user“ und „author“ zu „vgwort_autor“.
  2. Die Zählmarken waren noch mit der ID des Wiki-Accounts verknüpft. Das wurde umgestellt auf die ID der Autorenverwaltung dieser Erweiterung.
  3. Aus der Autorenverwaltung heraus können die Autoren nun direkt auf die Übersicht ihrer Artikel und Zählmarken gelangen.
• Neu in Version 0.3.7.8:
  1. In den Statistiken können die Artikel nach Autoren selektiert werden.
• Neu in Version 0.3.7.9:
  1. Neue Klasse: CountingMarkerQueryPageWithSelection.
  2. In den Statistiken können die Artikel nach dem VG Wort-Report-Status selektiert werden.
  3. In den Statistiken kann selektiert werden, ob den Artikeln bereits eine Zählmarke zugewiesen wurde oder nicht.
  4. Die Zählmarken können selektiert werden, ob sie bereits einem Artikel zugewiesen wurden oder nicht.
• Neu in Version 0.4.0:
  1. Der Reportstatus wird nun aktuell berechnet.
• Neu in Version 0.5.0:
  1. Tag <novgwort> hinzugefügt.
• Neu in Version 0.5.1:
  1. Kompatibilität mit MediaWiki REL1_38 hergestellt.
  2. Hook „PageContentSaveComplete“ ersetzt durch „PageSaveComplete“.
• Neu in Version 0.5.2:
  1. Beim „determine plain text“ wird nun erkannt, ob es sich bei dem Eintrag um eine Weiterleitung handelt.
  2. Die Beschreibung der „droits des groupes d’utilisateurs“ präzisiert.
  3. Die Anzeige der Skriptlaufzeit kann nur noch aktiviert werden, indem die globale Variable „$wmShowScriptExecutionTime“ auf 1 gesetzt wird.
  4. Die Statistikseiten haben nun eine ausklappbare Legende.
  5. Die ID des VG-Wort-Autors wird nun bereits bei der Neuanlage eines Artikels in der Tabelle „countingmarker_page“ im Feld „author_id“ gesetzt.
• Neu in Version 0.5.3:
  1. Hook „SpecialStatsAddExtra“ hinzugefügt für Page spéciale „Statistiques“.
  2. Neues Wartungsskript „cleanupCounterMarker.php“ erstellt.
• Neu in Version 0.5.4:
  1. Die Funktion „determine plain text“ kann nun in den globalen Variablen „$wmCountingMarkerRemoveLinkMarks“, „$wmCountingMarkerRemoveRefs“, „$wmCountingMarkerRemoveSeeAlso“ und „$wmCountingMarkerRemoveWeblinks“ konfiguriert werden.
  2. In der Zählmarken-Verwaltung können die Zählmarken nach „Assignability“ und „Activation“ selektiert werden.
• Neu in Version 0.5.5:
  1. Bereit für PHP 8: Klassenvariablen mit Typen versehen.
• Neu in Version 0.5.6:
  1. In der Basis-Version wurde ein neues Feld „page_status“ in der DB-Tabelle „countingmarker_page“ hinzugefügt, deshalb hat sich die Datei „sql/update_singleauthor.sql“ geändert.
  2. Das Wartungsskript „updateTextlength“ zeigt jetzt an, wenn sich die Textlänge geändert hat.
• Neu in Version 0.5.7:
  1. Refactoring, Compatibility.
• Neu in Version 0.5.8:
  1. Neuer Hook „GetPreferences“ hinzugefügt. Voreinstellungen der Wiki-Benutzer: „ShowScriptExecutionTime“ aktivieren, „Anzahl der meistbetrachteten Seiten“ festlegen.
• Neu in Version 0.5.9:
  1. Geändertes „Konfigurationsschema“, Änderung von Manifest Version 1 auf Version 2 (unterstützt seit 1.29+) und Änderung des Prefixes der Konfigurations­variablen von Standard wg auf wm.
  2. Ersetzung der Klasse „CountingMarkerHooks“, welche eine Klasse erweitert (extends „Hooks“) durch eine Klasse, die Schnittstellen implementiert.
• Neu in Version 0.6.0:
  1. Neue Datenbank-Unterstützung für „sqlite“.
• Neu in Version 0.6.1:
  1. Refactoring, Neue Klasse „CountingMarkerUtils“.
• Neu in Version 0.6.2:
  1. Kompatibilität mit MediaWiki REL1_41 hergestellt.
• Neu in Version 0.6.3:
  1. „AddGroups“ und „RemoveGroups“ in „extension.json“ hinzugefügt.

Database tables

1. Table countingmarker_page
   • page_id int(10) UNSIGNED NOT NULL
     Dies ist der PRIMARY KEY und entspricht dem Feld page_id der MediaWiki-Tabelle page.
   • author_id int(10) UNSIGNED DEFAULT NULL
     Der Verweis auf den Autor des Artikels und entspricht dem Feld author_id der Tabelle countingmarker_author.
   • marker_id int(10) UNSIGNED DEFAULT NULL
     Der Verweis auf den Eintrag in der Tabelle countingmarker_marker.
   • page_date date DEFAULT NULL
     Das Datum des DB-Eintrages. Es ist nur relevant im aktuellen Jahr und wird dort zur Voraus­berechnung der Klickzahlen zum Jahresende verwendet.
   • page_length bigint(20) UNSIGNED NOT NULL DEFAULT 0
     Dieses Feld enthält die korrekte Textlänge des Artikels und wird für statistische Auswertung und Such­funktionen verwendet.
   • page_status int(1) UNSIGNED NOT NULL DEFAULT 0
     Dieses Feld enthält eine Bewertung des Artikels und wird für statistische Auswertung und Such­funktionen verwendet.
   • page_type int(2) UNSIGNED NOT NULL DEFAULT 1
     Dieses Feld enthält den Index für den Typ des Artikels und wird für Such­funktionen und ggfs. für die Jahresmeldung an VG Wort verwendet.
2. Table countingmarker_marker
   • id int(10) UNSIGNED NOT NULL
     Dies ist der PRIMARY KEY der Zählmarken und entspricht dem Feld marker_id der MediaWiki-Tabelle countingmarker_page.
   • server int(2) UNSIGNED NOT NULL
     Dies ist die ID des verwendeten Servers.
   • public_key varchar(32) NOT NULL DEFAULT ""
     Der öffentliche Schlüssel der Zählmarke.
   • private_key varchar(32) NOT NULL DEFAULT ""
     Der private Schlüssel der Zählmarke.
   • url varchar(64) NOT NULL DEFAULT ""
     Dieses Feld enthält die URL des Zählpixels. (Das Feld wird nicht verwendet und dient nur zu Kontrollzwecken.)
   • page_id int(10) UNSIGNED DEFAULT NULL
     Dieses Feld enthält die ID des zugewiesenen Artikels, siehe Feld page_id der MediaWiki-Tabelle page.
   • is_assignable int(1) UNSIGNED NOT NULL DEFAULT 1
     Dieses Feld enthält eine "1", wenn die Zählmarke einem Artikel zugewiesen werden kann und "0", wenn sie – beispielsweise von VG Wort – für ungültig erklärt wurde und folglich keinem Artikel mehr zugeordnet werden soll.
   • is_counting int(1) UNSIGNED NOT NULL DEFAULT 1
     Dieses Feld enthält eine "1", wenn die Zählmarke "aktiv" ist – die Zählfunktion aktiviert ist – und "0", wenn sie "deaktiviert" wurde, etwa weil – wahrscheinlich temporär – die Zählfunktion ausgesetzt werden soll.
   • author int(10) UNSIGNED NOT NULL DEFAULT 1
     Die ID des VG Wort-Autors entspricht dem Feld author_id der Tabelle countingmarker_author.
3. Table countingmarker_counter
   • Diese Tabelle enthält die Zählstände aus der Erweiterung HitCounters zu verschiedenen Zeitpunkten. Die wichtigsten sind die Zählstände jeweils zum Jahresende.
   • page_id int(10) UNSIGNED NOT NULL
     Die ID des Artikels, dem dieser Zählerstand zugeordnet ist.
   • date date DEFAULT NULL
     Das Datum des Zählerstandes.
   • expiry_date date DEFAULT "9999-12-31"
     Das Datum, ab dem geplant ist, diesen Datensatz zu entfernen.
   • page_counter bigint(20) UNSIGNED NOT NULL DEFAULT 0
     Dieses Feld enthält den Zählerstand zum gegebenen Zeitpunkt
   • page_length bigint(20) UNSIGNED NOT NULL DEFAULT 0
     Dieses Feld enthält die korrekte Textlänge in Zeichen zum gegebenen Zeitpunkt. Dieses Feld ist wenig wichtig und wird aktuell nirgends aktiv verwendet.
4. Table countingmarker_author
   • Diese Tabelle enthält die Autoren-Daten.
   • author_id int(10) UNSIGNED NOT NULL
     Dies ist der PRIMARY KEY dieser Tabelle.
   • user_id int(10) UNSIGNED NOT NULL
     ID des MediaWiki Benutzerkontos.
   • first_name varchar(32) COLLATE utf8_unicode_ci NOT NULL DEFAULT ''
     Vorname
   • last_name varchar(32) COLLATE utf8_unicode_ci NOT NULL DEFAULT ''
     Nachname
   • birth_date date DEFAULT NULL
     Geburtsdatum
   • index_number int(10) UNSIGNED DEFAULT NULL
     VG Wort-Karteinummer
   • comment varchar(128) COLLATE utf8_unicode_ci DEFAULT NULL
     Ein zusätzliches Kommentarfeld.

Maintenance scripts

• cleanupCounterMarker.php entfernt Einträge aus der Tabelle countingmarker_page, die in der Tabelle page auf einen Eintrag verweisen, der a) nicht existiert, b) nicht im Artikel-Namensraum liegt oder c) eine Weiterleitung ist.
• saveCounterValues.php sichert Zählerstände in der Tabelle countingmarker_counter.
• deleteOldCounterValues.php entfernt Zählerstände aus der Tabelle countingmarker_counter, wenn diese ihr „Verfallsdatum“ überschritten haben.
• saveAnnualReport.php erstellt für die Jahresmeldung an VG Wort eine XML-Datei.
• updateTextlength.php berechnet die korrekte Textlänge (die für VG Wort relevante Anzahl von Zeichen) für alle Artikel.
• updateArticleStatus.php aktualisiert den Status aller Artikel. Der Status zeigt beispielsweise an, ob ein Artikel bereits die von VG Wort festgelegten Bedingungen bezüglich Textlänge und Anzahl von Aufrufen erfüllt.