News event: Events for the versatile news system - SVN
Contents
1. Start date Start date of the event Note If the start date has been left empty or undefined the event will not Yes be visible in the frontend Start time Start time of the event No End date End date of the event This makes an event multiple days unless this date is the same as the start No date In this case you don t have to define the end date End time End time of a the event No Location Location where the event takes place For instance Washington D C No TYPO3 v News event Events for the versatile news system roq_newsevent Administration Administration Archiving News records are archived by using the archive date restriction or time restriction settings These settings are not used for news events records and archiving for events works a bit differently Events which are current or will occur in the future based on the event data are known as active and all past events are known as archived You must select either active or archived when configuring an added news plugin for news events See the section Configuration gt Plugin for more information RSS News event supports RSS feeds which is handled like an event list view plugin You can create an RSS feed exactly the same as adding an RSS feed for News See the manual for the news system extension for more information The default template for the output is stored in Resources Private Templates News EventList2. TYPO3 W News event settings News event Events for the versatile news system roq_newsevent See the table below for the specific news event settings which are defined by using plugin tx_news settings event lt property gt Configuration Property Data type Description Default orderByAllowed string List of fields which are allowed for sorting This setting appends tx_roqnewsevent_startdate the plugin tx_news settings orderByAllowed setting tx_roqnewsevent_starttime orderBy string Field ordering which is used to sort event records tx_roqnewsevent_startdate ASC tx_roqnewsevent_starttime ASC archived orderBy string Field ordering which is used to sort archived event records tx_roqnewsevent_startdate DESC tx_roqnewsevent_starttime DESC dateField string Field to use for dateMenu EventStartdate News event view settings See the table below for the specific news event view settings which are defined by using plugin tx_news event view lt property gt You can override these settings if you want to use your own Fluid templates for news event Property Data type Description Default templateRootPath dir Root path for the fluid templates for news event The plugin has EXT roq_newsevent Resources Private one controller with three actions named eventDateMenu Templates eventList and eventDetail Accordingly there have to be at least three fluid templates
3. Archive to only show all current and future events Past events will be shown if Archived has been selected You can use this on a seperate page on which you ve added the plugin as well to create an event archive section 3 Point the starting point to the sysfolder pid where you have stored the news event records 4 Save the plugin Optionally you can create a seperate event detail and list page as described in the news system documentation see section Add a plugin to a page In the example above the list view and detail view is the same page Because of this the plugin setting Show a single news record has been left empty Viewhelpers Every Fluid ViewHelper starts with lt f and you can always check out the code at typo3 sysext fluid Classes ViewHelpers As an example the ViewHelper lt f link page can be found at typo3 sysext fluid Classes ViewHelpers Link PageViewHelper php Any other ViewHelper from other extensions can be used by using a namespace declaration like namespace e Tx_RoqNewsevent_ViewHelpers Then ViewHelpers of EXT RoqNewsevent which can be found in rogq_newsevent Classes ViewHelpers can be used with the prefix e Updating from version 2 0 x Please read this section carefully if you already have news event version 2 0 x installed and want to update to version 2 1 x of news event What has been changed Earlier with version 2 0 x news event added a new news type called Event
4. 2 0 1 Native support for more languages and some minor fixes 2 0 0 Initial public version
5. as show below Create new News on page Events General Access Options Relations Header gt Open Days 2012 Top news Type Language Hide E Event Default x E News Internal Page Teaser External Page Image 3 The removed Event news type This type has been removed and replaced with a checkbox Is event in the event tab from versions 2 1 0 Because of this the news types External Page and Internal Page also can be used for events This was not possible in the way we handled events in previous versions v TYPO3 LX News event Events for the versatile news system roq_newsevent Tutorial Ok but what does this mean This means that the way news event records are stored has been changed Because of this you need to update older news events records to the new format after performing the update by running the update script Otherwise the older records will not be recognized as news event records Update and running the update script 1 First update the news event extension to the latest version by using the TYPO3 Extension Manager like you normally would do 2 After you ve successfully performed the update go to the Loaded extensions list in the TYPO3 Extension Manager and click on the News event extension 3 Click on the Extension manager selectbox on the top and check if the item UPDATE is available from the selectbox in the top as shown in
6. versatile news system roq_newsevent Tutorial Tutorial General Since this extension extends the versatile news system extension it is recommended to first read the news system documentation All the described news system settings in this documentation apply to the news event extension as well and this section only describes the additional event features of news event How to add an event section to your site This section describes how to implement the extension news event in your TYPO3 installation Installation Before you can install this extension please make sure the news system extension including the system extensions Extbase and Fluid has been installed See the news system documentation for more information After the installation of the news system you can install the news event extension in the same way 1 Switch to the module Extension Manager 2 Get the extension from the Extension Manager TER Preparation Include static TypoScript Be aware that before any plugin can be rendered in the frontend it is necessary to include the static TypoScript of news event This is very easy 1 Switch to the template module and to the your template record 2 Add the news extension to the Include Static list Important make sure that you include the news event static template after the news system static template Create news event records Before any news events can be shown in the front end they must be creat
7. Next to No constraint two modes are available Only active non archived All current and future news event records based on event dates and time are shown Archived All news event records with event dates in the past are shown Note News event records can hold an optional archive date This archive date in news event records will be ignored and only the archive restriction as described above will be used archiveRestriction Date field to use Date menu The date menu builds a menu by year and month and the given news records dateField This field will be ignored By default the field EventStartdate will be used as dateField and can be overridden by using Typoscript configuration see the TypoScript reference for more information See the news system documentation for a description of all plugin settings TypoScript reference This section describes additional news system TypoScript settings which are available for news events A simple way to get to know the default settings is to look at the file EXT roq_newsevent Configuration T ypoScript setup txt News settings iCal support See the table below for the general news settings used by news event which are defined by using plugin tx_news settings lt property gt Property Data type Description Default format string Set a different format for the output Use e g ics for iCalendar html xml or for RSS feeds
8. TYPO3 News event Events for the versatile news system Extension Key roq_newsevent Language en Version 1 0 4 rev 57 Keywords forEditors forAdmins forBeginners forlntermediates Copyright 2006 2012 ROQUIN B V lt extensions roquin nl gt 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 v TYPO3 v News event Events for the versatile news system roq_newsevent News event Events for the versatile news system Table of Contents News event Events for the versatile news Aa P E E E Introduction sssessseessseesosesssossssoesosersesessooosesesssssseeeeeses 3 What does it dO sis d t se0i siveesseieadennnietetesertensstetentteiade 3 Sereen NoiSe seats T 3 Users mania liv dissseecsas caetssieacsivsesccsestessoisvcsariccoseedees a 4 COMFIZUPALIONs sssisssssssssssessvscssvsesscsesodsesecsssecesveedsesossned cays 7 0TA E E E E E A AE E 7 TyPOScript reference sssini 7 Database reference wid Tutoriala aa EE Sra 9 Eo u EE EE A E 9 How to add an event section to your site s9 Ad TYPO3 v News event Events for the versatile news system roq_newsevent Introduction Introduction What does it do The news event extension extends the versatile news system extension with additional event function
9. ality The news event extension is based on Extbase and Fluid Screenshots This section shows screenshots of the news event extension Please note that only the settings which are applicable for the news event extension are visible Selected Plugin News system Plugin Options Settings Additional Template What to display List view x List view List view without overloading detail view Detail view Date menu Category Menu Search List view Detail view Date menu rE ei SEEC CIOD Image 1 News plugin with available event views Edit News Open Days on page Events General Access Options Relations Event Is event v Start date 1 9 2012 E Start time 10 00 End date 3 9 2012 EJ End time 16 00 Location New York Image 2 Mark a news record as event and add event data TY PO 3 v News event Events for the versatile news system rog_newsevent User s manual User s manual About news event records The records can be created on any page however it is recommended to create a seperate sysfolder for news event records next to a sysfolder in which you store your news records See the Tutorial section for more information about how to use the news event extension News event records Field Description Required Is event Mark a news records as an event If this has been enabled the news record will be recognized as an No news event record
10. at the following locations relative to the template root path s News EventList html s News EventDetail html s News EventDateMenu html Additionally for ICS and RSS XML support three additional templates also have to at the following locations also relative to the template root path s News EventList ics News EventDetail ics s News EventList xml partialRootPath dir Root path for the fluid partials of the plugin The default Fluid EXT roq_newsevent Resources Private templates use several default partials If you override the default Partials templates this might become irrelevant layoutRootPath dir Root path for the fluid layouts of the plugin not used by Undefined default Database reference This section describes the news event database fields which are added to the news table tx_news_domain_model_news to store all event data Additional database columns Property Data type Description tx_roqnewsevent_is_event tinyint 1 unsigned Determines if a news record is of type news event tx_roqnewsevent_startdate int 11 The event start date tx_roqnewsevent_starttime int 11 The event start time tx_roqnewsevent_enddate int 11 The event end date for multiple day events tx_roqnewsevent_endtime int 11 The event end time tx_roqnewsevent_location varchar 255 The location of the event TY PO 3 v News event Events for the
11. ed by adding news event records 1 Therefore create a new sysfolder and switch to the list view it is preferable to create a seperate sysfolder for news event records next to your news records to keep your records organized 2 Optionally you can create a seperate news category for news events See the news system documentation for more information 3 Use the icon in the topbar Create new record and search for News system and its records You should see News News category and News Tag Click on News to create a new news record 4 Click on the Event tab and check the Is event checkbox to mark the news record as an event see Image 2 5 Fill in the necessary event information at least an event start date which is required to make the event visible in the frontend Please note that events without a start date will not be visible in the front end TYPO3 v News event Events for the versatile news system roq_newsevent Tutorial Add a plugin to a page Add a new page for instance Upcoming events to which you can add the news system plugin See the news system documentation to read more on how to add this plugin When you have added the plugin to the newly created page edit the plugin settings and 1 Change the 1 select box from What to display to List view beneath the Event section in the select box see Image 1 2 Select Only active non archived below
12. ent Type text calendar charset utf 8 will be added to the HTTP header with the additionalHeaders setting which causes the ICS page to be interpret as an iCalendar file Because of this the ICS data can be included directly into the website user s local calendar like Apple iCal Google Calendar Microsoft Outlook etc Depending on the browser the website user will be prompted with a pop up box if the current event should be added to his or her local calendar ICS for single events If you want to create a single ICS per event you can use the same TypoScript code as above but you ll need to set the controller action to eventDetail instead of eventList SwitchableControllerActions News 1 eventDetail You could include a typolink to a single event ICS on your single event matching the corresponding event so that a visitor can add the event directly to his or her local calendar RealURL configuration for ICS If you use RealURL for speaking URL s you can include the following code in your RealURL configuration for your ICS pages TYPO3 CONF VARS EXTCONF realurl array DEFAULT gt array fileName gt array defaultToHTMLsuffixOnPrev gt true index gt array eventlist ics gt array keyValues gt array type gt 9828 event ics gt array keyValues gt array type gt 9829 Please make sure that the type matches the corresponding typeN
13. the image below WEB 2t Page D View List a Versioning la Template TT Recycler Access Functions Info amp News Admin Image 4 Run the update script UPDATE Information Edit files Backup Delete e Sigh og_newsevent Upload to TER UPDATE The extension is installed loaded and ru Click here to remove the extension Details Title News event Description Event extension based Author ROQUIN B V lt extens Version 2 1 0 4 If this option is not available you ve already performed this update or there are no news records available which must be updated 5 Finally click on UPDATE to update all old news event database records From now all older news event records are converted to the newer format Please note The UPDATE option will disappear when the update has performed successfully UPDATE Extension Manager Extension i gt News event roq_newsevent Update The update has been performed successfully 15 row s affected Image 5 Result of the update script v TYP0O3 v News event Events for the versatile news system rog_newsevent Known problems Known problems Please let me know if you have any suggestions tips or questions about the news event extension Further progress and other information can be found at TYPO3 forge http forge typo3 org projects extension rog_newsevent The bugtracker at http forge typo3 org projects extension rog_ne
14. um defined in your TypoScript In this exampe the types 9828 and 9829 are used but of course you can use your own type numbers This is also applicable to the name of the pages which are eventlist ics and event ics TYPO3 W Configuration Plugin News event Events for the versatile news system roq_newsevent Configuration The news event extension adds three additional views Next to these views some other settings will work a bit differently comparing to the news system See the table below for an explanation of these settings Property View Description Key What to display All Selection of view Event List view List of all news event records which fit the configuration Event Detail view Shows the complete news event record Event Date menu Date menu based on the dates by default years of news event records Sort by None Define the sorting of displayed news records This field will be ignored This setting can only be configured by using Typoscript configuration see the TypoScript reference for more information orderBy Sort direction None Define the sorting direction which can either be ascending or descending This field will be ignored Sorting will be handled by the Sort by setting which can be overridden by using Typoscript configuration see the TypoScript reference for more information orderDirection Archive Event List view Event Date menu
15. wsevent issues holds all known bugs of the news event extension If you think you have found a bug please report if not already done at TYPO3 forge and attach at least those information to make it as easy as possible to resolve it e Understandable title amp description Please use English and include how the bug can be reproduced e Version of TYPO3 News system extension and News event extension e f possible an attached patch would be very nice v TYP0O3 v News event Events for the versatile news system rog_newsevent To Do list To Do list See the roadmap section on Forge http forge typo3 org projects extension rog_newsevent roadmap 13 v TY PO 3 v News event Events for the versatile news system roq_newsevent ChangeLog Version Changes 2 1 1 s Fixed bug 49651 due to TYPO3 6 1 compatibility thanks to Sascha Treiber s Implemented suggestion 45882 thanks to Georg Ringer 2 1 0 Changed Event type to an Is event checkbox to also support the Internal Page and External Page news types for events 7 Added support for news event specific templates paths Lowered version dependency of News from 1 4 0 to 1 3 2 due to issue 40303 Important Please run the update script when updating from previous versions of news event See the manual section Updating news event from version 2 0 x or the wiki on TYPO3 Forge for instructions 2 0 2 Fixed bug 41042 and updated contact details
16. xml The xml file type is achieved by setting plugin tx_news settings format xml iCalendar ICS Next to RSS the news event extension also supports the iCalendar ICS format See http en wikipedia org wiki ICalendar for more information about the iCalendar format The news event extension comes with two default ICS templates e For listing all events like the Event List view which is located in Resources Private Templates News EventList ics e per single event like the Event Detail view which is located in Resources Private Templates News EventDetail ics Both default templates use the same partial which is located at Resources Private Partials Events Item ics ICS support by embedding the plugin with TypoScript This section describes how you can create an ICS page for all and or single events on your website by using TypoScript ICS for all events See the TypoScript below as an example in which all active events are shown page PAGE page typeNum 9828 10 lt tt_content list 20 news pil 10 switchableControllerActions News 1 eventList settings format ics archiveRestriction active startingpoint sysFolderID config disableAllHeaderCode 1 xhtml_cleaning none admPanel 0 disablePrefixComment 1 metaCharset utf 8 TYPO3 v News event Events for the versatile news system roq_newsevent Administration As shown in the TypoScript above a the string Cont
Download Pdf Manuals
Related Search