Version vom 18. Dezember 2010, 14:40 Uhr

Dabei wird in der Anzeige getrennt angezeigt die Zugriffe/Besucher vom aktuellem Tag sowie die jeweilige Gesamtzahl.
Der Zugriffszähler wird, wie der Name schon sagt, bei jedem Zugriff erhöht. Der Besucherzähler zeigt die Zahl der unterschiedlichen IP-Adressen, die innerhalb von 30 Minuten eine oder mehrere Seiten angefordert haben auf dem sich das Modul befindet.

Forum

Fragen zum Visitors-Modul werden im Forum beantwortet: Forum - Subforen beliebter Third-Party-Erweiterungen (Extensions) - Visitors
Fehler und Wünsche können im Tracking System gemeldet werden.

Installation

Installation erfolgt über das Extension Repository im Backend der Contao-Installation.
Eine manuelle Installation ist möglich, dazu die ZIP-Datei vom Extension Repository laden, entpacken und entsprechend übertragen.
Dadurch sollte ein Verzeichnis /system/modules/visitors angelegt worden sein.
Danach wie dabei üblich /contao/install.php Aufrufen - Update Database durchführen.
( /typolight/install.php bei älteren TYPOlight Installationen )

Da das Visitors-Modul abhängig ist vom Modul "Bot Detection", muss dieses bei der manuellen Installation mit installiert werden.

Hinweis für ältere TYPOlight-Versionen

TYPOlight 2.8

Nutzer von TYPOlight 2.8.x nutzen bitte Visitors-Modul-Version 1.7.1 (Direktlink)

TYPOlight 2.7

Nutzer von TYPOlight 2.7.x nutzen bitte Visitors-Modul-Version 1.4.1 (Direktlink)

Update von Version 1.x auf Version 2.x

Achtung: Die Version 2.x ist nicht vollständig kompatibel, ein Update ist aber möglich.

Was dabei zu beachten ist, kann hier nachgelesen werden.

• Visitors-Update-Version 1 auf Version 2

Übersicht

Das Visitors-Modul bringt 2 Backend- und ein Frontend-Modul mit.
Im Backend gibt es "Besucher" und "Besucher Statistik", für das Frontend ebenfalls "Besucher".

Backend

Besucher

Besucher-Statistik

zeigt dann im Detail: (Klick aufs Bild für höhere Auflösung)

• Besucher Statistik
• 

  Besucher Statistik im Detail

• 

  Browser Statistik

• 

  Search Engine Referer Statistik

Frontend

Für das Frontend werden als Beispiel zwei CSS-Dateien mitgeliefert:

• mod_visitors_fe.css für die normale, zeilenweise Ausgabe
• mod_visitors_fe_horizontal.css für die horizontale Ausgabe

Besucher-Statistik

Besucher-Statistik horizontal

Erste Schritte

Als erstes legt man über den Menüpunkt Besucher eine neue Besucher-Kategorie an. In dieser dann den Besucherzähler.
Danach legt man ein Frontend-Modul an und baut es in das Layout der Seite ein.
Hier nun die einzelnen Schritte, jeweils mit den Default-Angaben. Feinheiten werden später erklärt.

Anlegen einer Kategorie

Um eine neue Besucher-Kategorie zu erstellen, klickt man links im Backend unter 'Inhalte' auf 'Besucher'. Im Hauptbereich dann auf den Button 'Neue Kategorie'.

Am Anfang reicht es einen Kategorie-Namen anzugeben, anschließend klickt man auf "Speichern und Schließen".
Nun ist man in der Kategorie Übersicht. Durch Klick auf den Bleistift in der Zeile der Kategorie und nochmaligem Klick auf den Bleistift im Kopf der Kategorie gelangt man wieder zu den Einstellungen der Kategorie.

Anlegen des Besucherzählers

In der Kategorie Übersicht klickt man nun auf Edit (Bleistift) der Kategorie.
Dort entweder auf 'Neuer Besucherzähler' und dann das Pfeil-Symbol oder auf das Plus im Kopf der Kategorie:

Nun sind einige Angaben nötig:

• Namen angeben (wird über den Zahlen als Überschrift angezeigt).
• Start-Datum, ist optional, dient nur zur Anzeige im Frontend
• Optional: 'Startwerte für Zähler' eingeben
• Optional: 'Besucher pro Tag' Anzeige aktivieren
• "Veröffentlicht" aktivieren

anschließend klickt man auf "Speichern und Schließen".

Frontend-Modul

Ein neues Frontend-Modul wird angelegt über:

• Layout -> Themes -> Frontend Module -> Neues Modul (Contao ab 2.9)
• Layout -> Module -> Neues Modul (TYPOlight bis 2.8.x)

