Added rst documentation
authorjdegroot <jdegroot@735d13b6-9817-0410-8766-e36946ffe9aa>
Fri, 16 May 2014 14:09:21 +0000 (14:09 +0000)
committerjdegroot <jdegroot@735d13b6-9817-0410-8766-e36946ffe9aa>
Fri, 16 May 2014 14:09:21 +0000 (14:09 +0000)
git-svn-id: https://svn.typo3.org/TYPO3v4/Extensions/roq_newsevent/branches/3.0.0@85300 735d13b6-9817-0410-8766-e36946ffe9aa

15 files changed:
Documentation/Administration/Index.rst [new file with mode: 0644]
Documentation/ChangeLog/Index.rst [new file with mode: 0644]
Documentation/Configuration/Index.rst [new file with mode: 0644]
Documentation/Images/1_newsevent-views.png [new file with mode: 0644]
Documentation/Images/2_newsevent-tab.png [new file with mode: 0644]
Documentation/Images/3_newsevent-oldtype.png [new file with mode: 0644]
Documentation/Images/4_newsevent-update.png [new file with mode: 0644]
Documentation/Images/5_newsevent-update.png [new file with mode: 0644]
Documentation/Includes.txt [new file with mode: 0644]
Documentation/Index.rst [new file with mode: 0644]
Documentation/Introduction/Index.rst [new file with mode: 0644]
Documentation/KnownProblems/Index.rst [new file with mode: 0644]
Documentation/TodoList/Index.rst [new file with mode: 0644]
Documentation/Tutorial/Index.rst [new file with mode: 0644]
Documentation/UserManual/Index.rst [new file with mode: 0644]

