.. You may want to use the usual include line. Uncomment and adjust the path. 
.. include:: ../Includes.txt


=====================================
EXT: Import an RSS feed into tt\_news
=====================================

:Author:
      Kasper Skårhøj

:Created:
      2002-11-01T00:32:00

:Changed by:
      Olivier Schopfer

:Changed:
      2008-01-04T11:34:18

:Author:
      Olivier Schopfer

:Email:
      ops AT wcc DOT coe DOT org

:Info 3:


:Info 4:


.. _EXT-Import-an-RSS-feed-into-tt-news:

EXT: Import an RSS feed into tt\_news
=====================================

Extension Key:  **xml\_ttnews\_import**

Copyright 2005, Olivier Schopfer, <ops AT wcc DOT coe DOT org>

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:

Table of Contents
-----------------

**EXT: Import an RSS feed into tt\_news 1**

**Introduction 1**

What does it do? 1

Screenshots 1

**Users manual 2**

**Adminstration 2**

**Configuration 2**

**Tutorial 2**

**Known problems 2**

**To-Do list 3**

**Changelog 3**


.. _Introduction:

Introduction
------------


.. _What-does-it-do:

What does it do?
^^^^^^^^^^^^^^^^

- Based on cc\_rdf\_news\_import, this extension imports an RSS news
  feed into distinct tt\_news records, or updates existing records with
  new data.

- Each time, it imports the title, the summary, the date, the link to
  the full text (which is not copied to tt\_news record).

- The tt\_news record can then be manually edited, for instance to add
  images and captions.

- A cron task allows auto update.


.. _Screenshots:

Screenshots
^^^^^^^^^^^


.. _Defining-an-RSS-feed-from-the-backend:

Defining an RSS feed from the backend
"""""""""""""""""""""""""""""""""""""

|img-1|


.. _Launching-the-import-process:

Launching the import process
""""""""""""""""""""""""""""

|img-2|


.. _Result-page:

Result page
"""""""""""

|img-3|


.. _Auto-import:

Auto import
"""""""""""

To set up auto import you need to go through the following steps:

|img-4| In the feed definitions, make sure that the Auto import
checkbox is selected.

Create a page of type “not in menu”. This page could also be protected
by a password, or its access limited to a single IP number.

|img-5| Add a content element “Insert plugin”, choose “Cron RSS
import”. Selected the pages where the RSS feed are defined.

Every time you display this page, the tt\_news records are updated.
You then need to create a cron task that will open that page on a
regular basis. The easiest is to use lynx to display the page.


.. _Users-manual:

Users manual
------------

The extension is accessed from the backend, in List mode.

Each RSS feed is described by a separate  *News feed import* record
(like in the rds\_news\_import plugin). The description record can be
added to any page. The field target page indicates where the tt\_news
records created by the process will be stored.

To launch the actual import/update from the RSS feed, click on the
icon of the News feed import record, from the list view. In the
contextual pop-up menu, select Update From RSS. A results page is
displayed when the process is finished.

If records are changed in the RSS feed, they will be updated at
import.

It's as simple!


.. _Administration:

Administration
--------------

Nothing to mention here.


.. _Configuration:

Configuration
-------------

Nothing to mention here.


.. _Tutorial:

Tutorial
--------

See the users manual


.. _Known-problems:

Known problems
--------------

- Can crash if the RSS feed is malformed.

- The format of the dates changes from one feed to the other. Extended
  support will have to be added.

- In the tt\_news records created by the process, don't change the
  title, the summary or the link, as they will be replaced by initial
  values at next import.

- Note that the synchronisation process does not suppress records which
  do not exist anymore in the RSS source.


.. _To-Do-list:

To-Do list
----------

- Manage the encoding of the stream in a better way. For the time being,
  it assumes the encoding is ISO-8859-1.

- Support different dates formatting.


.. _Changelog:

Changelog
---------

- 9 september: first working version.

- 4 january 2008: Added cron based import and updated the manual

|img-6| EXT: Import an RSS feed into tt\_news - 3


.. ######CUTTER_MARK_IMAGES######

.. |img-1| image:: img-1.png
.. :align: left
.. :border: 0
.. :height: 199
.. :id: Graphic4
.. :name: Graphic4
.. :width: 496

.. |img-2| image:: img-2.png
.. :align: left
.. :border: 0
.. :height: 173
.. :id: Graphic5
.. :name: Graphic5
.. :width: 288

.. |img-3| image:: img-3.png
.. :align: left
.. :border: 0
.. :height: 251
.. :id: Graphic6
.. :name: Graphic6
.. :width: 384

.. |img-4| image:: img-4.jpeg
.. :align: left
.. :border: 0
.. :height: 143
.. :id: graphics1
.. :name: graphics1
.. :width: 645

.. |img-5| image:: img-5.jpeg
.. :align: left
.. :border: 0
.. :height: 121
.. :id: graphics2
.. :name: graphics2
.. :width: 669

.. |img-6| image:: img-6.png
.. :align: left
.. :border: 0
.. :height: 32
.. :id: Graphic1
.. :name: Graphic1
.. :width: 102