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: kk_calendar¶

Author:	Kasper Skårhøj
Created:	2002-11-01T00:32:00
Changed by:	Kurt Kunig
Changed:	2013-02-21T12:52:26.270000000
Author:	Kasper Skårhøj
Email:	kasper@typo3.com
Info 3:
Info 4:

EXT: kk_calendar¶

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¶

`EXT: kk_calendar 1 <#__RefHeading__1428_1249565898>`_

`A result view 1 <#__RefHeading__1430_1249565898>`_

`Item-Entry Screenshots: 3 <#__RefHeading__1432_1249565898>`_

`Flexfolder – Screenshots 5 <#__RefHeading__1434_1249565898>`_

`Configuration 7 <#__RefHeading__1438_1249565898>`_

How to see a result: 7

Markers and Subparts out of the HTML-template: 9

`How to enter calendar content: 10 <#__RefHeading__1454_1249565898>`_

`FAQ 10 <#__RefHeading__1456_1249565898>`_

I can´t insert categories in a new partner record. 10

`Changelog 10 <#__RefHeading__1460_1249565898>`_

A result view¶

Not the best style but readable:

Item-Entry Screenshots:¶

A calendar entry out of a dedicated sysfolder, created with New Calendar Entry

A ToDo entry out of a dedicated sysfolder, just a little different:

Flexfolder – Screenshots¶

The global_calendarItems_pid is set in the Typoscript-Template Constants or Setup directly. (Have a look at the two files “ext_typoscript_constants.txt” and “ext_typoscript_setup.txt” in the extension-subfolder “res”.

Another appearance of the Backend (with the new field) since TYPO3 V4.5:

Configuration¶

How to see a result:¶

Install the extension from TER with the Extension-manager
create a page or sysfolder for the calendar items and calendar- categories. Put in this page itsself into the field ”General Record Storage page” to have access to the categories later on.
Put in Cal-Categories first (It is not a must!)
Put in Calendar-entries second with reference to categories
Choose the static template “calendar (kk_calendar)” and, if desired also the “calendar css (kk_calendar)” or put your own parameters in (look some lines later) – constans and/or setup
Create a new page and put the page / sysfolder where the calendar- items are into the field ”General Record Storage page” .
Put the plugin into the page over the content-object-type “Insert general plugin”
Fill the flexform mask with your parameters
Regard this page in the frontend and you should see the appointments / dates listed!?

Files:¶

calendar_template_table.html¶

File

calendar_template_table.html

Description

HTML template file for the design with <table>. Copy this file and redesign for your own purposes.

calendar_template_div.html¶

File

calendar_template_div.html

Description

HTML template file for the design with <div>. Copy this file and redesign for your own purposes.

Description¶

This script displays the calendar records from a page. It has special syntax for formatting the content and entering times. It's based on an HTML-template file.

((generated))¶

Example:¶

(See static_templates 'plugin.tx_kkcalendar_pi1/res' for a working configuration)

Static template¶

plugin.tx_kkcalendar_pi1 → “Calendar (KK)”

Constants¶

file.templateFile¶

Property

file.templateFile

Data type

string

Description

The template-file.

Template File: This is a simple htmlfile where each part of the calendar is defined with HTML-code. To see an example with explanations, take a look at

Default

EXT:kkcalendar/calendar_template_table.html

global_calendarItems_pid¶

Property

global_calendarItems_pid

Data type

Int

Description

Thats's the id of a general sysfolder where the calender items are stored in (if you forget to set it in the plugin-field “ Startingpoint ”

Default

empty

maxAge¶

Property

maxAge

Data type

int

Description

Number of days til items disappear

Default

30

realUrlUsed¶

Property

realUrlUsed

Data type

boolean

Description

If set, the links will be interpreted like real Url-Paths instead of index.php?id=nn

Default

0

plugin.tx_kkcalendar_pi1.

Setup:¶

templateFile¶

Property

templateFile

Data type

resource

Description

The template-file.

Default

{$..file.templateFile}

debug¶

Property

debug

Data type

Int

Description

Prints some debug information onto the screen

= 1: some infos

= 2: some infos more ;-)

Default

0

pid_list.field¶

Property

pid_list.field

Data type

