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: th_popular¶
Author: | Kasper Skårhøj |
---|---|
Created: | 2002-11-01T00:32:00 |
Changed: | 2005-02-02T17:17:26 |
Author: | Peter Luser |
Email: | netdog@typoheads.com |
Info 3: | |
Info 4: |
EXT: th_popular¶
Extension Key: th_popular
Copyright 2004-2005, Peter Luser, <netdog@typoheads.com>
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.com
Table of Contents¶
EXT: th_popular 1
Introduction 1
What does it do? 1
Screenshots 2
Users manual 2
FAQ 2
Adminstration 2
Configuration 3
Known problems 3
To-Do list 3
Changelog 3
Introduction¶
What does it do?¶
The idea of this extnsion came up when a friend of mine wanted to switch from MAMBO to Typo3. He was using a functionality showing the most popular pages (whatever that means in MAMBO).
Of course Typo3 also has to have such an extension i thougt – and here it is.
This extension is based on the VTS (visitor tracking system) you can find as “de_phpot” extension. This allows to specify the period of what “popular” means for you. For example on pages with many hits and many news you can select “hour” and you get the most popular pages of the last hour. Or you can choose “today” or “yesterday” if you don't have so much traffic on the page.
Of course you can also specify pages that should not be displayed (like the entrance page).
Users manual¶
Simply insert a “plugin” element on the page and choose “th_popular” from the pulldown. Click on “save” and adopt the plugin to your needs.
FAQ¶
Q: What does the “max items” setting do?
A: This limits the shown results to the number you inserted in the “max items” field. It can happen that there are less items displayed than you have configured. This happens when you fill out the “do not show these pages” field.
Q: I don't want to display the page header, but the navigation-title of the page. How can i do that?
A: See “Administration”-section in this document: this can be configured via typoscript.
Adminstration¶
((generated))¶
Typoscript:¶
template¶
Property
template
Data type
string
Description
The output of the list is specified in a HTML-template. You may use a different layout on different pages.
Example :
plugin.tx_thpopular_pi1.template = EXT:th_popular/pi1/popular_template.tmpl
showText¶
Property
showText
Data type
string
Description
By default the ###TITLE### placeholder is filled with the “header” field from the “page” table.
Insert a DB-field of your choice here if you want to show a different field from the “page” table.
Example :
plugin.tx_thpopular_pi1.showText = nav_title
[plugin.tx_thpopular_pi1]
Configuration¶
((generated))¶
HTML-template:¶
Example:¶
<!-- ###TEMPLATE_POPULAR### begin
This is the template for the list of found pages
-->
Die populärsten Seiten (###RANGE###):<br>
<!-- ###ITEM### begin
one item
-->
###COUNT###. <a href="###LINK###">###TITLE###</a> (###PERCENT### %)<br>
<!-- ###ITEM### end -->
<!-- ###TEMPLATE_POPULAR### end -->
Description:¶
this parameter can be used in the global HTML-template:
###ITEM_COUNT###: ... show the total number of found results
these markers can be used within the ITEM subtemplate:
###PID###: ...... page-ID
###COUNT###: .... item-counter
###AMOUNT###: ... sum of hits on the page
###PERCENT###:... percentage how popular this page is
###TITLE###: .... title of the page
###LINK###: ..... link (without <a> tag!) to the page
Known problems¶
No know problems so far.
To-Do list¶
- Currently the “client-id” which can be set within the VTS for configuring the VTS for multiple pages on one typo installation is not used in this extension.