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.

Calenderview for MJS Event Pro

Author:Rene Nitzsche
Created:2007-05-08T10:00:09
Changed by:Rene Nitzsche
Changed:2007-07-07T13:31:44
Author:Rene Nitzsche
Email:rene@system25.de
Info 3:
Info 4:

Calenderview for MJS Event Pro

Extension Key: rn_mjseventpro_cal

Copyright 2007, Rene Nitzsche, <rene@system25.de>

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

Calenderview for MJS Event Pro 1

Introduction 1

What does it do? 1

Screenshots 1

Users manual 2

FAQ 2

Administration 2

FAQ 2

Configuration 3

Kalenderansicht / Calenderview 3

Bugfixes 3

FAQ 3

Known problems 4

To-Do list 4

Changelog 4

Introduction

What does it do?

Die Extension stellt eine Kalenderansicht mit den Events des aktuellen Monats bereit. Außerdem behebt sie einige Bugs von MJS Event Pro:

- Verweise auf andere interne Seiten werden jetzt korrekt verlinkt

- Event-Titel werden nicht mehr automatisch als RTE-Text dargestellt. Man kann statt dessen über plugin.tx_mjseventpro_pi1.title_stdWrap einen eigenen Wrap definiert. Somit kann man z.B. auch Header-Tags (h1, h2,...) verwenden.

- Die Archivierung der Events nimmt jetzt Rücksicht auf den Seitenbaum. Wenn man mehrere Domains in einer TYPO3-Instanz hat landeten vorher bei der Archivierung alle Events in einem Ordner.

This extension provides a new calender view for extension mjs_eventpro. Additional the are some bugfixes for the original extension included:

- Links to internal references work now

- Event titles can be wrapped by plugin.tx_mjseventpro_pi1.title_stdWrap. This makes it possible to use h1-h6 tags. Good for search engines.

- The archive function now cares about page trees. This is importend if one have two or more different events-folders with different archive folders.

Screenshots

Hier der Screenshot der Kalenderansicht. Zugrunde liegt ein normales HTML-Template. Die Formatierung erfolgt über CSS. Es wird immer der aktuelle Monat dargestellt. Tage mit Events können markiert werden. Zusätzlich erhält man auch eine Liste der als nächstes anstehenden Events.

img-1

This is a screenshot of calender view. It always shows the current month. Days with events can be marked. The plugin is based on a standard HTML-template and can be formatted by CSS. Additional you can show a list of upcoming events.

Users manual

  1. Extension mit dem Extension-Manager installieren
  2. Das Static Template rn_mjseventpro_cal einbinden
  3. Das Plugin auf der Seite einfügen

Das Plugin kann als wie üblich als Seiteninhalt eingebunden werden. Zusätzlich kann es natürlich auch über Typoscript eingebunden werden. Weitere Informationen finden sich im Abschnitt Configuration. Die Bugfixes sind sofort nach der Installation wirksam.

  1. Install extension with extension manager
  2. add the static template rn_mjseventpro_cal
  3. add the Plugin to your page

You can include the plugin as page content as usual or by Typoscript. Have a look at configuration section for more. The bugfixes work immediately after installation.

FAQ

F: Wie muss im Flexform der Pfad zu einem eigenen HTML-Template angegeben werden?

A: Der Pfad muss mit fileadmin beginnen. Also z.B. fileadmin/templates/kalender.html

F: Event Pro verwendet doch nur eine Seite für List- und SingleView. Warum muss man beiden angeben?

A: Muss man nicht. Wenn nur die Listview-Seite angegeben wird, dann wird diese auch für die Einzelansicht verwendet.

Q: How to define template in flexform?

A: Path starts with fileadmin . So for instance fileadmin/templates/kalender.html

Q: Why do I need define single- and listview-page? Event Pro uses one page for both...

A: SingleView page is optional. Leave it empty and your Listview- Page is used for Singleview too.

Administration

Die Extension wird ganz normal über den Extension-Manager geladen. Voraussetzung ist die Installation der Extension rn_base. Wer lediglich die Bugfixes benötigt, kann darauf auch verzichten.