diff --git a/Documentation/Administration/Index.rst b/Documentation/Administration/Index.rst
new file mode 100644 (file)
index 0000000..9c48394
--- /dev/null
@@ -0,0 +1,115 @@
+.. ==================================================\r
+.. FOR YOUR INFORMATION\r
+.. --------------------------------------------------\r
+.. -*- coding: utf-8 -*- with BOM.\r
+\r
+.. include:: ../Includes.txt\r
+\r
+=====================\r
+Administration\r
+=====================\r
+\r
+Archiving\r
+------------------------\r
+\r
+News records are archived by using the archive date restriction or time restriction settings. These settings are not used\r
+for news events records, and archiving for events works a bit differently. Events which are current or will occur in the\r
+future (based on the event data) are known as 'active', and all past events are known as 'archived'. You must select\r
+either 'active' or 'archived' when configuring an added news plugin for news events. See the section Configuration →\r
+Plugin for more information.\r
+\r
+RSS\r
+------------------------\r
+\r
+News event supports RSS feeds, which is handled like an event list view plugin. You can create an RSS feed exactly the\r
+same as adding an RSS feed for News. See the manual for the news system extension for more information. The default\r
+template for the output is stored in: Resources/Private/Templates/News/EventList.xml.\r
+The xml file type is achieved by setting::\r
+\r
+    plugin.tx_news.settings.format = xml\r
+\r
+iCalendar (ICS)\r
+---------------------------\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
+\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
+\r
+Both default templates use the same partial, which is located at: Resources/Private/Partials/Events/Item.ics\r
+\r
+ICS support by embedding the plugin with TypoScript\r
+'''''''''''''''''''''''''''''''''''''''''''''''''''\r
+This section describes how you can create an ICS page for all and/or single events on your website by using TypoScript.\r
+\r
+ICS for all events\r
+""""""""""""""""""\r
+See the TypoScript below as an example in which all active events are shown::\r
+\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
+    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
+\r
+ICS for single events\r
+"""""""""""""""""""""\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
+\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
+\r
+RealURL configuration for ICS\r
+"""""""""""""""""""""""""""""\r
+If you use RealURL for speaking URL's, you can include the following code in your RealURL configuration for your ICS pages::\r
+\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\r
+types 9828 and 9829 are used, but of course you can use your own type numbers. This is also applicable to the name of\r
+the pages, which are eventlist.ics and event.ics.
\ No newline at end of file
diff --git a/Documentation/ChangeLog/Index.rst b/Documentation/ChangeLog/Index.rst
new file mode 100644 (file)
index 0000000..35d51ca
--- /dev/null
@@ -0,0 +1,12 @@
+.. ==================================================\r
+.. FOR YOUR INFORMATION\r
+.. --------------------------------------------------\r
+.. -*- coding: utf-8 -*- with BOM.\r
+\r
+.. include:: ../Includes.txt\r
+\r
+=====================\r
+Changelog\r
+=====================\r
+\r
+See the Wiki section on Forge for Release notes: http://forge.typo3.org/projects/extension-roq_newsevent/wiki.
\ No newline at end of file
diff --git a/Documentation/Configuration/Index.rst b/Documentation/Configuration/Index.rst
new file mode 100644 (file)
index 0000000..24618c4
--- /dev/null
@@ -0,0 +1,303 @@
+.. ==================================================\r
+.. FOR YOUR INFORMATION\r
+.. --------------------------------------------------\r
+.. -*- coding: utf-8 -*- with BOM.\r
+\r
+.. include:: ../Includes.txt\r
+\r
+=====================\r
+Configuration\r
+=====================\r
+\r
+Plugin\r
+------------------------\r
+\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
+\r
+.. t3-field-list-table::\r
+  :header-rows: 1\r
+\r
+  - :Property:\r
+        Property:\r
+\r
+    :View:\r
+        View:\r
+\r
+    :Description:\r
+        Description:\r
+\r
+    :Key:\r
+        Key:\r
+\r
+\r
+  - :Property:\r
+        What to display\r
+\r
+    :View:\r
+        All\r
+\r
+    :Description:\r
+        Selection of view:\r
+\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
+    :Key:\r
+        | -\r
+\r
+\r
+  - :Property:\r
+        Sort by\r
+\r
+    :View:\r
+        None\r
+\r
+    :Description:\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
+\r
+    :Key:\r
+        orderBy\r
+\r
+  - :Property:\r
+        Sort direction\r
+\r
+    :View:\r
+        None\r
+\r
+    :Description:\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
+\r
+    :Key:\r
+        orderDirection\r
+\r
+\r
+  - :Property:\r
+        Archive\r
+\r
+    :View:\r
+        | Event List view,\r
+        | Event Date menu\r
+\r
+    :Description:\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
+    :Key:\r
+        archiveRestriction\r
+\r
+\r
+  - :Property:\r
+        Date field to use\r
+\r
+    :View:\r
+        Date menu\r
+\r
+    :Description:\r
+        The date menu builds a menu by year and month and the given news records.\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
+    :Key:\r
+        dateField\r
+\r
+TypoScript reference\r
+--------------------\r
+\r
+This section describes additional news system TypoScript settings, which are available for news events.\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
+\r
+News settings (iCal support)\r
+''''''''''''''''''''''''''''\r
+See the table below for the general news settings, used by news event, which are defined by using::\r
+\r
+    plugin.tx_news.settings.<property>.\r
+\r
+.. t3-field-list-table::\r
+  :header-rows: 1\r
+\r
+  - :Property:\r
+        Property:\r
+\r
+    :Data type:\r
+        View:\r
+\r
+    :Description:\r
+        Description:\r
+\r
+    :Default:\r
+        Key:\r
+\r
+\r
+  - :Property:\r
+        format\r
+\r
+    :Data type:\r
+        string\r
+\r
+    :Description:\r
+        Set a different format for the output. Use e.g. “ics” for iCalendar “xml” or for RSS feeds.\r
+\r
+    :Default:\r
+        html\r
+\r
+News event settings\r
+'''''''''''''''''''\r
+See the table below for the specific news event settings, which are defined by using::\r
+\r
+    plugin.tx_news.settings.event.<property>.\r
+\r
+\r
+.. t3-field-list-table::\r
+  :header-rows: 1\r
+\r
+  - :Property:\r
+        Property:\r
+\r
+    :Data type:\r
+        View:\r
+\r
+    :Description:\r
+        Description:\r
+\r
+    :Default:\r
+        Key:\r
+\r
+\r
+  - :Property:\r
+        templateRootPath\r
+\r
+    :Data type:\r
+        dir\r
+\r
+    :Description:\r
+        Root path for the fluid templates for news event. The plugin has one controller with three actions (named “eventDateMenu”, “eventList” and “eventDetail”).\r
+        Accordingly there have to be at least three fluid templates at the following locations (relative to the template root path):\r
+\r
+        - News/EventList.html\r
+        - News/EventDetail.html\r
+        - News/EventDateMenu.html\r
+\r
+        Additionally for ICS and RSS/XML support three additional templates also have to at the following locations (also relative to the template root path):\r
+\r
+        - News/EventList.ics\r
+        - News/EventDetail.ics\r
+        - News/EventList.xml\r
+\r
+    :Default:\r
+        EXT:roq_newsevent/Resources/Private/Templates\r
+\r
+\r
+  - :Property:\r
+        partialRootPath\r
+\r
+    :Data type:\r
+        dir\r
+\r
+    :Description:\r
+        Root path for the fluid partials of the plugin. The default Fluid templates use several default partials. If you override the default templates this might become irrelevant.\r
+\r
+    :Default:\r
+        EXT:roq_newsevent/Resources/Private/Partials\r
+\r
+\r
+  - :Property:\r
+        layoutRootPath\r
+\r
+    :Data type:\r
+        dir\r
+\r
+    :Description:\r
+        Root path for the fluid layouts of the plugin (not used by default)\r
+\r
+    :Default:\r
+        *undefined*\r
+\r
+\r
+Database reference\r
+''''''''''''''''''\r
+\r
+This section describes the news event database fields, which are added to the news table 'tx_news_domain_model_news'\r
+to store all event data.\r
+\r
+Additional database columns\r
+"""""""""""""""""""""""""""\r
+\r
+.. t3-field-list-table::\r
+  :header-rows: 1\r
+\r
+  - :Property:\r
+        Property:\r
+\r
+    :Data type:\r
+        View:\r
+\r
+    :Description:\r
+        Description:\r
+\r
+\r
+  - :Property:\r
+        tx_roqnewsevent_is_event\r
+\r
+    :Data type:\r
+        tinyint(1), unsigned\r
+\r
+    :Description:\r
+        Determines if a news record is of type news event\r
+\r
+  - :Property:\r
+        tx_roqnewsevent_startdate\r
+\r
+    :Data type:\r
+        int(1)\r
+\r
+    :Description:\r
+        The event start date\r
+\r
+\r
+  - :Property:\r
+        tx_roqnewsevent_starttime\r
+\r
+    :Data type:\r
+        int(1)\r
+\r
+    :Description:\r
+        The event start time\r
+\r
+\r
+  - :Property:\r
+        tx_roqnewsevent_enddate\r
+\r
+    :Data type:\r
+        int(1)\r
+\r
+    :Description:\r
+        The event end date (for multiple day events)\r
+\r
+\r
+  - :Property:\r
+        tx_roqnewsevent_endtime\r
+\r
+    :Data type:\r
+        int(1)\r
+\r
+    :Description:\r
+        The event end time\r
+\r
+\r
+  - :Property:\r
+        tx_roqnewsevent_location\r
+\r
+    :Data type:\r
+        varchar(255)\r
+\r
+    :Description:\r
+        The location of the event
\ No newline at end of file
diff --git a/Documentation/Images/1_newsevent-views.png b/Documentation/Images/1_newsevent-views.png
new file mode 100644 (file)
index 0000000..73c984f
Binary files /dev/null and b/Documentation/Images/1_newsevent-views.png differ
diff --git a/Documentation/Images/2_newsevent-tab.png b/Documentation/Images/2_newsevent-tab.png
new file mode 100644 (file)
index 0000000..8980e7b
Binary files /dev/null and b/Documentation/Images/2_newsevent-tab.png differ
diff --git a/Documentation/Images/3_newsevent-oldtype.png b/Documentation/Images/3_newsevent-oldtype.png
new file mode 100644 (file)
index 0000000..6a21108
Binary files /dev/null and b/Documentation/Images/3_newsevent-oldtype.png differ
diff --git a/Documentation/Images/4_newsevent-update.png b/Documentation/Images/4_newsevent-update.png
new file mode 100644 (file)
index 0000000..086efc7
Binary files /dev/null and b/Documentation/Images/4_newsevent-update.png differ
diff --git a/Documentation/Images/5_newsevent-update.png b/Documentation/Images/5_newsevent-update.png
new file mode 100644 (file)
index 0000000..f7bde9e
Binary files /dev/null and b/Documentation/Images/5_newsevent-update.png differ
diff --git a/Documentation/Includes.txt b/Documentation/Includes.txt
new file mode 100644 (file)
index 0000000..49aff1b
--- /dev/null
@@ -0,0 +1,30 @@
+..  Content substitution\r
+       ...................................................\r
+       Hint: following expression |my_substition_value| will be replaced when rendering doc.\r
+\r
+.. |author| replace:: John Doe <john.doe@typo3.org>\r
+.. |extension_key| replace:: extension_key\r
+.. |extension_name| replace:: Extension Name\r
+.. |time| date:: %m-%d-%Y %H:%M\r
+\r
+..  Custom roles\r
+       ...................................................\r
+       After declaring a role like this: ".. role:: custom", the document may use the new role like :custom:`interpreted text`.\r
+       Basically, this will wrap the content with a CSS class to be styled in a special way when document get rendered.\r
+       More information: http://docutils.sourceforge.net/docs/ref/rst/roles.html\r
+\r
+.. role:: code\r
+.. role:: typoscript\r
+.. role:: typoscript(code)\r
+.. role:: ts(typoscript)\r
+.. role:: php(code)\r
+\r
+.. ==================================================\r
+.. EXTERNAL LINKS\r
+.. --------------------------------------------------\r
+\r
+.. _http://forge.typo3.org/projects/extension-roq_redirect: http://forge.typo3.org/projects/extension-roq_redirect\r
+.. _http://forge.typo3.org/projects/extension-roq_redirect/issues: http://forge.typo3.org/projects/extension-roq_redirect/issues\r
+.. _https://svn.typo3.org/TYPO3v4/Extensions/roq_redirect: https://svn.typo3.org/TYPO3v4/Extensions/roq_redirect\r
+.. _http://forge.typo3.org/projects/extension-roq_redirect/roadmap: http://forge.typo3.org/projects/extension-roq_redirect/roadmap\r
+.. _http://www.roquin.nl/roq-redirect/: http://www.roquin.nl/roq-redirect/
\ No newline at end of file
diff --git a/Documentation/Index.rst b/Documentation/Index.rst
new file mode 100644 (file)
index 0000000..79cdc61
--- /dev/null
@@ -0,0 +1,66 @@
+.. ==================================================\r
+.. FOR YOUR INFORMATION\r
+.. --------------------------------------------------\r
+.. -*- coding: utf-8 -*- with BOM.\r
+\r
+.. include:: Includes.txt\r
+\r
+.. _start:\r
+\r
+==========================\r
+News event (roq_newsevent)\r
+==========================\r
+\r
+.. only:: html\r
+\r
+    :Extension name:\r
+        News event\r
+\r
+    :Extension key:\r
+        roq_newsevent\r
+\r
+    :Version:\r
+        3.0.0\r
+\r
+    :Description:\r
+        The news event extension extends the versatile news system extension with additional event functionality.\r
+\r
+    :Keywords:\r
+        forEditors, forAdmins, forBeginners, forIntermediates\r
+\r
+    :Language:\r
+        en\r
+\r
+    :Author:\r
+        ROQUIN B.V.\r
+\r
+    :Company:\r
+        ROQUIN B.V.\r
+\r
+    :Email:\r
+        extensions@roquin.nl\r
+\r
+    :Creation:\r
+        2014-05-14\r
+\r
+    :Generation:\r
+        17:00\r
+\r
+    :Licence:\r
+        Open Content License available from `www.opencontent.org/opl.shtml <http://www.opencontent.org/opl.shtml>`_\r
+        The content of this document is related to TYPO3, a GNU/GPL CMS/Framework available from `www.typo3.org\r
+        <http://www.typo3.org/>`_\r
+\r
+    **Table of Contents**\r
+\r
+.. toctree::\r
+       :maxdepth: 2\r
+\r
+       Introduction/Index      \r
+       UserManual/Index\r
+       Administration/Index\r
+       Configuration/Index\r
+       Tutorial/Index\r
+       KnownProblems/Index\r
+       TodoList/Index\r
+       ChangeLog/Index
\ No newline at end of file
diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst
new file mode 100644 (file)
index 0000000..3de7998
--- /dev/null
@@ -0,0 +1,34 @@
+.. ==================================================\r
+.. FOR YOUR INFORMATION\r
+.. --------------------------------------------------\r
+.. -*- coding: utf-8 -*- with BOM.\r
+\r
+.. include:: ../Includes.txt\r
+\r
+=====================\r
+Introduction\r
+=====================\r
+\r
+What does it do?\r
+----------------\r
+\r
+The news event extension extends the versatile news system extension with additional event functionality.\r
+\r
+Screenshots\r
+-----------\r
+\r
+This section shows screenshots of the news event extension. Please note that only the settings which are applicable for the news event extension are visible.\r
+\r
+.. figure:: ../Images/1_newsevent-views.png\r
+    :alt: News plugin with available event views\r
+    :align: left\r
+    :name: 1_newsevent-views\r
+\r
+    **Image 1:** News plugin with available event views\r
+\r
+.. figure:: ../Images/2_newsevent-tab.png\r
+    :alt: Mark a news record as event, and add event data\r
+    :align: left\r
+    :name: 2_newsevent-tab\r
+    \r
+    **Image 2:** Mark a news record as event, and add event data
\ No newline at end of file
diff --git a/Documentation/KnownProblems/Index.rst b/Documentation/KnownProblems/Index.rst
new file mode 100644 (file)
index 0000000..b3e2c3e
--- /dev/null
@@ -0,0 +1,22 @@
+.. ==================================================\r
+.. FOR YOUR INFORMATION\r
+.. --------------------------------------------------\r
+.. -*- coding: utf-8 -*- with BOM.\r
+\r
+.. include:: ../Includes.txt\r
+\r
+=====================\r
+Known problems\r
+=====================\r
+\r
+Please let me know if you have any suggestions, tips, or questions about the news event extension. Further progress, and\r
+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\r
+extension.\r
+\r
+If you think you have found a bug, please report (if not already done) at TYPO3 forge and attach at least those\r
+information to make it as easy as possible to resolve it:\r
+\r
+- Understandable title & description: Please use English and include how the bug can be reproduced\r
+- Version of: TYPO3, News system extension, and News event extension\r
+- If possible: an attached patch would be very nice!
\ No newline at end of file
diff --git a/Documentation/TodoList/Index.rst b/Documentation/TodoList/Index.rst
new file mode 100644 (file)
index 0000000..1dced1b
--- /dev/null
@@ -0,0 +1,12 @@
+.. ==================================================\r
+.. FOR YOUR INFORMATION\r
+.. --------------------------------------------------\r
+.. -*- coding: utf-8 -*- with BOM.\r
+\r
+.. include:: ../Includes.txt\r
+\r
+=====================\r
+To-Do list\r
+=====================\r
+\r
+See the roadmap section on Forge: http://forge.typo3.org/projects/extension-roq_newsevent/roadmap.
\ No newline at end of file
diff --git a/Documentation/Tutorial/Index.rst b/Documentation/Tutorial/Index.rst
new file mode 100644 (file)
index 0000000..74f9fb7
--- /dev/null
@@ -0,0 +1,169 @@
+.. ==================================================\r
+.. FOR YOUR INFORMATION\r
+.. --------------------------------------------------\r
+.. -*- coding: utf-8 -*- with BOM.\r
+\r
+.. include:: ../Includes.txt\r
+\r
+=====================\r
+Tutorial\r
+=====================\r
+\r
+General\r
+------------------------\r
+\r
+Since this extension extends the versatile news system extension, it is recommended to first read the news system\r
+documentation. All the described news system settings in this documentation apply to the news event extension as well,\r
+and this section only describes the additional event features of news event.\r
+\r
+How to add an event section to your site\r
+----------------------------------------\r
+This section describes how to implement the extension news event in your TYPO3 installation.\r
+\r
+Installation\r
+''''''''''''\r
+Before you can install this extension, please make sure the news system extension has been installed. See the news system documentation for more information.\r
+\r
+After the installation of the news system you can install the news event extension in the same way:\r
+\r
+#. Switch to the module “Extension Manager”.\r
+#. Get the extension from the Extension Manager (TER)\r
+\r
+Preparation: Include static TypoScript\r
+''''''''''''''''''''''''''''''''''''''\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
+\r
+#. Switch to the template module and to the your template record.\r
+#. Add the news extension to the “Include Static” list.\r
+\r
+*Important: make sure that you include the news event static template after the news system static template!*\r
+\r
+Create news event records\r
+''''''''''''''''''''''''''\r
+Before any news events can be shown in the front-end they must be created by adding news event records:\r
+\r
+#. 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
+#. Optionally you can create a seperate news category for news events. See the news system documentation for more information.\r
+#. 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
+#. Click on the 'Event' tab and check the 'Is event' checkbox to mark the news record as an event (see: Image 2).\r
+#. Fill in the necessary event information (at least an event start date), which is required to make the event visible in the frontend. Please note that events without a start date will not be visible in the front-end.\r
+\r
+Add a plugin to a page\r
+''''''''''''''''''''''\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
+\r
+#. Change the 1st select box from 'What to display' to 'List view' beneath the 'Event' section in the select box (see: Image 1).\r
+#. 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
+#. Point the starting point to the sysfolder pid where you have stored the news event records.\r
+#. Save the plugin.\r
+\r
+Optionally, you can create a seperate event detail and list page, as described in the news system documentation (see\r
+section: 'Add a plugin to a page'). In the example above the list view and detail view is the same page. Because of this\r
+the plugin setting 'Show a single news record' has been left empty.\r
+\r
+Viewhelpers\r
+"""""""""""\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\r
+typo3/sysext/fluid/Classes/ViewHelpers/Link/PageViewHelper.php.\r
+\r
+Any other ViewHelper from other extensions can be used by using a namespace declaration like::\r
+\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\r
+the prefix e:.\r
+\r
+Updating from version 2.0.x\r
+----------------------------\r
+Please read this section carefully, if you already have news event version 2.0.x installed, and want to update to version\r
+2.1.x of news event.\r
+\r
+What has been changed?\r
+''''''''''''''''''''''\r
+Earlier, with version 2.0.x, news event added a new news type called 'Event', as show below:\r
+\r
+.. figure:: ../Images/3_newsevent-oldtype.png\r
+    :alt: The removed 'Event' news type\r
+    :align: left\r
+    :name: 3_newsevent-oldtype\r
+\r
+    **Image 3:** The removed 'Event' news type\r
+\r
+This type has been removed, and replaced with a checkbox 'Is event' in the event tab from versions 2.1.0. Because of\r
+this, the news types 'External Page' and 'Internal Page', also can be used for events. This was not possible in the way we\r
+handled events in previous versions.\r
+\r
+Ok, but what does this mean?\r
+''''''''''''''''''''''''''''\r
+This means that the way news event records are stored has been changed. Because of this, you need to update older\r
+news events records to the new format after performing the update, by running the update script. Otherwise the older\r
+records will not be recognized as news event records.\r
+\r
+Update and running the update script\r
+''''''''''''''''''''''''''''''''''''\r
+\r
+1. First, update the news event extension to the latest version by using the TYPO3 'Extension Manager' like you normally would do.\r
+2. After you've successfully performed the update, go to the “Loaded extensions” list in the TYPO3 “Extension manager”, and click on the News event extension.\r
+3. Click on the Extension manager selectbox on the top, and check if the item 'UPDATE!' is available from the selectbox in the top, as shown in the image below\r
+\r
+.. figure:: ../Images/4_newsevent-update.png\r
+    :alt: The removed 'Event' news type\r
+    :align: left\r
+    :name: 4_newsevent-update\r
+\r
+    **Image 4:** Run the update script\r
+\r
+4. If this option is not available, you've already performed this update or there are no news records available which must be updated:\r
+5. Finally, click on 'UPDATE!' to update all old news event database records. From now all older news event records are converted to the newer format. Please note: The 'UPDATE!' option will disappear when the update has performed successfully:\r
+\r
+.. figure:: ../Images/5_newsevent-update.png\r
+    :alt: The removed 'Event' news type\r
+    :align: left\r
+    :name: 5_newsevent-update\r
+\r
+    **Image 5:** Result of the update script\r
+\r
+Updating to version 2.1.3\r
+-------------------------\r
+\r
+In version 2.1.3 the default templates have been modified. So if you've modified these templates (or a copy of them),\r
+please check this section to update your templates with these changes.\r
+\r
+What has been changed?\r
+''''''''''''''''''''''\r
+The link view helper for linking the event to the event detail page. The action argument has been removed. This can\r
+result in this error if you are using older templates: “Argument "action" was not registered. ”.\r
+\r
+Ok, but what does this mean?\r
+''''''''''''''''''''''''''''\r
+You have to remove the action argument from the link view helper in the following fluid templates:\r
+\r
+- Event list item partial, default location: /Partials/EventList/Item.html\r
+- Event detail template, default location: /Templates/News/EventDetail.html\r
+\r
+So change::\r
+\r
+    <e:link newsItem="{newsItem}" settings="{settings}" action="eventDetail">\r
+\r
+Into::\r
+\r
+    <e:link newsItem="{newsItem}" settings="{settings}">\r
+\r
+And finally modify the Eventlist.xml (default location: /Templates/News/) the n:link into an e:link. So change::\r
+\r
+    <n:link newsItem="{newsItem}" settings="{settings}" configuration="{returnLast:'url'}" hsc="TRUE"></n:link>\r
+\r
+Into::\r
+\r
+    <e:link newsItem="{newsItem}" settings="{settings}" configuration="{returnLast:'url'}" hsc="TRUE"></e:link>\r
+\r
+Updating to version 3.0.0\r
+-------------------------\r
+\r
+Version 3.0.0 is the release for TYPO3 CMS 6.2 LTS. This version works for TYPO3 6.2.x only, and older TYPO3 versions with this version.\r
+\r
+Instructions\r
+''''''''''''\r
+- Please read the news extension changelog and documenation carefully before updating, see: http://docs.typo3.org/typo3cms/extensions/news/Main/Changelog/3-0-0.html\r
+- Also the default templates have been modified. Please update your templates if you've created custom templates to implement these changes in your templates.\r
+\r
diff --git a/Documentation/UserManual/Index.rst b/Documentation/UserManual/Index.rst
new file mode 100644 (file)
index 0000000..6959877
--- /dev/null
@@ -0,0 +1,94 @@
+.. ==================================================\r
+.. FOR YOUR INFORMATION\r
+.. --------------------------------------------------\r
+.. -*- coding: utf-8 -*- with BOM.\r
+\r
+.. include:: ../Includes.txt\r
+\r
+=====================\r
+User's manual\r
+=====================\r
+\r
+About news event records\r
+------------------------\r
+\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
+\r
+See the Tutorial section for more information about how to use the news event extension.\r
+\r
+News event records\r
+,,,,,,,,,,,,,,,,,,\r
+\r
+.. t3-field-list-table::\r
+  :header-rows: 1\r
+\r
+  - :Field:\r
+        Field:\r
+\r
+    :Description:\r
+        Description:\r
+\r
+    :Required:\r
+        Required:\r
+\r
+\r
+  - :Field:\r
+        Is event\r
+\r
+    :Description:\r
+        Mark a news records as an event. If this has been enabled, the news record will be recognized as an news event record.\r
+\r
+    :Required:\r
+        No\r
+\r
+\r
+  - :Field:\r
+        Start date\r
+\r
+    :Description:\r
+        Start date of the event.\r
+\r
+        Note: If the start date has been left empty or undefined, the event will not be visible in the frontend.\r
+\r
+    :Required:\r
+        Yes\r
+\r
+\r
+  - :Field:\r
+        Start time\r
+\r
+    :Description:\r
+        Start time of the event.\r
+\r
+    :Required:\r
+        No\r
+\r
+\r
+  - :Field:\r
+        End date\r
+\r
+    :Description:\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
+\r
+    :Required:\r
+        No\r
+\r
+\r
+  - :Field:\r
+        End time\r
+\r
+    :Description:\r
+        End time of a the event.\r
+\r
+    :Required:\r
+        No\r
+\r
+\r
+  - :Field:\r
+     Location\r
+\r
+    :Description:\r
+     Location where the event takes place. For instance: Washington D.C.\r
+\r
+    :Required:\r
+     No\r