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: My Extension¶
| Author: | Kasper Skårhøj |
|---|---|
| Created: | 2002-11-01T00:32:00 |
| Changed: | 2009-06-13T23:10:23 |
| Email: | your@email.com |
AttaCalendar¶
Extension Key: attacalendar
Copyright 2006, joerg.puehrer@attac.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.com
Table of Contents¶
EXT: My Extension 1
Introduction 1
What does it do? 1
Screenshots 1
Users manual 1
FAQ 1
Adminstration 1
FAQ 2
Configuration 2
FAQ 2
Reference 2
Tutorial 2
Known problems 2
To-Do list 2
Changelog 2
Introduction¶
What does it do?¶
This Typo3 calendar extension can be used for displaying events created by backend-users. It features two different list views (compact/extended) and a single event view.
Events may be assigned to multiple backend-created categories. When listing events you may only view events of specified categories. Additionally you can associate each event to a frontend-usergroup.
List views may also be restricted to events from the past, the future or both by specifying the number of events from past/future or the number of past/future days for which events are displayed.
You can decide whether caching should be allowed for single list views or not. When cached, events can be found by the indexed search engine – extension (if their single view was visited before).
Screenshots¶
Users manual¶
((generated))¶
Creating events¶
- After backend-login you choose a page of your choice and create a new record
- choose 'Calendar Events'
Now you can edit your event:
Hide¶
When checked the event will be hidden.
Access¶
Select the front-end usergroup for which this event is visible. If left empty, the event will be visible for everyone. Administrators can modify the list-view templates such that events for different user groups are displayed differently.
Categories¶
Select zero or more event-categories to which this event belongs. You can choose from all categories which were created somewhere on your site.
Beginning¶
Choose date & time of the beginning of the event
End¶
Choose date & time of the end of the event. Optional.
Whole-day event¶
If checked the exact begin/end times will not be displayed.
Title¶
Enter the title of your event.
Location¶
Enter a location for the event.
Organiser¶
Enter the name or a description of the organiser(s). Optional.
Organiser link¶
Enter the URL of the organiser's website. Optional.
Email¶
Enter an e-mail address. Optional.
Description¶
Enter the description of you event.
Link¶
Enter a link to your event. Optional.
Image / Logo¶
Here you can choose or upload an image file which is displayed when in single event view. Optional.
After saving your events they can be seen on your pages using the plugin 'Calendar Event List'.
Creating categories¶
Creating views¶
- Documentation of how to use the extension, how it works, how to apply it if it's a website plugin. A user manual.
- Language should be non-technical, explaining, using small examples.
- Examples: For the "News" plugin this would be a manual showing how to create the news-items, explaining the options etc.
- Target group: Users, Administrators or Developers in that priority. Depends on the extension.
FAQ¶
- Possible subsections: FAQ
Adminstration¶
- Describes how to manage the extension from a superuser point of view. That relates to Page/User TSconfig, permissions, configuration etc. which administrator level users have access to.
- language should be non/semi-technical, explaining, using small examples.
- Target group: Administrators
FAQ¶
- Possible subsections: FAQ
Configuration¶
- Technical information; Installation, Reference of TypoScript, configuration options on system level, how to extend it, the technical details, how to debug it.
- language should be technical, assuming developer knowledge of TYPO3. Small examples/visuals are always encouraged.
- Target group: Developers
FAQ¶
- Possible subsections: FAQ
Subheadlines¶
You can produce subheadlines in a section using “Heading 4” or “Heading 5” (normally used for “Examples”)
EXT: My Extension - 4