Als erstes unbedingt zuerst den Titel eingeben, erst dann bei Modultyp: 'Verschiedenes'-'Besucher' auswählen. Es ändern sich nun die Formularfelder.
Bei 'Besucher-Kategorie' nun die vorher angelegte Kategorie auswählen, anschließend 'Speichern und Schließen'.

Nun muss das angelegte Frontend-Modul noch im Layout eingebunden werden:

• Layout -> Themes -> Seitenlayout -> Edit des genutzte Layouts (Contao ab 2.9)
• Layout -> Seitenlayout -> Edit des genutzte Layouts (TYPOlight bis 2.8.x)

Bei 'Eingebundene Module' das gerade erstellte Frontend-Modul einbinden (z.b in left)

CSS-Datei

Wie erwähnt sind 2 CSS-Dateien mitgeliefert für die Darstellung.
Für die ersten Tests sollte die Datei mod_visitors_fe.css aus dem Verzeichnis /system/modules/visitors kopiert werden nach /tl_files und dann über das Backend importiert und im Layout aktiviert werden.

Feinheiten

Feinheiten sind einstellbar in der Kategorie, im Besucherzähler selbst sowie im selbst angelegtem Frontend-Modul.

Feinheiten in der Kategorie Definition

Zählweise

Seit Version 1.6.0 kann die Zählweise bei eingeschaltetem Seitencache gewählt werden:

• Last Zählung, serverseitig durch Contao
• Lese Zählung, clientseitig durch Browser
  • (nur im Contao cacheModus: Server- und Browsercache / Nur Browsercache)

Mit dem zweiten Punkt kann damit auch gezählt werden, wenn die Seite im Browsercache liegt und daraus aufgerufen wird. Die System-Einstellung 'Cache-Modus' wird dabei beachtet.

Anmerkung: Die Anzeige der aktuellen Werte erfolgt aber weiterhin nur wenn die Seite vom Server angefordert wird.

Feinheiten in der Besucherzähler-Definition

Blockzeit

Die Blockzeit wird in Sekunden angegeben. Nach Zugriffspause dieser Zeit wird ein Zugriff als weiterer Besucher gezählt.
Voreingetragen sind 1800 Sekunden, d.h. 30 Minuten.

Feinheiten in der Frontend-Modul-Definition

Templates

Jedem Modul kann per Auswahl ein Template zugeordnet werden. Zur Auswahl stehen 4 Templates.

• mod_visitors_fe_all
  • Liefert alle Felder die möglich sind (siehe Beispielbild oben)
• mod_visitors_fe_hits
  • Hier wurden die beiden Besucherzeilen entfernt
• mod_visitors_fe_visits
  • Hier wurden die beiden Zugriffszeilen entfernt
• mod_visitors_fe_invisible.tpl
  • Hier wird nichts angezeigt. Dieses Template dient dadurch zur reinen Zählung.

Es können eigene Templates erstellt werden. Diese müssen als Dateiname anfangen mit 'mod_visitors_fe_' und die Endung '.tpl' haben.

Nur Gästen anzeigen

Nach dem Aktivieren der Funktion wird das Modul versteckt, sobald ein Mitglied (Frontend-Nutzer) angemeldet ist.

Modul schützen

Hier kann nun definiert werden, dass die Anzeige des Moduls nur dann erfolgt, wenn Mitglieder bestimmter Gruppen online sind.

Selbstzählung verhindern

Es gab einige Ideen, wie man noch verhindern kann, eigene Zugriffe nicht zu zählen. Besonders, wenn man mit dynamischen IPs ankommt. Hier ist nun eine Möglichkeit umgesetzt, dieses über einen angepassten User Agent String des Browsers zu tun.
Über:

• Layout -> Themes -> Frontend-Module -> Modul-Name (Contao ab 2.9)
• Layout -> Module -> Modul-Name (TYPOlight bis 2.8.x)

vom angelegtem Besucher-Modul kann im neuem Feld "Keine Zählung bei HTTP_USER_AGENT Teilkennung:" einen String eingegeben werden, dieser sollte eindeutig sein.
Beispiel: CTISOK
Es sind, wozu auch immer, auch mehrere Strings dort möglich, diese dann durch Komma getrennt eingeben.
Im Firefox ergänzt man nun den Agent String wie folgt:

1. Tippe about:config in der Adresszeile ein und drücke ENTER
2. Tippe general.useragent.extra.firefox in der Filter Zeile
3. Doppelklick auf die gefunde Zeile
4. Hier nun den Beispiel String von oben mit Leerzeichen getrennt anhängen, OK

z.B. wird so aus "Firefox/3.5.2" nun "Firefox/3.5.2 CTISOK"

