Updated manual formatting and styling (hopefully this will fix the crappy online...
authorjdegroot <jdegroot@735d13b6-9817-0410-8766-e36946ffe9aa>
Tue, 4 Sep 2012 10:27:19 +0000 (10:27 +0000)
committerjdegroot <jdegroot@735d13b6-9817-0410-8766-e36946ffe9aa>
Tue, 4 Sep 2012 10:27:19 +0000 (10:27 +0000)
git-svn-id: https://svn.typo3.org/TYPO3v4/Extensions/roq_newsevent/trunk@65889 735d13b6-9817-0410-8766-e36946ffe9aa

doc/manual.pdf [new file with mode: 0644]
doc/manual.sxw
doc/manual.txt [new file with mode: 0644]

diff --git a/doc/manual.pdf b/doc/manual.pdf
new file mode 100644 (file)
index 0000000..a2ca4f0
Binary files /dev/null and b/doc/manual.pdf differ
index 49c32b5..374cca2 100644 (file)
Binary files a/doc/manual.sxw and b/doc/manual.sxw differ
diff --git a/doc/manual.txt b/doc/manual.txt
new file mode 100644 (file)
index 0000000..f38552c
--- /dev/null
@@ -0,0 +1,316 @@
+News event: Events for the versatile news system\r
+Extension Key: roq_newsevent\r
+Language: en\r
+Version: 1.0.1 (rev. 14)\r
+Keywords: forEditors, forAdmins, forBeginners, forIntermediates\r
+Copyright 2006-2012, Jochem de Groot, <jochem@roquin.nl>\r
+\r
+This document is published under the Open Content License\r
+available from http://www.opencontent.org/opl.shtml\r
+\r
+The content of this document is related to TYPO3 \r
+- a GNU/GPL CMS/Framework available from www.typo3.org
+\r
+Table of Contents\r
+News event: Events for the versatile news system       1\r
+Introduction   3\r
+What does it do?       3\r
+Screenshots    3\r
+User's manual  5\r
+About news event records       5\r
+Administration 6\r
+Archiving      6\r
+RSS    6\r
+iCalendar (ICS)        6\r
+Configuration  8\r
+Plugin 8\r
+TypoScript reference   8\r
+Database reference     9\r
+Tutorial       10\r
+General        10\r
+How to add an event section to your site       10\r
+Known problems 12\r
+To-Do list     13\r
+ChangeLog      14\r
+\r
+\r
+Introduction\r
+What does it do?\r
+The news event extension extends the versatile news system extension with additional event functionality. The news event extension is based on Extbase and Fluid.\r
+Screenshots\r
+Image 1: News plugin with available Event views\r
+\r
+Image 2: Mark a news record as event to add event data\r
+\r
+Note: Only the settings which are applicable for news events are visible.\r
+Image 3: Additional event data when editing a news record\r
+\r
+Note: Only the settings which are applicable for news events are visible.\r
+User's manual\r
+About news event records\r
+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).\r
+See the Tutorial section for more information about, how to use the news event extension.\r
+News event records\r
+Field:\r
+Description:\r
+Required:\r
+Type\r
+The type 'Event' has been added as an additional type to mark a news record as an event. If even has been selected an additional event tab will appear in which event information can be defined. See Image 2.\r
+Yes\r
+Start date\r
+Start date of the event.\r
+Yes\r
+Start time\r
+Start time of the event.\r
+No\r
+End date\r
+End date of the event. This makes an event multiple days unless this date is the same as the start date. In this case you don't have to define the end date.\r
+No\r
+End time\r
+End time of a the event.\r
+No\r
+Location\r
+Location where the event takes place. For instance: Washington D.C.\r
+No\r
+\r
+Administration\r
+Archiving\r
+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 → Plugin for more information.\r
+RSS\r
+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/EventList.xml. \r
+The xml file type is achieved by setting:\r
+plugin.tx_news.settings.format = xml\r
+iCalendar (ICS)\r
+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.\r
+The news event extension comes with two default ICS templates:\r
+For listing all events (like the Event List view), which is located in: Resources/Private/Templates/News/EventList.ics;\r
+per single event (like the Event Detail view), which is located in: Resources/Private/Templates/News/EventDetail.ics.\r
+Both default templates use the same partial, which is located at: Resources/Private/Partials/Events/Item.ics. \r
+ICS support by embedding the plugin with TypoScript\r
+This section describes how you can create an ICS page for all and/or single events on your website by using TypoScript. \r
+ICS for all events\r
+See the TypoScript below as an example in which all active events are shown:\r
+page = PAGE\r
+page {\r
+       typeNum = 9828\r
+       10 < tt_content.list.20.news_pi1\r
+       10 {\r
+               switchableControllerActions {\r
+                       News {\r
+                               1 = eventList\r
+                       }\r
+               }\r
+               settings {\r
+                       format = ics\r
+                       archiveRestriction = active\r
+                       startingpoint = [sysFolderID]\r
+               }\r
+       }\r
+\r
+config {\r
+       disableAllHeaderCode = 1\r
+       xhtml_cleaning = none\r
+       admPanel = 0\r
+       disablePrefixComment = 1\r
+       metaCharset = utf-8\r
+       additionalHeaders = Content-Type:text/calendar;charset=utf-8\r
+}\r
+\r
+As shown in the TypoScript above a the string Content-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. \r
+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.\r
+ICS for single events\r
+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: \r
+SwitchableControllerActions {\r
+       News {\r
+               1 = eventDetail\r
+       }\r
+}\r
+\r
+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.\r
+RealURL configuration for ICS\r
+If you use RealURL for speaking URL's, you can include the following code in your RealURL configuration for your ICS pages:\r
+$TYPO3_CONF_VARS['EXTCONF']['realurl'] = array(\r
+       '_DEFAULT' => array(\r
+               'fileName' => array(\r
+                       'defaultToHTMLsuffixOnPrev' => true,\r
+               'index' => array(\r
+                               'eventlist.ics' => array(\r
+                                       'keyValues' => array(\r
+                                               'type' => 9828,\r
+                                       ),\r
+                               ),\r
+                               'event.ics' => array(\r
+                                       'keyValues' => array(\r
+                                               'type' => 9829,\r
+                                       ),\r
+                               ),                      \r
+                       ),\r
+               ),\r
+       ),\r
+);\r
+\r
+Please make sure that the type matches the corresponding typeNum 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.\r
+Configuration\r
+Plugin\r
+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:\r
+Property:\r
+View:\r
+Description:\r
+Key:\r
+What to display\r
+All\r
+Selection of view:\r
+Event List view: List of all news event records which fit the configuration\r
+Event Detail view: Shows the complete news event record\r
+Event Date menu: Date menu based on the dates (by default  years) of news event records\r
+-\r
+Sort by\r
+None\r
+Define the sorting of displayed news records.\r
+\r
+This field will be ignored. This setting can only be configured by using Typoscript configuration, see the TypoScript reference for more information.\r
+orderBy\r
+\r
+Sort direction\r
+None\r
+Define the sorting direction which can either be ascending or descending.\r
+\r
+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.\r
+orderDirection\r
+Archive\r
+Event List view, Event Date menu\r
+Next to 'No constraint', two modes are available:\r
+\r
+Only active (non archived)\r
+All current and future news event records (based on event dates and time) are shown.\r
+\r
+Archived\r
+All news event records with event dates in the past are shown.\r
+\r
+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.\r
+archiveRestriction\r
+Date field to use\r
+Date menu\r
+The date menu builds a menu by year and month and the given news records.\r
+\r
+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.\r
+dateField\r
+\r
+See the news system documentation for a description of all plugin settings.\r
+TypoScript reference\r
+This section describes additional news system TypoScript settings, which are available for news events. These settings are divided into:\r
+General news settings, which are defined by using: plugin.tx_news.settings.<property>\r
+Specific event settings, which are defined by using: plugin.tx_news.settings.event<property>\r
+A simple way to get to know the default settings is to look at the file EXT:roq_newsevent/Configuration/TypoScript/setup.txt\r
+News settings (iCal support)\r
+Property:\r
+Data type:\r
+Description:\r
+Default:\r
+format\r
+string\r
+Set a different format for the output. Use e.g. “ics” for iCalendar “xml” or for RSS feeds.\r
+html\r
+News event settings\r
+Property:\r
+Data type:\r
+Description:\r
+Default:\r
+orderBy\r
+string\r
+Field ordering, which is used to sort event records\r
+tx_roqnewsevent_startdate ASC, tx_roqnewsevent_starttime ASC\r
+archived.orderBy\r
+string\r
+Field ordering, which is used to sort archived event records\r
+tx_roqnewsevent_startdate DESC, tx_roqnewsevent_starttime DESC\r
+dateField\r
+string\r
+Field to use for dateMenu\r
+EventStartdate\r
+Database reference\r
+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.\r
+Additional database columns\r
+Property:\r
+Data type:\r
+Description:\r
+Required:\r
+tx_roqnewsevent_startdate \r
+int(11)\r
+The event start date\r
+Yes\r
+tx_roqnewsevent_starttime\r
+int(11)\r
+The event start time\r
+No\r
+tx_roqnewsevent_enddate\r
+int(11)\r
+The event end date (for multiple day events)\r
+No\r
+tx_roqnewsevent_endtime\r
+int(11)\r
+The event end time\r
+No\r
+tx_roqnewsevent_location\r
+varchar(255)\r
+The location of the event\r
+No\r
+\r
+\r
+\r
+Tutorial\r
+General\r
+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.\r
+How to add an event section to your site\r
+This section describes how to implement the extension news event in your TYPO3 installation.\r
+Installation\r
+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.\r
+After the installation of the news system you can install the news event extension in the same way:\r
+1. Switch to the module “Extension Manager”.\r
+2. Get the extension from the Extension Manager (TER)\r
+Preparation: Include static TypoScript\r
+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:\r
+1. Switch to the template module and to the your template record.\r
+2. Add the news extension to the “Include Static” list.
+\r
+Important: make sure that you include the news event static template after the news system static template!\r
+Create news event records\r
+Before any news events can be shown in the frontend they must be created by adding news event records:\r
+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)\r
+2. Optionally you can create a seperate news category for news events. See the news system documentation for more information.\r
+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. \r
+4. Select 'Event' within the selectbox below 'Type' (see: Image 2), and click on 'Ok' when the pop-up box appears (with the message: “This change will affect which fields...”). An additional tab, called 'Event' will appear.\r
+5. Click on the 'Event' tab and fill in the necessary event date information (at least an event start date, which is required)\r
+\r
+Add a plugin to a page\r
+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:\r
+1. Change the 1st select box from 'What to display' to 'List view' beneath the 'Event' section in the select box.\r
+2. Select 'Only active (non archived)' below '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.\r
+3. Point the starting point to the sysfolder pid where you have stored the news event records.\r
+4. Save the plugin.\r
+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.\r
+Viewhelpers\r
+Every Fluid ViewHelper starts with <f:. and you can always check out the code at typo3/sysext/fluid/Classes/ViewHelpers/. As an example the ViewHelper <f:link.page can be found at typo3/sysext/fluid/Classes/ViewHelpers/Link/PageViewHelper.php.\r
+Any other ViewHelper from other extensions can be used by using a namespace declaration like:\r
+{namespace e=Tx_RoqNewsevent_ViewHelpers}\r
+\r
+Then ViewHelpers of EXT:RoqNewsevent (which can be found in roq_newsevent/Classes/ViewHelpers) can be used with the prefix e:.\r
+\r
+Known problems\r
+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-roq_newsevent.\r
+The bugtracker at http://forge.typo3.org/projects/extension-roq_newsevent/issues holds all known bugs of the news event extension. \r
+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:\r
+Understandable title & description: Please use English and include how the bug can be reproduced\r
+Version of: TYPO3, news system version, and news event\r
+If possible an attached patch would be very nice!\r
+To-Do list\r
+See the roadmap section on Forge: http://forge.typo3.org/projects/extension-roq_newsevent/roadmap\r
+\r
+ChangeLog\r
+Version\r
+Changes:\r
+2.0.1\r
+Native support for more languages, and some minor fixes \r
+2.0.0\r
+Initial version\r
+\r