.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ======================= 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 .. _img-1-img-2-EXT-Christmas-Calendar: |img-1| |img-2| 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: Table of Contents ----------------- **`EXT: Christmas Calendar 1 <#__RefHeading__5708_1738894311>`_** **`Introduction 3 <#__RefHeading__5710_1738894311>`_** `What does it do? 3 <#__RefHeading__463_413120346>`_ `Screenshots 3 <#__RefHeading__465_413120346>`_ **`Users/Administrator manual 5 <#__RefHeading__467_413120346>`_** **`Configuration 6 <#__RefHeading__31515_818911409>`_** `TypoScript Reference 6 <#__RefHeading__31519_818911409>`_ **`Known problems 8 <#__RefHeading__31525_818911409>`_** **`Roadmap 9 <#__RefHeading__477_413120346>`_** **`ChangeLog 10 <#__RefHeading__31623_818911409>`_** .. _Introduction: Introduction ------------ .. _What-does-it-do: 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: Screenshots ^^^^^^^^^^^ Here you see what the extension does: |img-3| Screen #1: Adding an event to the calendar. |img-4| Screen #2: The Christmas Calendar (from 1st to 24th DECEMBER) |img-5| Screen #3: The event/news view in lightbox. .. _Users-Administrator-manual: 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: Configuration ------------- This section lists the possible Constant and Setup TypoScript options for this extension. .. _TypoScript-Reference: TypoScript Reference ^^^^^^^^^^^^^^^^^^^^ .. _Setup: Setup """"" .. ### BEGIN~OF~TABLE ### .. _templateFile: templateFile ~~~~~~~~~~~~ .. container:: table-row Property templateFile Data type string Description Path to plugin's template Default typo3conf/ext/ix\_christmas\_calendar/pi1/templates/template.html .. _xmasCalStoragePid: xmasCalStoragePid ~~~~~~~~~~~~~~~~~ .. container:: table-row Property xmasCalStoragePid Data type int Description Page ID to sysFolder containing Christmas Calendar records. Make sure you update this value. Default .. _xmsTestMode: xmsTestMode ~~~~~~~~~~~ .. container:: table-row Property xmsTestMode Data type boolean Description Simulates current month and day as December and 30th respectively. Default 0 .. _jqueryJSPath: jqueryJSPath ~~~~~~~~~~~~ .. container:: table-row Property jqueryJSPath Data type string Description Path to Calendar JS file Default typo3conf/ext/ix\_christmas\_calendar/res/christmascalander.js .. _snowJSPath: snowJSPath ~~~~~~~~~~ .. container:: table-row Property snowJSPath Data type string Description Path to Snowfall JS file Default typo3conf/ext/ix\_christmas\_calendar/res/snowfall.min.jquery.js .. _xmasCss: xmasCss ~~~~~~~ .. container:: table-row Property xmasCss Data type string Description Path to Calendar CSS file Default typo3conf/ext/ix\_christmas\_calendar/res/christmascalander\_basic.css .. _detail-file-maxH: detail.file.maxH ~~~~~~~~~~~~~~~~ .. container:: table-row Property detail.file.maxH Data type int Description Max height for the event image (shown in lightbox). Default 135 .. _detail-file-maxW: detail.file.maxW ~~~~~~~~~~~~~~~~ .. container:: table-row Property detail.file.maxW Data type int Description Max width for the event image (shown in lightbox). Default 135 .. _detail-file-imagepath: detail.file.imagepath ~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property detail.file.imagepath Data type string Description Folder where event images are placed/fetched from Default uploads/tx\_ixchristmascalendar/ .. _dateimgPath: dateimgPath ~~~~~~~~~~~ .. container:: table-row 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: general\_stdWrap.parseFunc ~~~~~~~~~~~~~~~~~~~~~~~~~~ .. container:: table-row Property general\_stdWrap.parseFunc Data type stdWrap Description StdWrap Default tt\_content.text.20.parseFunc .. ###### END~OF~TABLE ###### .. _Sample: 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: 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: 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: ChangeLog --------- .. ### BEGIN~OF~TABLE ### .. _2-0-3: 2.0.3 ^^^^^ .. container:: table-row Version 2.0.3 Changes Extension manual formatting updated. .. _2-0-2: 2.0.2 ^^^^^ .. container:: table-row Version 2.0.2 Changes Extension manual updated with new extension features and roadmap also listed. .. _2-0-1: 2.0.1 ^^^^^ .. container:: table-row Version 2.0.1 Changes Extension manual added. .. _2-0-0: 2.0.0 ^^^^^ .. container:: table-row Version 2.0.0 Changes Bug fixing and some effects added. .. _1-0-0: 1.0.0 ^^^^^ .. container:: table-row Version 1.0.0 Changes Wrote the code of the extension. .. ###### END~OF~TABLE ###### .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. :border: 0 .. :height: 44 .. :id: graphics5 .. :name: graphics5 .. :vspace: 57 .. :width: 161 .. |img-2| image:: img-2.png .. :align: left .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 408 .. :id: graphics6 .. :name: graphics6 .. :width: 409 .. |img-4| image:: img-4.png .. :align: left .. :border: 0 .. :height: 180 .. :id: graphics7 .. :name: graphics7 .. :width: 631 .. |img-5| image:: img-5.png .. :align: left .. :border: 0 .. :height: 269 .. :id: graphics1 .. :name: graphics1 .. :width: 631