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: ast_countdown¶
Author: | Kasper Skårhøj |
---|---|
Created: | 2002-11-01T00:32:00 |
Changed by: | André Steiling |
Changed: | 2008-03-06T14:53:42 |
Author: | André Steiling |
Email: | steiling@pilotprojekt.com |
Info 3: | high StandArt, PILOTprojekt } |
Info 4: |
EXT: ast_countdown¶
Extension Key: ast_countdown
Copyright 2000-2002, André Steiling, <steiling@pilotprojekt.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: My Extension 1
Introduction 1
What does it do? 1
Screenshots 1
Users manual 1
FAQ 1
Adminstration 1
FAQ 2
Configuration 2
FAQ 2
Reference 2
Tutorial 2
Known problems 2
To-Do list 2
Changelog 2
Introduction¶
What does it do?¶
- The extension provides a graphical countdown (output format: dd[d]:hh:ii:ss) to a specific date. You can setup the plugin easily by using Flexforms or Typoscript for including the countdown in the whole site.
Users manual¶
Just install the extension and select “new content element -> plugin” at any page you want the plugin to be shown. Select “AST Countdown”. The Flexforms will show you two tabs for setting up the plugin:
First tab “Display and Date”:
The date to count down : Just a put in the date/ time you want
Day digit length: If you want to show three digits for the days instead of two (default)
Headline: The headline above the countdown. You can use HTML tags for better formating. See screenshot or Typoscript reference.
Second tab “Alternative digits”:
Digit path: Enter the path to your alternative digit images. Set it absolute!
Digit width: Enter the width of your digits.
Digit height: Enter the height of your digits.
Attention: The digits must be namend form c0.gif up to c9.gif. The seperators between days, hours and mintues are named as followed: ctd.gif (days), cth.gif (hours) and ctm.gif (minutes). By default, these three images don't differ, but feel free to seperate the digits by your own style ... :)
Adminstration¶
- See configuration
Configuration¶
- For showing the countdown only at one page, the Flexforms setup is the right way, but when you want to include the countdown in the whole site, you should pay attention at this section! Doing this job you can use Typoscript like in the example below. Please have a look into the TYPO3 Typoscript documentation, if you have problems understanding the stuff!
Typoscript Reference¶
cDate¶
Property
cDate
Data type
String
Description
Syntax: yyyy,mm,dd,hh,mm,ss
Setting the date by Typoscript is easy,but pay attention for a little nastiness:
The date is transfered to a Javascript date object, so start counting the month beginning at 0 for january and so on (enter the date by Flexforms will convert it automatically!).
For example you want to set the date to 01.01.2010, 8:00 am, so you have to enter: 2010,0,1,8,0,0!
Default
2010,0,1,0,0,0
cDayLen¶
Property
cDayLen
Data type
int
Description
Select if you want to show rather two or three digits for the days
Default
2
cHead¶
Property
cHead
Data type
string
Description
The headline above the countdown. You can use HTML tags for better formating.
Example:
<h4>Countdown</h4><p>Only <em>days : hours : mins : secs</em> up to the event!</p>
Default
See example!
imgPath¶
Property
imgPath
Data type
string
Description
When you want to use your own digit images, set up the absolute path to your images here. Leave it blank for using the default ones.
Default
imgWidth¶
Property
imgWidth
Data type
int
Description
The width of your alternative digits.
Default
imgHeight¶
Property
imgHeight
Data type
int
Description
The height of your alternative digits.
Default
[tsref:(cObject).TEST]
((generated))¶
Example¶
A simple setup for including the countdown after the main menu of my site:
temp.vMenu = COBJ_ARRAY
temp.vMenu {
10 < temp.mainMenu
20 < plugin.tx_astcountdown_pi1
20.cHead = <h4>Countdown</h4><p>Only <em>days : hours : mins : secs</em> up to the event!</p>
20.cDate >
20.cDate = 2007,8,28,8,0,0
20.cDayLen = 3
[...]
}
Known problems¶
- IMPORTANT: You sould only use one way to configure the extension, NOT Flexforms AND Typoscript at once! Until now, I did not remove the Typoscript. I only added the Flexforms support and forced the extension to use these settings before all other.
To-Do list¶
- Nothing, or not?
Changelog¶
- V 1.0.0: Initial release
- V 1.0.2: Bugfix release
- V 1.1.0: Added support for three digits for the days
- V 1.2.0: Added flexforms support for the plugin
- V 1.2.1: Some cosmetic changes
- V 1.2.2: Some cosmetic changes
- V 1.2.3: Added support for seperate digits seperator between days,hours and mintues.Also added a new extension icon.
EXT: ast_countdown - 3