Counter and Referer Script Documentation

Thank you for your interest in our Script. We recommend that you carefully read this documentation.

Introduction

Our Counter and Referer Script provides two options. On the one hand you can count the page visits and on the other hand you can log the extern referers.

The script has been configured in a way that makes it ready to use. You only need to upload all script files to your web server. You can call the script directly in your browser or can include it into an existing page. Further information about including the script can be found in chapter "Including the script".

When you edit the script you should do it step by step. After each change you should run the script to monitor the effects. Doing so enables you to know what change eventually causes an error.

The HTML templates of the script have been generated by the specifications of XHTML 1.0. HTML tags like <br> or <input> contain an ending slash (<br /> or <input type=“text“ name=“field“ />).

Back To Top

Set up and configuration

The file "index.php" can be viewed as the configuration file for the script. It is possible to duplicate the file and set it up in a different manner. That enables you to run several counters with the same script core.

The following variables can be edited:

$language		You can set here the language. Enter here the abbreviation that also is used in the name of the language file in the directory "languages" (en in languages.en.inc.php and de in languages.de.inc.php).
$log_referers		With this variable you can decide, whether extern referring pages are logged. If you use this feature, please make sure that the directory "logfiles" and the file "referer.txt" have writing permissions (chmod 777).
$count_visitors		With this variable you can decide, whether the page visits are counted. If you use this feature, please make sure that the directory "logfiles" and the file "referer.txt" have writing permissions (chmod 777).
$display_errors		The default value of this variable is "yes" so during the configuration process you will get error messages and hints that help you to install the script. Once the script configuration have been finished you can set off these system messages because it is not necessary to give extern visitors a view in the system.
$script_root		Enter here the server path to the script. The path can be relative (./counter_script/ or counter_script/). It can also be absolute (/usr/local/etc/httpd/.../counter_script/). Please be sure to include the ending slash.
$path['templates']		This file contains the path to the directory where the HTML template are stored.
$path['logfiles']		This file contains the path to the directory where the log files are stored.
$temp['template']		This variable contains the file name of the HTML template.
$file['referer']		This variable contains the name of the file where the referers are logged.
$file['count']		This is the name of the file, where the downloads are counted.
$add_text		You can add further values, text, variables or other content to this variable. That content can be displayed in the HTML templates by using markers/placeholders within curly brackets { and }.
		If you want to add your own values to the variable $add_text please follow the pattern from the example entries.

   $add_text = array(

                       'txt_additional' => 'Additional',
                       'txt_more'       => 'More'

                     );

The first part of each entry is the name of the placeholder. In case you want to use the value of txt_addition in your template enter the name of the entry with curly brackets - {txt_addition}. The name must not contain white spaces or special characters. Only allowed is the _ .

Back To Top

HTML template customization

The directory "/templates/" contains the files for the layout. You can use HTML and CSS to customize the layout as you wish.

In case you are using a WYSIWYG editor like Macromedia Dreamweaver, MS Frontpage or NetObjects Fusion please make sure that the software does not make any changes by itself. In any event it is recommended to use text editors to edit the HTML templates.

The template files contain markers with { and } like: {txt_next_page}. These markers will be replaced by its counterparts from the language file "languages/language.en.inc.php". You are free to edit that file and change the words and phrases. You are also free to replace the markers within the template files by real words or put those markers to other positions within the template file. And you are also able to enhance the language file by using the given pattern.

Amongst those word markers exist the so called loops. Similar to HTML tags the two parts (<LOOP …>…</LOOP>) must not be separated. If you want to alter the position within the template you move the hole block.

The loop block to display is "visits". The loop block contains the image tag with the path to the number images. The variable {image_name} will be replaced by the numbers of the page visits. if you want to create and use your own images, you can edit the path as you wish.

Back To Top

Upload script files

Create the following folder on your web server (with the most FTP clients you are able just to copy the hole script with all folders in one go):

 /counter_script/
 /counter_script/inc/
 /counter_script/languages/
 /counter_script/logfiles/
 /counter_script/templates/

Copy all files to their corresponding folder. Image files (.gif, .jpg, .png) have to be uploaded in binary mode. Every other files have to be uploaded in ASCII mode (text mode).

Please note: The folder “templates” contains a folder with images.

Back To Top

The Log Files

The folder “logfiles” and the files “referer.txt” and “count.txt” need to be writable (chmod 777).

Back To Top

Including the Voting Script

You can include the script in different ways.

Direct Linking

You can set a direct link to the script and use it as an independent page. You can customize the HTML template to fit in your website layout.

SSI Include

In case your server supports SSI (Server Side Includes) you can include the script with following line:

Replace "./counter_script/index.php " with the correct path to your script.

If that doesn't work please rename your HTML file into .shtml. Please ask also your webspace provider, whether your server supports SSI.

PHP Include

You can include the script in an existing PHP file by using the include() instruction:

 <?php

     include('./counter_script/index.php ');

 ?>

Replace "./counter_script/index.php" with the correct path to your script.

Back To Top

Support and Help

For the answers to your questions about Form Mail, and for the solutions to your problems with Form Mail, visit our support forum.

Back To Top

License Information

You can use the Formail Script for free. If you want to run the script without the link to STADTAUS.com you can purchase the full version online.

You may redistribute the script license to a third party.
You may stipulate your own price.
The script license applies for a single domain.

Contact: http://www.stadtaus.com/en/

More Scripts at STADTAUS.com:

Image Gallery Script
Google Dance Tool
Form Mail Script
Tell A Friend Script
Download Script
Guestbook Script
Voting Script
Counter and Referer Script
Online Appointment Planner

Please visit our project MetaCollection. It is a resource for CGI and PHP related script archives.

http://www.metacollection.com/

Back To Top