string

Description

For recursive concerns

Default

pages

recursive.field¶

Property

recursive.field

Data type

string

Description

For recursive concerns

Default

recursive

global_calendarItems_pid¶

Property

global_calendarItems_pid

Data type

Int

Description

Thats's the id of a general sysfolder where the calender items are stored in (if you forget to set it in the plugin-field “ Startingpoint ”

Default

{$...global_calendarItems_pid}

parseFunc¶

Property

parseFunc

Data type

->parseFunc

Description

< styles.content.parseFunc

Default

maxAge¶

Property

maxAge

Data type

int

Description

Number of days til items disappear

Default

{$...plugin.tt_calender.maxAge}

noEntryMessage¶

Property

noEntryMessage

Data type

string

Description

Own message if no entry is found

Default

default from locallang.xml “noEntryMessage”

realUrlUsed¶

Property

realUrlUsed

Data type

boolean

Description

If set, a possible link-entry to a page-content will be rendered in realURL-form insrtead of index.php?id=42#c123

Default

{$...realUrlUsed}

shortWeekday¶

Property

shortWeekday

Data type

Boolean

Description

Decision between e.g. “Monday” or “Mon”

Default

true

trans¶

Property

trans

Data type

array

Description

Converts the weekday into the abbreviation for the desired country:trans ( Monday => Montag, Tuesday => Dienstag, Wednesday => Mittwoch, Thursday=> Donnerstag, Friday => Freitag, Saturday=> Samstag, Sunday => Sonntag, Mon => Mo., Tue => Di., Wed => Mi., Thu => Do., Fri => Fr., Sat => Sa., Sun => So., January => Januar, February=> Februar, March => März, May => Mai, June => Juni, July => Juli, October => Oktober, December=> Dezember,)

Default

plugin.tx_kkcalendar_pi1.

Markers and Subparts out of the HTML-template:¶

- Subparts:

###TEMPLATE_CALENDAR###

###TEMPLATE_TODO###

including:

###TABLE_CONTENT### for one calendar or ToDo-entry

###DATE_CONTENT### for each time stamp

- Markers:

###TYPE###: type / Typ (calendar or ToDo)

###WOTA###: Day of week

###DATE###: Date

###DATETEXT### additional text, accompanying the date value

###TIME###: Time

###HEADER###: Title

####CONTENT####: Text starting at the second row beyond the time-row

###CATEGORY###: category

###LINK### link to a content element of another page e.g.

for ToDos:

###WEEK###: nomen est omen

###PRIORITY### high, medium or low

###WORKGROUP### description of the workgroup

###RESPONSIBLE### responsible person of the ToDo

###COMPLETE### Checkbox if task is done or not

and related text-markers like ###TEXT_....### for some markers above

This is the calendar part out of the html-template with a table-tag:

<td class="cal_Date">###WOTA### ###DATE###<br>###TEXT_CALWEEK### ###CALWEEK###</td>

<td class="cal_Header">###HEADER### ###TEXT_LINK### ###LINK###</td>

</tr>

<td class="cal_Content">###CONTENT###</td>

</tr>

</table>

How to enter calendar content:¶

First of all, you need to create a pagecontent-element of the type "List of items" with the table "kk_calendar".

Then you should create some calendar-elements on the very same page.

Now:

Enter the date into the "Date"-field
Enter the title of the Day/Happening into the "Title"-field
In the note-field you have a few options. Try to put in this example:

15:00 meeting with coffee and cake
     later – walking through the forest
     ---
     22:00 Let's go home again

..."15:00 meeting with ...” is shown as time and 'subtitle',

..."later - walking....." is shown as a comment to this time in a new line

..."22:00 Let's go home again” is the next 'subitem'

The first (max) 5 characters will be interpreted as “time”, there must a space be inserted between the time and the subtitle.

FAQ¶

I can´t insert categories in a new partner record.¶

You have to put your sysFolder/page intothe “ General Record Storage page” resp. “starting point” of your page.Sometimes it is better to create a general storage page (sysfolder) for the categories and then put this one into the above mentioned field of the sysfolder/page where the calendar items are in.

Changelog¶

Please look into the extensions ChangeLog file.

EXT: kk_calendar - 10