The extension can be installed by Extension Manager. It is based on extension rn_base. You can skip this extension if you need the bugfixes only.

FAQ

- none

Configuration

Kalenderansicht / Calenderview

Wie erwähnt kann das Plugin derzeit nur über TypoScript eingebunden werden. Die folgenden Angaben sind ausreichend:

temp.calendar = plugin.tx_rnmjseventprocal_calendar
temp.calendar.pidList = 123
temp.calendar.recursive = 1
temp.calendar.eventListPid = 1

Das Objekt sollte jetzt natürlich noch irgendwo in der Seite plaziert werden.

As said before you can include the view by TypoScript only. These few lines should work:

temp.calendar = plugin.tx_rnmjseventprocal_calendar
temp.calendar.pidList = 123
temp.calendar.recursive = 1
temp.calendar.eventListPid = 1

After this you have to include temp.calendar in page of course.

Bugfixes

Hier ist lediglich, die neu hingekommene Möglichkeit den Titel des Events zu wrappen, interessant. Um den Titel also als Überschrift darzustellen, genügt folgende Anweisung:

plugin.tx_mjseventpro_pi1 {
  singleView {
    title_stdWrap.wrap = <h1>|</h1>
  }
  listView {
    title_stdWrap.wrap = <h2>|</h2>
  }
}

Hier wird der Titel in der Einzelansicht als H1 und in der Listendarstellung als H2 gewrapped.

The example above shows how to wrap event titels on singleview as H1 and on list view as H2.

FAQ

- none

Reference

- Properties of plugin.tx_rnmjseventprocal_calendar

pidList

Property

pidList

Data type

Integer

Description

PageIDs der SysFolder mit den Event-Datensätzen

PageIDs of SysFolders with event items.

Default

recursive

Property

recursive

Data type

Integer

Description

Tiefe derVerzeichnisrekursion.

Depth of directory recursion.

Default

eventListPid

Property

eventListPid

Data type

Integer

Description

PageID der Seite, die die Listendarstellung von MJS Event Pro enthält.

PageID of page containing list view of MJS Event Pro.

Default

eventSinglePid

Property

eventSinglePid

Data type

Integer

Description

PageID der Seite, die die Einzeldarstellung von MJS Event Pro enthält. Wenn dieser Wert nicht angegeben wird, dann wird die Listenseite verwendet.

PageID of page containing single view of MJS Event Pro. If you skip this value the listPid is used instead.

Default

template

Property

template

Data type

String

Description

Setzt das HTML-Template.

Defines the html template file to use.

Example

plugin.tx_rnmjseventprocal_calendar {
  template = fileadmin/mytemplates/calendar.html
}

Default

EXT:rn_mjseventpro_cal/views/template.html

eventList.limit

Property

eventList.limit

Data type

Integer

Description

Anzahl der Events in der Liste der nächsten Events.

Number of upcoming events to show.

Default

2

eventList.date

Property

eventList.date

Data type

stdWrap

Description

StdWrap um das Eventdatum in der Eventliste zu formatieren.

StdWrap to format date of event in event list.

Default

%d.%m.%Y

calender.monthname

Property

calender.monthname

Data type

stdWrap

Description

StdWrap um den Monatsnamen im Kalender zu formatieren.

StdWrap to format name of month in calendar.

Example

plugin.tx_rnmjseventprocal_calendar {
  calendar.strftime = %B
  calendar.wrap = <b>|</b>
}

Default

%B

calendar.dayWrap

Property

calendar.dayWrap

Data type

stdWrap

Description

Ein stdWrap um jeden Tag des Kalenders.

A wrap for each day in calendar view.

Default

Known problems

- None right now. But if you have problems feel free to give me an hint.

To-Do list

- Show tooltips on events..

Changelog

- 07.07.2007: Plugin has a flexform now.

- 24.04.2007: This the initial version of this document.

img-2 Calenderview for MJS Event Pro - 4