Revision as of 20:26, 12 September 2010

I'm not a native English speaker. Please correct my mistakes.

Incomplete Article: This article is not finished yet and needs expansion. Please expand it and remove this notice when it is finished.

In the display appears the hits and visits from the current day, as well as the respective total. Statistic is also in the backend.

Forum

Questions about the Visitors module will be answered in forum: Forum
Errors and requests can be reported in the Issue Tracker.

Installation

The installation of the module occurs about the extension Repository in back end of Contao.
A manual installation is possible. Download the ZIP file from Extension Repository, unzip and transfer it.
A directory should have been created "/system/modules/visitors".
Then call /contao/install.php - Perform Update Database.
( /typolight/install.php in older TYPOlight installations )

The module Visitors is dependent on the module "Bot Detection". It must therefore be installed with manual installation.

Note for older "TYPOlight" versions

TYPOlight 2.8

Users of TYPOlight 2.8.x, please use Visitors Modul Version 1.7.1 (Direct Link)

TYPOlight 2.7

Users of TYPOlight 2.7.x, please use Visitors Modul Version 1.4.1 (Direct Link)

Update version 1.x to version 2.x

Caution: Version 2.x is not fully compatible with previous versions, an update is possible.

What is to be observed, can be found here.

• Visitors Update Version 1 to Version 2

Overview

The Visitors module contains two back end and one front end module.
In the back end, there are "Visitors" and "Visitor Statistics", for the front end "Visitors".

Back end

(Images will be filed later.)

Visitors

Datei:Visitors_de_backend_besucher.jpg

Visitors Statistics

Datei:Visitors_de_backend_besucherstatistik.jpg

shows in detail: (Click on image for higher resolution)

• Visitors Statistics
• Visitors de backend besucherstatistikdetail.jpg

  Visitors Statistics

• Visitors de backend besucherstatistikdetailBrowser.jpg

  Browser Statistics

• Visitors de backend besucherstatistikdetailSearchEngine.jpg

  Search Engine Referer Statistics

Front end

For the front end are provided two CSS files as an example:

• mod_visitors_fe.css for the normal output, line by line
• mod_visitors_fe_horizontal.css for the horizontal output

Visitors Statistics

Datei:Modul_visitors_fe_all.jpg

Visitors Statistics, horizontal

Datei:Modul_visitors_fe_all_horizontal.jpg

Using

The first one creates a new visitor category via the menu item "visitors". In this then the counter.
Then, create a front end module and build it into the layout of the page.
Here are the steps, each with the default values. Technical details will be explained later.

Create the category

To create a new category, just click on the left in the back end in 'content' to 'Visitors'. In the main area click on the button 'New category'.
Datei:Visitors_de_backend_kategorie_neu.jpg
There, enter the name of the category. The front end module will later use this name. Then you click on "Save and close".
Now you can see the category overview. By clicking on the pencil in the line of the category and repeated clicking on the pencil in the head of the category you return to the settings of the category.

Create new counter

In the category list now clicking on Edit (pencil) of the category.
Now, either click the 'New counter' and then the arrow icon, or click the plus in the head of the category:
Datei:Visitors_de_backend_besucherzaehler_neu.jpg

Now, some information are needed: :

• Name, (is displayed as a heading on the numbers).
• Start date, optional, only for display in font end
• Optional: 'Initial value of visitors/hits'
• Optional: 'Visitors per day'
• Activate "Published"

Then you click on "Save and close".

Front end Module

A new front-end module is create with:

• Layout -> Themes -> Modules -> Add module (Contao 2.9)
• Layout -> Modules -> Add module (TYPOlight 2.8.x)

At first, enter the title, and only then select in "Module type": 'Miscellaneous'-'Visitors'. It changes the form fields.
In 'Visitors category' now select the previously created category, then 'Save and close'.

Now, the front end module must be included in the layout:

• Layout -> Themes -> Layout -> Edit the used layout (Contao 2.9 and newer)
• Layout -> Page layout -> Edit the used layout (TYPOlight 2.8.x)

Include in 'Included modules' the just-created front end module (e.g. to left)

CSS-File

As mentioned above, are provided two CSS file for presentation.
For the first tests you should copy the file mod_visitors_fe.css from /system/modules/visitors to /tl_files . Then import them over the back end and activate it in the layout.