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: Event Management¶
Author: | Kasper Skårhøj |
---|---|
Created: | 2002-11-01T00:32:00 |
Changed: | 2008-10-21T18:05:30 |
Classification: | rmevent |
Description: | The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) see more: http://wiki.typo3.org/doc_template#tags ---- |
Keywords: | events, event management |
Author: | Paul Woltering |
Email: | paul.woltering@ruhmesmeile.com |
Info 4: | |
Language: | en |
EXT: Event Management - rmevent
EXT: Event Management¶
Extension Key: rmevent
Language: en
Keywords: events, event management
Copyright 2000-2008, Paul Woltering , <paul.woltering@ruhmesmeile.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.org
Table of Contents¶
`Introduction 3 <#1.1.Introduction|outline>`_
`Users manual 4 <#1.2.Users%20manual|outline>`_
`Administration 10 <#1.3.Administration|outline>`_
`Configuration 11 <#1.4.Configuration|outline>`_
`Known problems 14 <#1.5.Known%20problems|outline>`_
`To-Do list 15 <#1.6.To-Do%20list|outline>`_
`ChangeLog 16 <#1.7.ChangeLog|outline>`_
Introduction¶
What does it do?¶
Extension for displaying and managing events and associated reports.
Features¶
- Categories, artists, location, images, a description, a state and reports can be assigned to events.
- Flexible events content-element with the following functions: List, Latest, Upcoming, Artist-menu, Category-menu, Single-view.
- List-, Latest- and Upcoming views can be filtered by category, artist or tour.
- The appearance of the events plugin on the website can easily be changed by editing the html-template.
Screenshots¶
Editing an event
Users manual¶
Installation¶
Install the extension with the extension manager.
After the extension manager created the new database tables and fields for rmevent you should see a page with the main configuration options (only one at the moment). Here you can configure some basic options (mostly BackEnd related).
Quick start¶
This section will give you a short overview about the basic setup requirements for rmevent to work. For more detailed informations you can have a look in the sections “Configuration” and “Administration” in this manual.
Include static extension TS¶
To include the default extension TS open your main TS-template (in list view), scroll down to the “Include static (from extensions)”-section and include “rmevent default (rmevent)”. If you dont't know how to do this -> see section “Templates” in the “Getting Started” document: http://typo3.org/documentation/document- library/tutorials/doc_tut_quickstart/0.1.0/view/1/9/
Save your TS-template and open or create a page, where you want the news to appear.
Create an “Events” database record¶
To test the functionality of the extension you'll need at least one events-record. Select a SysFolder or create a new one to insert the event record into. Choose the "Events" item from the list.
A form opens, showing an events database record:
Fill in some dummy information and save & close the form.
Creating a “Events” content-element¶
Click on the “create new record” link, to add a new content-element.
Choose “Insert plugin” as the pagecontent type.
Choose the plugin “Events” in the tab “Plugin”.
You can select an item from the “what to display” field. If no view is chosen the display defaults to “List”. (For the first test choose “List” and leave the other settings at their defaults)
Select the SysFolder as the startingpoint in the plugin options tab. The “Startingpoint” is the page/sysfolder, where the extension looks for news-records. It is not required to set this value in this field, you can also define it with TypoScript for the whole page.See: section “Configuration/Reference” in this manual (-> pidInList).
Save the content element form and click on the preview icon and you should see your events article in your browser.
If this is not the case, repeat the steps above. If still no event appear on your website, have a look in the section "Troubleshooting" of this document.
The plugins¶
The extension provides two plugins:
- The 'Events' plugin
- The 'Reports' plugin (work in progress)
The extension provides seven types of elements (records):
- Events
- Locations
- Artists
- Categories
- Tours
- States
- Reports
With the following relations:
- Each location relates to any number of events.
- Each artist relates to any number of events.
- Each category relates to any number of events.
- Each tour relates to any number of events.
- Each state relates to any number of events.
- Each report relates to any number of events.
- Each event relates to a single location, any number of artists, any number of categories, a single tour, a single state and any number of reports.
The 'Events' plugin content element¶
There are many ways to configure this extension. For detailed configuration options take a look at the parts “Administration” and “Configuration” in this manual. Most of these options can also be controlled by TS, but the settings made directly in the content element will override TS settings.
Below descriptions of the content element configuration options.
What to display¶
Currently there are six different options in the“What to display”field. These are the function of this options:
FIELD What to display
Single
Description
Displays a single event item. See section “The SINGLE view”.
FIELD What to display
List
Description
Displays a list of events. See section “The LIST view”.
FIELD What to display
Archive
Description
Displays a list of past events.
FIELD What to display
Upcoming
Description
Displays a list of future events.
Order by¶
In this selectbox you can choose the field by which the listed (List, Archive & Upcoming) event-records should be ordered. Possible options are: “Datetime start” and “title”.
default (= nothing selected) is to order lists by the “Datetime start” field and display the most current items first.
Ascending or Descending¶
With this selectbox you can choose the sorting order.
Artists, Categories and Tours selection¶
In the selectfields you can choose artists, categories and tours to filter events lists (List, Archive & Upcoming). Multiple selections are possible. Multiple selections in the same field are joined with OR and multiple selections in different fields are joined with AND.
Example:
- category1 and category2 selected in the “Category” field: all events with category1 OR category2 are displayed
- category1 in the “Category” field and artist1 in the “Artist” field selected: all events with category1 AND artist1 are displayed
State¶
In this selectbox you can choose a state (like “omitted”) as a list filter.
Max and Limit¶
Here you can set a limit of events displayed in list views.
Max Width/Height for images¶
These 2 fields offer you the possibility to set the image sizes for a certain content element different from the image sizes defined globally by TypoScript. The setting here will be applied to all images, displayed by this content element.
Template file¶
Here you can overwrite the html-template defined globally by TypoScript with another one.
It is not required to define a template in this place, because in most cases several event content-elements under one pagetree use the same html-template. This can be defined directly in the TS-setup or in the Constant-Editor of your main-(TS)template.
Hint: The best way to include your own html-template is to link it directly in TS. Add the following line by hand to your TypoScript setup or edit the default value in the “TypoScript Object Browser” :
plugin.tx_rmevent_pi1.templateFile = fileadmin/templates/rmevent_template.html
Do not edit and save the html-template in the extension directory -> it will be overwritten if you update tt_news.
You can change the event display, by simply creating a new template- file for the display of events. There is a default template-file included with rmevent (EXT:rmevent/template.html).
If you want to change the template, take a look at that file, make a copy of it and modify it to your own design. Observe the comments in the file - they are markers that define where content is inserted and which parts are used for this and that. Self explanatory to a certain degree...
PageId for single event display¶
This tells the extension on which page the single view is located. It's not required to set a value here, cause it's more efficient to set a global value for the single view (singlePid) in the constant- Editor of your root template. See: “Configuration”.
PageId for single report display¶
This tells the extension on which page the single view for reports is located. It's not required to set a value here, cause it's more efficient to set a global value for the single view (singleReportPid) in the constant-Editor of your root template. See: “Configuration”.
Starting point and Recursive level selection¶
"Starting point" is used to tell the extension where the events records are stored. It is possible to select multiple ”Starting points”. This way, you are able to collect events from several folders to display them in one content-element.
If you don't insert a page as "Starting point", rmevent will look for a value for “pidInList” from TypoScript. This is the recommended way to configure many event content-elements from one central point, e.g. from the constants field in your main TS-template. -> see files EXT:rmevent/static/rmevent_default/constants.txt & EXT:rmevent/static/rmevent_default/setup.txt for examples. The “Starting Point” can also be set in the Constant editor.
Recursive level selection:
This tells the extension how many levels of subpages to include below the page(s) given in the "Starting point" field.
The 'Reports' plugin content element¶
coming soon...
The rmevent 'Events' database-record¶
The 'Events' database-record is the main plugin database-record. You can create the other database-records (Location, Artist,...) in the 'Events' database-record page via “Inline Relational Record Editing” (IRRE).
Below a list of field descriptions.
Title¶
The value inserted here will substitute the marker ###RMEVENT_TITLE### in the html template.
Start/End Date¶
The value of these fields affect several things:
- The events in list views are ordered by Start Date if no other field is selected (-> see "Order by" this field in section “The rmevent content element”)
- The value of these fields will substitute the html-template markers ###RMEVENT_DATE_START###, ###RMEVENT_TIME_START###, ###RMEVENT_ISO_START###, ###RMEVENT_DATE_END###, ###RMEVENT_TIME_END###, ###RMEVENT_ISO_END### (all parsed through the stdWrap functions “strftime”) and ###RMEVENT_DATE### (combination of the above markers).
Description¶
This is the main text of the event and will substitute the html- template marker ###RMEVENT_DESC###.
Images¶
Here you can define images that will be shown in the event item. All images will be rendered to the marker ###RMEVENT_IMAGES###. This marker will display a single image in list views an a list of images in the single view.
Ticket URL¶
Here you can save a URL for a booking service, either specific for an event or a general one. The template marker ###RMEVENT_TICKET_URL### will be replaced with a link to the URL.
Categories¶
Here you can assign categories to the current event record. The titles of the assigned categories will substitute the html-template marker ###RMEVENT_CAT###.
Tour¶
Here you can assign a tour to the current event record. The title of the tour will substitute the html-template marker ###RMEVENT_TOUR###.
Artists¶
Here you can assign artists to the current event record. The names of the assigned artists will substitute the html-template marker ###RMEVENT_ARTIST###.
Location¶
Here you can assign a location to the current event record. The name, city and country of the location will substitute the html-template marker ###RMEVENT_LOC###.
State¶
Here you can assign a state to the current event record. The title of the assigned state will substitute the html-template marker ###RMEVENT_STATE###.
Other rmevent database-records¶
Locations, artists, categories can be created and edited via “Inline Relational Record Editing” (IRRE) in the “Events” database-record or their own database-record page.
... description of other db-records ...
FAQ¶
- Q: First Question A: First Anwser
- Q: Second Question A: Second Anwser
Administration¶
Page TSconfig¶
Text Page Tsconfig
Caching¶
You can clear the cache of pages containing events automatically when event records are created or changed.
If you add the following parameters to the PageTSconfig of the events sysfolder, the cache for the pages configured in the “clearCacheCmd” is automatically cleared by saving an event record in this folder.
TCEMAIN.clearCacheCmd = 123,345
(Screenshot)
For more options see: http://typo3.org/documentation/document- library/references/doc_core_tsconfig/4.0.0/view/1/3/#id2798076
FAQ¶
- Q: First Question A: First Anwser
- Q: Second Question A: Second Anwser
Configuration¶
If you want to modify some global values of the TypoScript configuration, used for the events display, take a look at the "Constant Editor". To open it, click on "Web/Template" in the left- frame menu, choose the page with the root-template in the pagetree and select "Constant Editor" from the menu in the upper right corner.
To change any options you don't find there, take a look at the "TypoScript Object Browser" (TSOB):
More information about the TSOB can be found here: http://typo3.org/documentation/document- library/tutorials/doc_tut_quickstart/0.1.0/view/1/9/#id2855181
The default values for the rmevent TypoScript configuration are stored in the file setup.txt in one of the “static/rmevent_default” folder in the extension directory. For a list of all possible (rmevent specific) options see the table "Reference" below.
Some options e.g. for "stdWrap" or "typolink" are explained in the Typo-Script Reference (TSref) which can be found here: http://typo3.org/documentation/document- library/references/doc_core_tsref/current/
Reference¶
plugin.tx_rmevent_pi1 properties: TS configuration.¶
General settings¶
Property
templateFile
Data type
resource
Description
The HTML-template. (See examples: "template.tmpl" in the ext/rmevent folder). You can define a template for a complete pagetree, a certain page or even a single content element in your TS setup, in the Constant Editor or in the content.element.
Example:
plugin.tx_rmevent_pi1 {
templateFile = fileadmin/my_templates/rmevent.html
}
Default
Property
pidInList
Data type
string / stdWrap
Description
The page id (pid), or list of pids of the folder(s), where your events are stored in (also known as “Starting point”).Accepts multiple pids comma separated!
Example:
# clear the value
plugin.tx_rmevent_pi1.pidInList >
# display event records located in page 123 & 345
plugin.tx_rmevent_pi1.pidInList = 123,345
Default
Property
singlePid
Data type
int+ / stdWrap
Description
Page id of the page where single news are displayed.
Here you can define a page to be used for display of an event item with the “SINGLE” template-part. This setting can also be done in the constant editor or directly in the content element. (the settings done directly in the content element will override settings you made by TS, but they will only affect these certain content element.)
Example:
# singlePid for a news element inserted by TS
plugin.tx_rmevent_pi1.singlePid = 123
Notice: setting at least one page with a SINGLE news content element as “singlePid” is required
-> if there's no “singlePid” defined the links that should point to the single view don't work.
Default
Property
listPid
Data type
int+ / stdWrap
Description
Page id of the page for the back link in the single view and for category-, artist- and tour links.
Default
0
Property
ticketURL
Data type
string
Description
URL for general booking service
Default
Property
defaultCode
Data type
string
Description
Default view (if nothing is selected in “What to display”)
Default
listView
Property
limit
Data type
int+ / stdWrap
Description
The maximum number of event-records showing in “LIST” view.
Default
10
Property
maxItems
Data type
int+ / stdWrap
Description
Default
Property
offset
Data type
int+
Description
Offset in seconds. When events disappear in upcoming view.
Default
86400
Display settings for “LIST”, “UPCOMING”, “ARCHIVE” and “SINGLE”¶
Property
title_stdWrap
Data type
->stdWrap
Description
stdWrap for the title
Default
Property
description_stdWrap
Data type
->stdWrap
Description
stdWrap for the description
Default
Property
ticketURL_stdWrap
Data type
->stdWrap
Description
stdWrap for the ticket URL
Default
Property
state_stdWrap
Data type
->stdWrap
Description
stdWrap for the state
Default
Property
Data type
Description
Default
Property
categories_stdWrap
Data type
->stdWrap
Description
stdWrap for the complete category section
Default
Property
textCategories_stdWrap
Data type
->stdWrap
Description
stdWrap for the category text
Default
Property
categoriesList_stdWrap
Data type
->stdWrap
Description
stdWrap for the category list
Default
Property
categoriesItem_stdWrap
Data type
->stdWrap
Description
stdWrap for a single category item
Default
Property
categoriesItem_divider
Data type
string
Description
category item divider
Default
Property
Data type
Description
Example:
plugin.tx_rmevent_pi1 {
singleView {
categories_stdWrap.wrap = <p class="rmevent_categories">|</p>
textCategories_stdWrap.noTrimWrap =|<em>|</em>: |
categoriesList_stdWrap.wrap =
categoriesItem_stdWrap.wrap =
categoriesItem_divider = ,
}
}
Default
Property
Data type
Description
Default
Property
artists_stdWrap
Data type
->stdWrap
Description
stdWrap for the complete artists section
Default
Property
textArtists_stdWrap
Data type
->stdWrap
Description
stdWrap for the artist text
Default
Property
artistsList_stdWrap
Data type
->stdWrap
Description
stdWrap for the artist list
Default
Property
artistsItem_stdWrap
Data type
->stdWrap
Description
stdWrap for a single artist item
Default
Property
artistsItem_divider
Data type
string
Description
artists item divider
Default
Property
Data type
Description
Example:
plugin.tx_rmevent_pi1 {
singleView {
artists_stdWrap.wrap = <div class="rmevent_artists">|</div>
textArtists_stdWrap.wraprap = <h3> | </h3>
artistsList_stdWrap.wrap = <ul class=”rmevent_artists_list”>|</ul>
artistsItem_stdWrap.wrap = <li>|</li>
artistsItem_divider =
}
}
Default
Property
Data type
Description
Default
Property
location_stdWrap
Data type
->stdWrap
Description
stdWrap for the complete location section
Default
Property
textLocation_stdWrap
Data type
->stdWrap
Description
stdWrap for the location text
Default
Property
locationName_stdWrap
Data type
->stdWrap
Description
stdWrap for the location name
Default
Property
locationCity_stdWrap
Data type
->stdWrap
Description
stdWrap for location city
Default
Property
locationCountry_stdWrap
Data type
string
Description
stdWrap for location country
Default
Property
locationLink_stdWrap
Data type
->stdWrap
Description
stdWrap for location link
Default
Property
locationLon_stdWrap
Data type
->stdWrap
Description
stdWrap for location longitude
Default
Property
locationLat_stdWrap
Data type
->stdWrap
Description
stdWrap for location latitude
Default
Property
Data type
Description
Default
Property
tour_stdWrap
Data type
->stdWrap
Description
stdWrap for the tour section
Default
Property
textTour_stdWrap
Data type
->stdWrap
Description
stdWrap for the tour text
Default
Property
Data type
Description
Default
Property
date_stdWrap
Data type
->stdWrap
Description
stdWrap for the complete date section
Default
Property
dateStart_stdWrap
Data type
->stdWrap
Description
Here you can set the start date formating.
Example:
plugin.tx_rmevent_pi1.singleView {
dateStart_stdWrap {
strftime = %d.%m.%y
wrap = <span class="rmevent_date_start">|</span>
}
}
Default
Property
timeStart_stdWrap
Data type
->stdWrap
Description
Default
Property
dateEnd_stdWrap
Data type
->stdWrap
Description
Default
Property
timeEnd_stdWrap
Data type
->stdWrap
Description
Default
Property
textDateStart_stdWrap
Data type
->stdWrap
Description
Default
Property
textDateEnd_stdWrap
Data type
->stdWrap
Description
Default
Property
isoStart_stdWrap
Data type
->stdWrap
Description
Default
Property
isoEnd_stdWrap
Data type
->stdWrap
Description
Default
Property
start_stdWrap
Data type
->stdWrap
Description
Default
Property
end_stdWrap
Data type
->stdWrap
Description
Default
Property
textStart_stdWrap
Data type
->stdWrap
Description
Default
Property
textEnd_stdWrap
Data type
->stdWrap
Description
Default
Property
textDate_stdWrap
Data type
->stdWrap
Description
Default
Property
Data type
Description
Default
Property
image_stdWrap
Data type
->stdWrap
Description
stdWrap for the complete image section
Default
Property
Data type
Description
Default
Display settings for “PAGEBROWSER”¶
This is the configuration array for the pagebrowser. All settings here start with “pageBrowser.”. The formating of the pagebrowser is done by CSS.
Property
maxPages
Data type
int
Description
Default
Property
showResultCount
Data type
boolean
Description
Default
Property
showPBrowserText
Data type
boolean
Description
Default
Property
dontLinkActivePage
Data type
boolean
Description
Default
Property
tableParams
Data type
string
Description
Default
Property
showFirstLast
Data type
boolean
Description
Default
Property
pagefloat
Data type
Description
Default
Property
showRange
Data type
Description
Default
Property
disabledLinkWrap
Data type
Description
Default
Property
inactiveLinkWrap
Data type
Description
Default
Property
activeLinkWrap
Data type
Description
Default
Property
LinksWrap
Data type
Description
Default
Property
showResultsWrap
Data type
Description
Default
Property
showResultsNumbersWrap
Data type
Description
Default
Property
browseBoxWrap
Data type
Description
Default
Property
browseLinksWrap
Data type
Description
Default
Property
Data type
Description
Default
Example¶
FAQ¶
Possible subsections: FAQ
Known problems¶
...
To-Do list¶
a lot