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: Christmas Calendar¶
Author: | Christopher |
---|---|
Created: | 2010-12-18T19:57:23 |
Changed by: | Aqeel Ahmad |
Changed: | 2013-11-23T21:19:20.720000000 |
Classification: | ix_christmas_calendar |
Description: | An event Christmas Calendar by Christoph Gschier, IXSOL. |
Keywords: | Christmas, Calendar, IXSOL |
Author: | Christoph Gschier |
Email: | christoph.gschier@ixsol.at |
Language: | en |
EXT: Christmas Calendar¶
Extension Key: ix_christmas_calendar
Language: en
Version: 2.0.3
Keywords: Christmas, Calendar, IXSOL
Copyright 2012-2013, Christoph Gschier, < Christoph.Gschier@ixsol.at >
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: Christmas Calendar 1 <#__RefHeading__5708_1738894311>`_
`Introduction 3 <#__RefHeading__5710_1738894311>`_
`Users/Administrator manual 5 <#__RefHeading__467_413120346>`_
`Configuration 6 <#__RefHeading__31515_818911409>`_
`Known problems 8 <#__RefHeading__31525_818911409>`_
`Roadmap 9 <#__RefHeading__477_413120346>`_
`ChangeLog 10 <#__RefHeading__31623_818911409>`_
Introduction¶
What does it do?¶
The extension offers you the ability to add an event or a news for each day of Christmas month (December). On the front-end, each day (that has an event linked to it) is displayed as Christmas tree, with a scenery and a snowfall effect. Clicking on those will open the news in a lightbox effect (see Screenshots below).
Screenshots¶
Here you see what the extension does:
Screen #1: Adding an event to the calendar.
Screen #2: The Christmas Calendar (from 1st to 24th DECEMBER)
Screen #3: The event/news view in lightbox.
Users/Administrator manual¶
This section explains how you can use the extension and make it work.
Create a sysFolder, and name it 'Christmas Calendar' or something appropriate.
This extension adds another record type: 'Christmas Calendar', records of which you can create/manage in that sysFolder. Each record allows you to enter the following fields: title, date/day, description and an image.
On the frontend, the plugin will list all records on the Christmas Calendar added under a sysFolder, the ID of which is specified in the 'setup' TS of this extension (see Configuration section).
This extension has been categorized as a 'front-end' plugin, so choose this extension using the 'typo3 General plugin' content element, on a page where you want to show this content.
In the frontend configuration, you'll also get an option to upload an audio (.mp3) file to play in the background of the calendar, this option appears when you insert the plugin on a page.
On that page, the static TS template provided by this extension ('christmascalendar') must also be included (see default TS in Configuration section).
More about Constants and Setup TS can be found under 'Configuration' section.
Similar to 'Christmas Calendar' records, you need to define a 'common' record; title, description and an image, which will be shown in overlay for the dates not due yet. The record type name is 'Christmas Cal. - Content for due dates'. Make sure to add that in the same sysFolder as the calendar records.
On the frontend, the date images will appear as colored if they are in the past, otherwise, they will appear as gray-scaled.
Configuration¶
This section lists the possible Constant and Setup TypoScript options for this extension.
TypoScript Reference¶
Setup¶
templateFile¶
Property
templateFile
Data type
string
Description
Path to plugin's template
Default
typo3conf/ext/ix_christmas_calendar/pi1/templates/template.html
xmasCalStoragePid¶
Property
xmasCalStoragePid
Data type
int
Description
Page ID to sysFolder containing Christmas Calendar records. Make sure you update this value.
Default
xmsTestMode¶
Property
xmsTestMode
Data type
boolean
Description
Simulates current month and day as December and 30th respectively.
Default
0
jqueryJSPath¶
Property
jqueryJSPath
Data type
string
Description
Path to Calendar JS file
Default
typo3conf/ext/ix_christmas_calendar/res/christmascalander.js
snowJSPath¶
Property
snowJSPath
Data type
string
Description
Path to Snowfall JS file
Default
typo3conf/ext/ix_christmas_calendar/res/snowfall.min.jquery.js
xmasCss¶
Property
xmasCss
Data type
string
Description
Path to Calendar CSS file
Default
typo3conf/ext/ix_christmas_calendar/res/christmascalander_basic.css
detail.file.maxH¶
Property
detail.file.maxH
Data type
int
Description
Max height for the event image (shown in lightbox).
Default
135
detail.file.maxW¶
Property
detail.file.maxW
Data type
int
Description
Max width for the event image (shown in lightbox).
Default
135
detail.file.imagepath¶
Property
detail.file.imagepath
Data type
string
Description
Folder where event images are placed/fetched from
Default
uploads/tx_ixchristmascalendar/
dateimgPath¶
Property
dateimgPath
Data type
string
Description
Path to 'date' images. This folder would contain colored and greyed out images for dates from 1st to 24th.
Default
typo3conf/ext/ix_christmas_calendar/res/images/
general_stdWrap.parseFunc¶
Property
general_stdWrap.parseFunc
Data type
stdWrap
Description
StdWrap
Default
tt_content.text.20.parseFunc
Sample¶
Here is a sample of the plugin's 'setup' typoscript:
plugin.tx_ixchristmascalendar_pi1{
templateFile = typo3conf/ext/ix_christmas_calendar/pi1/templates/template.html
xmasCalStoragePid = 75
xmsTestMode = 0
jqueryJSPath = typo3conf/ext/ix_christmas_calendar/res/christmascalander.js
snowJSPath = typo3conf/ext/ix_christmas_calendar/res/snowfall.min.jquery.js
xmasCss = typo3conf/ext/ix_christmas_calendar/res/christmascalander_basic.css
detail {
file.maxH = 135
file.maxW = 135
imagepath = uploads/tx_ixchristmascalendar/
}
dateimgPath = typo3conf/ext/ix_christmas_calendar/res/images/
general_stdWrap {
parseFunc < tt_content.text.20.parseFunc
}
}
Known problems¶
- The snowfall effect tends to slow the user's/client's browser, after all it is a javascript and is directly depending on that user's system resources.
- The extension assumes that jQuery (v 1.7+) is included before this plugin's scripts.
- No other issues known at this time.
- If you find any issue, please report back to us at info@ixsol.at .
Roadmap¶
The features below are not part of this release. Please contact us at info@ixsol.at for the updated release.
- Ability to change from extension configuration or typoscript:
- Background image
- Change text colors in the overlay
- Change date icons for both passed and not due dates
- To change calendar layout or size.
- For a responsive version of the extension, please contact us .
ChangeLog¶
2.0.3¶
Version
2.0.3
Changes
Extension manual formatting updated.
2.0.2¶
Version
2.0.2
Changes
Extension manual updated with new extension features and roadmap also listed.
2.0.1¶
Version
2.0.1
Changes
Extension manual added.
2.0.0¶
Version
2.0.0
Changes
Bug fixing and some effects added.
1.0.0¶
Version
1.0.0
Changes
Wrote the code of the extension.