Die Kennung kann man sich dann durch Eingabe von about: + Enter anzeigen lassen. (letzte Zeile)

Weitere Browser sind hier erläutert (eng): walkernews.net - how to change user agent string

Insert-Tags

Anzeige

Seit der Version 1.2.0 gibt es Insert-Tags zum Anzeigen der Werte.

 {{visitors::katid::name}}
 {{visitors::katid::online}}
 {{visitors::katid::start}}
 {{visitors::katid::totalvisit}}
 {{visitors::katid::totalhit}}
 {{visitors::katid::todayvisit}}
 {{visitors::katid::todayhit}}
 {{visitors::katid::averagevisits}}

Seit der Version 1.5.0 und ab TYPOlight 2.8 können die Insert-Tags um den Präfix 'cache_' erweitert werden, damit sind diese dann auch cachesicher.

 {{cache_visitors::katid::name}}
 ...

Das Modul zählt und zeigt normalerweise die Werte an. Wer für die Anzeige die Insert-Tags nutzen will, braucht das Modul weiterhin, aber nur zum Zählen. Mittels des Templates mod_visitors_fe_invisible kann es dazu unsichtbar geschaltet werden.
Die "katid" ist die Kategorie-ID, in dem der Zähler angelegt wurde. Zur Ermittlung in der Kategorieübersicht des Moduls mit der Maus über das "i" gehen.

Dabei wird als Tooltipp die ID angezeigt.
Ab Version 2.3.1 steht die ID direkt hinter dem Kategorie-Namen.
Bei Kategorie-ID = 1 wäre das dann also beispielsweise:

 {{visitors::1::online}}

Zählung

Eine Alternative für "nur zählen" wäre, den Insert-Tag zu nutzen, den es ab Version 1.5.0 gibt, das Modul selbst verwendet diesen ebenfalls:

 {{cache_visitors::katid::count}}

Beispiel für Einbau in einen Artikel (für Kategorie-ID = 1):

 <span style="width:0px;height:0px;">{{cache_visitors::1::count}}</span>

Achtung: Dabei muss drauf geachtet werden, dass der Insert-Tag für die Zählung als erstes auf der Seite eingebaut wird, damit die Zählung vor der Ermittlung der Anzeigewerte erfolgt.

Weitere Insert-Tags

Seit der Version 2.1.0 gibt es Insert-Tags zum Anzeigen der Werte vom Tag an dem die meisten Besucher gezählt wurden.

 {{visitors::katid::bestday::date}}   - Tag (Datum) mit den meisten Besuchern
 {{visitors::katid::bestday::visits}} - Anzahl Besucher vom Tag mit den meisten Besuchern
 {{visitors::katid::bestday::hits}}   - Anzahl Zugriffe vom Tag mit den meisten Besuchern
bzw.
 {{cache_visitors::katid::bestday::date}}
 {{cache_visitors::katid::bestday::visits}}
 {{cache_visitors::katid::bestday::hits}}

Beim "date" Insert-Tag ist noch ein optionaler Parameter möglich, um die Datumsausgabe zu formatieren.(m.d.Y , Y-m-d, etc.)
Als default wird die Systemeinstellung verwendet. Als Trennzeichen muss ein "::" verwendet werden.
Ein komplettes Beispiel (hier mit Kategorie 1):

 BestDay: {{visitors::1::bestday::date::j. F Y}} mit {{visitors::1::bestday::visits}} Besuchern (bei {{visitors::1::bestday::hits}} Hits)

ergibt:

BestDay: 31. August 2010 mit 25 Besuchern (bei 123 Hits)

Besonderheiten

Keine Zählung

Es wird kein Frontend-Aufruf gezählt, wenn man dabei gleichzeitig im Backend angemeldet ist.

Besucher pro Tag: Ø = 0

Der Durschnittswert pro Tag wird pro vollständigem Kalendertag berechnet.
Hat man nun nur von einem Tag vorher oder gar nur vom aktuellem Tag eine Zählung, kann kein sinnvoller Wert berechnet werden.
(Durschnitt = Anzahl Besucher)
In diesen Fällen wird "0" angezeigt.

Bot Detection abschalten

Wer die Zugriffe von Bots und Suchmaschinen mitzählen möchte, kann die Bot Detection abschalten. Das geht allerdings nicht über das Backend, sondern muss über die localconfig.php passieren.

Achtung: Das gilt dann für alle Visitors-Module, falls mehrere Frontend Module angelegt wurden!

Folgender Eintrag ans Ende der localconfig.php (nach: ### INSTALL SCRIPT STOP ### ) bewirkt das Ausschalten:

$GLOBALS['TL_CONFIG']['mod_visitors_bot_check'] = false;

--BugBuster 00:37, 12. Dez. 2010 (CET)