DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

EXT: PDF Download Tracker

Author:Christopher
Created:2010-12-18T19:57:23
Changed:2013-03-14T00:52:26
Classification:dbdownloadtracker
Description:The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) ----
Keywords:pdf, zip, download tracker, google analytics
Author:David Bascom
Email:david@99grad.de
Language:en

img-1 img-2 EXT: PDF Download Tracker

Extension Key: dbdownloadtracker

Language: de

Version: 1.0.0

Keywords: tracking, google analytics, PDF download statistik

Copyright 2006-2013, David Bascom, <david@99grad.de>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.org

Table of Contents

`EXT: Name of your Extension 1 <#__RefHeading__5708_1738894311>`_

`Introduction 3 <#__RefHeading__5710_1738894311>`_

What does it do? 3

Screenshots 3

`Users manual 4 <#__RefHeading__467_413120346>`_

Subheading 4

FAQ 4

`Administration 5 <#__RefHeading__31511_818911409>`_

FAQ 5

`Configuration 6 <#__RefHeading__31515_818911409>`_

FAQ 6

Reference 6

`Tutorial 8 <#__RefHeading__31523_818911409>`_

`Known problems 9 <#__RefHeading__31525_818911409>`_

`To-Do list 10 <#__RefHeading__477_413120346>`_

`ChangeLog 11 <#__RefHeading__31623_818911409>`_

`Important guidelines 12 <#__RefHeading__31625_818911409>`_

Inserting images 12

Fonts 12

Paragraph styles 12

Character styles 13

Linking 13

Meta data and updates 13

HowTo: Update a manual to the new layout 13

HowTo: Alternative updating possibility: Import the styles from another document 14

HowTo: Fix the Table Of Contents when it is empty 15

HowTo: Fix the Table Of Contents when a chapter is missing 15

Help from documentation.openoffice.org 15

Introduction

What does it do?

A simple reporting tool to track how often PDF and Zip-Files were downloaded from the site. Shows a table of the top downloads in the backend and – in case Google Analytics is in use – automatically sends a report to Analytics for every download initiated.

The tracking list of PDF-downloads can be filtered by date and page in the navigation tree. The tracking works globally for the complete site and all linked PDFs. Existing links don't need to be modified.

Screenshots

img-3 View in the backend: The top-downloads are listed in a table.

Users manual

  • Install the extension dbdownloadtracker with the extension manager.
  • Click on the module „Download Tracker“ in the „Web“ module.
  • For viewing the statistics of a certain page: Click on the page in the page tree and select „Ausgewählte Seite“ from the left option-box.

FAQ

Which type of files does dbdownloadtracker track?

Currently it only will track pdf and zip files, but this could easily extended to other filetypes.

How can I setup additional tracking in Google Analytics?

Simply insert the Google Analytics _gaq-code in your page by either modifying your template or installing an extension. dbdownloadtracker will automatically recognize the Tracking ID and send a note to Google Analytics when somebody clicks a PDF.

Administration

See section „configuration“ for further information

Configuration

Reference

Possible subsections: Reference of TypoScript options.

trackBackend

Property

trackBackend

Data type

boolean

Description

If set, the downloads of the pdfs will be tracked and displayed as a table in the backend.

Default

1

trackGoogle

Property

trackGoogle

Data type

boolean

Description

If set, the downloads will also be tracked by Google Analytics. Make sure the _gaq-code is in the body of your document.

Default

1

[tsref:plugin.tx_dbdownloadtracker_pi1]

Example

Disable Google Analytics tracking:

plugin.tx_dbdownloadtracker_pi1.trackGoogle = 0

The extension automatically adds jQuery to your document. In case you already have jQuery in use, you can disable the inclusion:

page.includeJSlibs.jquery_core >

Tutorial

Too simple to be explained in a tutorial :)

Known problems

  • The extension uses the jQuery framework and might cause conflicts with other frameworks using the $-symbol as object reference like mootools.
  • In case jQuery is already included in your header, you might want to disable the inclusion with the command mentioned in the chapter before.

To-Do list

Nothing…

ChangeLog

1.0.0

Version

1.0.0

Changes

First publication of the extension