Upload
others
View
5
Download
0
Embed Size (px)
Citation preview
1. Einleitung2. ÜberblickVisitors3. InstallationvonVisitors4. ÜbersichtFrontend/Backend
i. Backendii. Frontend
5. ErsteSchrittei. AnlegeneinerKategorieii. AnlegendesBesucherzählersiii. AnlegendesFrontend-Modulsiv. DemoCSSDateiaktivieren
6. Feinheiteni. FeinheitenKategorieDefinitionii. FeinheitenBesucherzähler-Definitioniii. FeinheitenFrontend-Modul-Definition
7. Insert-Tagsi. Anzeigeii. Zählungiii. WeitereInsert-Tags
8. Besonderheiteni. KeineZählungii. BesucherproTag:Ø=0iii. BotDetectionabschalten
9. Datenschutzi. Datenerfassungii. Datenspeicherungiii. Datenhaltung
Inhaltsverzeichnis
HandbuchfürdieContaoErweiterungVisitors-
-2-
DiesistdasHandbuchfürAnwendervonVisitors.DieneusteVersionistunterdocs.contao.ninjazufinden.
ÜberblickVisitorsInstallationvonVisitorsÜbersichtFrontend/Backend
BackendFrontend
ErsteSchritteAnlegeneinerKategorieAnlegendesBesucherzählersAnlegendesFrontend-ModulsDemoCSSDateiaktivieren
FeinheitenFeinheitenKategorieDefinitionFeinheitenBesucherzähler-DefinitionFeinheitenFrontend-Modul-Definition
Insert-TagsAnzeigeZählungWeitereInsert-Tags
BesonderheitenKeineZählungBesucherproTag:Ø=0BotDetectionabschalten
DatenschutzDatenerfassungDatenspeicherungDatenhaltung
AlldocumentationsofBugBuster1701@GitHublicensedunderaCreativeCommonsAttribution3.0License(CCBY-NC-SA3.0).Ifyouwanttoredistributeamodifiedorunmodifiedversionofthedocumentation,youcandosounderthelicenseterms.
Ifyoucontributetothedocumentation,e.g.bycreatingpullrequests,yougrantusfullusagerightsofanycontentyoucreateorupload.Youalsoensurethatyourcontentdoesnotviolateanythird-partyrights.
Wearenotclaimingexclusiveusagerights,thereforeyouarefreetouseyourcontributedcontent(e.g.textsorimages)inanyotherprojectaswell.
HandbuchfürdieContaoErweiterungVisitors
Inhaltsverzeichnis
Licence
HandbuchfürdieContaoErweiterungVisitors-Einleitung
-3-
VisitorsisteineErweiterungwelchedieZugriffe(Hits)undBesucher(Visits)zähltundzurAnzeigebringt.ImBackendgibteseineStatistikübersicht.
DabeiwirdinderAnzeigegetrenntangezeigtdieZugriffe/BesuchervomaktuellemTagsowiediejeweiligeGesamtzahl.
DerZugriffszählerwird,wiederNameschonsagt,beijedemZugrifferhöht.DerBesucherzählerzeigtdieZahlderunterschiedlichenIP-Adressen,dieinnerhalbvon30MinuteneineodermehrereSeitenangeforderthabenaufdemsichdieErweiterungbefindet.(siehedazuauchBlockzeit)
VisitorsbenutztinAbhängigkeitdieErweiterung"BotDetection".Damitwirdverhindert,dassZugriffevonBots/Suchmaschinengezähltwerden.Eine100%igeSicherheitgibtesdabeinatürlichnicht.
Information Link
EntwicklerWebseite http://contao.ninja
LinkzumExtensionRepository(ER2) contao.orgER2
LinkzumExtensionRepository(Packagist) Packagist.org
DenEntwicklerunterstützen AmazonWunschliste
Fehler/Wünschemelden GitHub
ContaoForumfürFragen community.contao.org
DieÜbersetzungenderTextevonVisitorsimBackendundFrontendwerdenmitTransifexverwaltet.UmeineneueÜbersetzungerstellenoderumeinevorhandenezukorrigieren,müssenSiesichbeitransifex.comregistrieren.BasisspracheistEnglisch.
ProjektLink:https://www.transifex.com/projects/p/contao-visitors/
Howto(english):http://docs.transifex.com/faq/#translating
Überblick
HilfreicheLinks
Übersetzungen
HandbuchfürdieContaoErweiterungVisitors-ÜberblickVisitors
-4-
EsgibtderzeitmehrereArtenderInstallation,hiereinkurzerÜberblick.
Hinweis:VisitorsistabhängigvondenErweiterungen"BotDetection"und"Excel95Erzeuger(xls_export)",diesewerdenindenmeistenFällenautomatischmitinstalliert.
LinkzuPackagist:VisitorsaufPackagist.orgLinkzumER2:VisitorsimER2
IstderComposerClient(Paketverwaltung)installiertinContao,dortsuchennachbugbuster/visitors,diegewünschteVersionwählenundinstallieren.DieAbhängigkeitenwerdenautomatischmitinstalliert.
IstdiealteErweiterungsverwaltung/-katalognochinstalliert,imKatalognachVisitorssuchenundinstallieren.DieAbhängigkeitenwerdenautomatischmitinstalliert.
EinemanuelleInstallationistmöglich,dazudieZIP-DateivomExtensionRepositoryladen,entpackenundentsprechendübertragen.
DadurchsollteeinVerzeichnis/system/modules/visitorsangelegtwordensein.Danachwiedabeiüblich/contao/install.phpAufrufen-UpdateDatabasedurchführen.
Achtung:DieAbhängigkeitenmüssendannebenfallsmanuellinstalliertwerden!
InstallationvonVisitors
InstallationüberComposerClient
InstallationüberER2
Installationmanuell
HandbuchfürdieContaoErweiterungVisitors-InstallationvonVisitors
-5-
DasVisitors-ModulbringtzweiBackend-undeinFrontend-Modulmit.ImBackendgibtesdasModul"Besucher",hierwerdendieBesucherzählerdefiniertundersteEinstellungendurchgeführt,sowiedasModul"Besucherstatistik",hiersinddieStatistikdateneinsehbar.
FürdasFrontendgibtesdasModul"Besucher".DurchAuswahleinesdermitgeliefertenTemplateskannesentwedernurzählenoderauchdieSummenderBesucherundZugriffeanzeigen.
DetailsdazufolgenindennächstenKapiteln.
ÜbersichtFrontend/Backend
HandbuchfürdieContaoErweiterungVisitors-ÜbersichtFrontend/Backend
-6-
DasBesucherModulistunterInhalte->Besucherzufinden.
DasBesucherstatistikModulistunterSystem->Besucherstatistikzufinden.
EszeigtdanndieStatistikenfürdenangelegtenBesucherzähler.Hatmanmehrereangelegt,z.B.füreineMultidomainInstallation,kannderBesucherzählerausgewähltwerden.
EineAuswahlderStatistiken:
Backend
Besucher
Besucherstatistik
HandbuchfürdieContaoErweiterungVisitors-Backend
-7-
HandbuchfürdieContaoErweiterungVisitors-Backend
-8-
(TOP20Listensindgekürzt.)
HandbuchfürdieContaoErweiterungVisitors-Backend
-9-
FürdasFrontendwerdenzweiCSS-DateienalsBeispielfüreineAnzeigeformatierungmitgeliefert:
mod_visitors_fe.cssfürdienormale,zeilenweiseAusgabemod_visitors_fe_horizontal.cssfürdiehorizontaleAusgabe
DieseDateienliegenimUnterverzeichniscss_demo.ZurVerwendungsieheCSS-Datei
Frontend
Besucherstatistikzeilenweise
Besucherstatistikhorizontal
HandbuchfürdieContaoErweiterungVisitors-Frontend
-10-
AlsersteswirdüberdenMenüpunktBesuchereineneueBesucher-Kategorieangelegt.IndieserdanndenBesucherzähler.
DanachwirdeinFrontend-ModulangelegtundbautesindasLayoutderSeiteein.(z.B.in'left')
HiernundieeinzelnenSchritte,jeweilsmitdenDefault-Angaben.Feinheitenwerdenspätererklärt.
ErsteSchritte
HandbuchfürdieContaoErweiterungVisitors-ErsteSchritte
-11-
UmeineneueBesucher-Kategoriezuerstellen,wirdimBackendunterInhalte->BesucherimHauptbereichderLink'NeueKategorie'ausgewählt.
AmAnfangreichteseinenKategorie-Namenanzugeben,anschließendeinKlickauf"SpeichernundSchließen".NunwirddieKategorieÜbersichtangezeigt.DurchKlickaufdenBleistiftinderZeilederKategorieundnochmaligemKlickaufdenBleistiftimKopfderKategoriegelangtmanwiederzudenEinstellungenderKategorie.
AnlegeneinerKategorie
HandbuchfürdieContaoErweiterungVisitors-AnlegeneinerKategorie
-12-
InderKategorieÜbersichtkanndurcheinKlickaufEdit(Bleistift)derKategorieeinneuerBesucherzählerangelegtwerden.Dortentwederauf'NeuerBesucherzähler'unddanndasPfeil-SymboloderaufdasPlusimKopfderKategorie:
NunsindeinigeAngabennötig:
Namenangeben(wirdüberdenZahlenalsÜberschriftangezeigt).Start-Datum,istoptional,dientnurzurAnzeigeimFrontendOptional:'StartwertefürZähler'eingebenOptional:'BesucherproTag'Anzeigeaktivieren"Veröffentlicht"aktivieren
anschließendeinKlickauf"SpeichernundSchließen".
AnlegendesBesucherzählers
HandbuchfürdieContaoErweiterungVisitors-AnlegendesBesucherzählers
-13-
EinneuesFrontend-Modulwirdangelegtüber:
Layout->Themes->FrontendModule->NeuesModul
AlserstesdenTiteleingeben,dannbeiModultyp:'Verschiedenes'-'Besucher'auswählen.EsändernsichnundieFormularfelder.Bei'Besucherkategorie'nundievorherangelegteKategorieauswählen,anschließend'SpeichernundSchließen'.
NunmussdasangelegteFrontend-ModulnochimLayouteingebundenwerden:
Layout->Themes->Seitenlayout->EditdesgenutzteLayouts
Bei'EingebundeneModule'dasgeradeerstellteFrontend-Moduleinbinden(z.B.inleft)
AnlegendesFrontend-Moduls
HandbuchfürdieContaoErweiterungVisitors-AnlegendesFrontend-Moduls
-14-
WieerwähntsindzweiCSS-DateienmitgeliefertfürdieDarstellung.FürdieerstenTestssolltedieDateimod_visitors_fe.cssausdemVerzeichnis/system/modules/visitors/css_demoaufdenlokalemPCkopiertwerdenunddannüberdasBackendimportiert(Themes->CSS->Import)undimLayoutaktiviertwerden.
DemoCSSDateiaktivieren
HandbuchfürdieContaoErweiterungVisitors-DemoCSSDateiaktivieren
-15-
FeinheitensindeinstellbarinderKategorie,imBesucherzählerselbstsowieimselbstangelegtemFrontend-Modul.DasbetrifftdiebishernichterwähntenFormularfeldersowiedieunterschiedlichenFrontendTemplatesdiemitgeliefertwerden.
Feinheiten
HandbuchfürdieContaoErweiterungVisitors-Feinheiten
-16-
DieZählweisebeieingeschaltetemSeitencachekannausgewähltwerden:
LastZählung,serverseitigdurchContaoLeseZählung,clientseitigdurchBrowser
(nurimContaocacheModus:Server-undBrowsercache/NurBrowsercache)
MitdemzweitenPunktkanndamitauchgezähltwerden,wenndieSeiteimBrowsercacheliegtunddarausaufgerufenwird.DieSystem-Einstellung'Cache-Modus'wirddabeibeachtet.
Anmerkung:DieAnzeigederaktuellenWerteerfolgtaberweiterhinnurwenndieSeitevomServerangefordertwird.
FeinheitenKategorieDefinition
Zählweise
HandbuchfürdieContaoErweiterungVisitors-FeinheitenKategorieDefinition
-17-
DieBlockzeitwirdinSekundenangegeben.NachZugriffspausedieserZeitwirdeinZugriffvonderselbenIPalsweitererBesuchergezählt.
Voreingetragensind1800Sekunden,d.h.30Minuten.
FeinheitenBesucherzähler-Definition
Blockzeit
HandbuchfürdieContaoErweiterungVisitors-FeinheitenBesucherzähler-Definition
-18-
JedemFrontendModulkannperAuswahleinTemplatezugeordnetwerden.ZurAuswahlstehen4Templates:
mod_visitors_fe_all
LiefertalleFelderdiemöglichsind(sieheBeispielbildoben)mod_visitors_fe_hits
HierwurdendiebeidenBesucherzeilenentferntmod_visitors_fe_visits
HierwurdendiebeidenZugriffszeilenentferntmod_visitors_fe_invisible
Hierwirdnichtsangezeigt.DiesesTemplatedientdadurchzurreinenZählung.
EskönneneigeneTemplateserstelltwerden.DiesemüssenalsDateinameanfangenmitmod_visitors_fe_unddieEndung.xhtmloder.html5haben,jenachdemwelchesAusgabeformatimLayouteingestelltist.
NachdemAktivierendieserFunktionwirddasFrontendModulversteckt,sobaldeinMitglied(Frontend-Nutzer)angemeldetist.
Hierkannnundefiniertwerden,dassdieAnzeigedesModulsnurdannerfolgt,wennMitgliederbestimmterGruppenonlinesind.
EsgabeinigeIdeen,wiemannochverhindernkann,eigeneZugriffenichtzuzählen.Besonders,wennmanmitdynamischenIPsankommt.HieristnuneineMöglichkeitumgesetzt,diesesübereinenangepasstenUserAgentStringdesBrowserszutun.
Über:
Layout->Themes->Frontend-Module->Modul-Name
vomangelegtemBesucher-ModulkannimFeld"KeineZählungbeiHTTP_USER_AGENTTeilkennung:"einenStringeingegebenwerden,diesersollteeindeutigsein.Beispiel:CTISOK
Essind,wozuauchimmer,auchmehrereStringsdortmöglich,diesedanndurchKommagetrennteingeben.
InälterenBrowsernkonntedurchAnpassungderKonfigurationdesBrowsersderAgentStringangepasstwerden.AktuellsollteeinAdd-Ondazugenutztwerden.FürFirefoxwäredaszumBeispielderUser-
FeinheitenFrontend-Modul-Definition
Templates
NurGästenanzeigen
Modulschützen
Selbstzählungverhindern
HandbuchfürdieContaoErweiterungVisitors-FeinheitenFrontend-Modul-Definition
-19-
Agent-Switcher
HandbuchfürdieContaoErweiterungVisitors-FeinheitenFrontend-Modul-Definition
-20-
DieInsert-TagswerdenvomFrontendModulselbstbenutzt.EinNutzerbenötigtdiesenur,wenndasFrontendModulnichteingesetztwird.DerEinsatzistdahernuretwasfürfortgeschritteneNutzer.
Insert-Tags
HandbuchfürdieContaoErweiterungVisitors-Insert-Tags
-21-
EsgibtfolgendeInsert-TagszumAnzeigenderWerte:
{{visitors::katid::name}}
{{visitors::katid::online}}
{{visitors::katid::start}}
{{visitors::katid::totalvisit}}
{{visitors::katid::totalhit}}
{{visitors::katid::todayvisit}}
{{visitors::katid::todayhit}}
{{visitors::katid::averagevisits}}
DieInsert-TagskönnenumdenPräfix'cache_'erweitertwerden,damitsinddiesedannauchsichervordemCache.Dasbedeutet,dassselbstwenndieSeiteausdemContaoCachekommt,werdenvordemSendenzumBrowserdieWertenochaktualisiert.
{{cache_visitors::katid::name}}
...
DasModulzähltundzeigtnormalerweisedieWertean.WerfürdieAnzeigedieInsert-Tagsnutzenwill,brauchtdasModulweiterhin,abernurzumZählen.MittelsdesTemplatesmod_visitors_fe_invisiblekannesdazuunsichtbargeschaltetwerden.
Die"katid"istdieKategorie-ID,indemderZählerangelegtwurde.ZurErmittlungindieKategorieübersichtgehen,dortstehtdieIDdirekthinterdemKategorie-Namen.
BeiKategorie-ID=1wäredasdannalsobeispielsweise:
{{cache_visitors::1::online}}
Anzeige
HandbuchfürdieContaoErweiterungVisitors-Anzeige
-22-
EineAlternativefür"nurzählen"wäre,denInsert-Tagzunutzen,dasModulselbstverwendetdiesenebenfalls:
{{cache_visitors::katid::count}}
BeispielfürEinbauineinenArtikel(fürKategorie-ID=1):
<spanstyle="width:0px;height:0px;">{{cache_visitors::1::count}}</span>
Achtung:Dabeimussdraufgeachtetwerden,dassderInsert-TagfürdieZählungalserstesaufderSeiteeingebautwird,damitdieZählungvorderErmittlungderAnzeigewerteerfolgt.
Zählung
HandbuchfürdieContaoErweiterungVisitors-Zählung
-23-
EsgibtInsert-TagszumAnzeigenderWertevomTag,andemdiemeistenBesuchergezähltwurden.
{{visitors::katid::bestday::date}}-Tag(Datum)mitdenmeistenBesuchern
{{visitors::katid::bestday::visits}}-AnzahlBesuchervomTagmitdenmeistenBesuchern
{{visitors::katid::bestday::hits}}-AnzahlZugriffevomTagmitdenmeistenBesuchern
bzw.
{{cache_visitors::katid::bestday::date}}
{{cache_visitors::katid::bestday::visits}}
{{cache_visitors::katid::bestday::hits}}
Beim"date"Insert-TagistnocheinoptionalerParametermöglich,umdieDatumsausgabezuformatieren.(m.d.Y,Y-m-d,etc.)
AlsdefaultwirddieSystemeinstellungverwendet.AlsTrennzeichenmussein"::"verwendetwerden.EinkomplettesBeispiel(hiermitKategorie1):
BestDay:{{visitors::1::bestday::date::j.FY}}mit{{visitors::1::bestday::visits}}Besuchern
(bei{{visitors::1::bestday::hits}}Hits)
ergibtzumBeispiel:
BestDay:31.August2010mit25Besuchern(bei123Hits)
WeitereInsert-Tags
HandbuchfürdieContaoErweiterungVisitors-WeitereInsert-Tags
-24-
HierfolgeneinigeBesonderheitendiezubeachtensind.
Besonderheiten
HandbuchfürdieContaoErweiterungVisitors-Besonderheiten
-25-
EswirdkeinFrontend-Aufrufgezählt,wennderselbeNutzerdabeigleichzeitigimBackendangemeldetist.EsmusseinFrontendModulangelegtundeingebundenwerden,bzw.alsAlternativederInsert-TagfürdieZählung(nurfürProfis),sonstkannnatürlichnichtgezähltwerden.
KeineZählung
HandbuchfürdieContaoErweiterungVisitors-KeineZählung
-26-
DerDurschnittswertproTagwirdprovollständigemKalendertagberechnet.GibtesnurvoneinemTagvorherodergarnurvomaktuellemTageineZählung,kannkeinsinnvollerWertberechnetwerden.(Durschnitt=AnzahlBesucher)
IndiesenFällenwird"0"angezeigt.
BesucherproTag:Ø=0
HandbuchfürdieContaoErweiterungVisitors-BesucherproTag:Ø=0
-27-
WerdieZugriffevonBotsundSuchmaschinenmitzählenmöchte,kanndieBotDetectionabschalten.DasgehtallerdingsnichtüberdasBackend,sondernmussüberdielocalconfig.phppassieren.
Achtung:DasgiltdannfüralleBesucher-Module,fallsmehrereFrontendModuleangelegtwurden!
FolgenderEintragansEndederlocalconfig.php(nach:###INSTALLSCRIPTSTOP###)bewirktdasAusschalten:
$GLOBALS['TL_CONFIG']['mod_visitors_bot_check']=false;
BotDetectionabschalten
HandbuchfürdieContaoErweiterungVisitors-BotDetectionabschalten
-28-
EinigeWortezumThemaDatenschutz.ImGegensatzzudenmeistenanderenBesucherstatistik-Tools,speichertVisitorsnichtdieRohdatenundwertetdiesespäteraus.DienotwendigenAuswertungenwerdensofortausgeführt.GespeichertwerdenalsodiefertigenStatistikDaten,mitAußnahmederIP-Adresse,siehedazudieHinweiseindenweiterenKapiteln.SomitistdasZielderDatenvermeidungundDatenminimierungbestmöglicherreicht.
Datenschutz
HandbuchfürdieContaoErweiterungVisitors-Datenschutz
-29-
ZurErkennungvonunterschiedlichenBesuchernwirdausschließlichdieIP-Adressegenommen,keinJavaScript,keineCookies.
FürzusätzlicheStatistikenwirdderBrowser-AgentausgelesenundderReferrersofernvorhanden.BeideswirdunabhängigvonderIP-AdressegetrenntgespeichertundkannsomitauchnichtinVerbindunggebrachtwerden.(reineZählung)
Datenerfassung
IP-Adresse
Browser-AgentundReferrer
HandbuchfürdieContaoErweiterungVisitors-Datenerfassung
-30-
GespeichertwirdnichtdieIP-AdressedesBesuchers.MitAußnahmezurErkennungvonBots/Crawler/SpidernwirddieIP-AdresseauchnichtzuweiterenAnalysezweckenverwendet.
AusderIP-AdresseundweitereninternenDatenwirdeinPseudonymgeneriertinFormeinesHashwertes.EinRückrechnenistdenkbar,abernurmiterheblichemAufwand.DerHashwertwirdmitkeineranderenstatistischenAuswertunginVerbindunggebracht.
FürdenBrowser-AgentwerdendieKombinationenausBrowser,Sprache,OSmiteinemZählstandgespeichert,nichtderkompletteAgentString.
BeimReferrerwirddieURLgespeichertmitZählstandundZeitstempeldesletztenAuftretens,ohneVerbindungzurIP-AdresseoderBrowser-Agent.
Datenspeicherung
IP-Adresse
Browser-AgentundReferrer
HandbuchfürdieContaoErweiterungVisitors-Datenspeicherung
-31-
DieHashwertezurErkennungvonunterschiedlichenBesuchernwerdenbeijedemAufrufgeprüft,zeitlichabgelaufendewerdendabeigelöscht.HaltezeitentsprichtdabeiderBlockzeit,Default-Wertist1800Sekunden,d.h.30Minuten.
ReferrerWertewerdenjenachArtderzeitnach90bzw.120Tagengelöscht.
DieAnzahlderBesucher/ZugriffejeTagwirddauerhaftgespeichert,darauswerdendieweiterenAnzeigengeneriert.DieseSpeicherungkannüberdasBackendgelöschtwerden,derZählerfängtdannwiederbei0an.
Datenhaltung
HandbuchfürdieContaoErweiterungVisitors-Datenhaltung
-32-