.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ================================ EXT: Ameos Formidable Rss Parser ================================ :Author: Kasper Skårhøj :Created: 2002-11-01T00:32:00 :Changed by: Luc Muller :Changed: 2008-08-26T14:47:32 :Classification: ameos_formidable_rss_parser :Description: A real Rss Parser that is working. :Keywords: rss, parser, xml, rss parser, formidable, ameos, web 2.0 :Author: Luc Muller :Email: typo3ext@ameos.com :Info 4: :Language: en |img-1| |img-2| EXT: Ameos Formidable Rss Parser - ameos\_formidable\_rss\_parser .. _EXT-Ameos-Formidable-Rss-Parser: EXT: Ameos Formidable Rss Parser ================================ Extension Key: ameos\_formidable\_rss\_parser Language: en Copyright 2000-2008, Luc Muller, , Web developper @ `Ameos `_ 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.org .. _Table-of-Contents: Table of Contents ----------------- `EXT: Ameos Formidable Rss Parser 1 <#1.EXT:%20Ameos%20Formidable%20Rss%20Parser|outline>`_ **`Introduction 3 <#1.1.Introduction|outline>`_** `What does it do? 3 <#1.1.1.What%20does%20it%20do_|outline>`_ `Screenshots 3 <#1.1.2.Screenshots|outline>`_ **`Users manual 4 <#1.2.Users%20manual|outline>`_** `General 4 <#1.2.1.General|outline>`_ `Processing 4 <#1.2.2.Processing|outline>`_ `Template 4 <#1.2.3.Template|outline>`_ `Misc 5 <#1.2.4.Misc|outline>`_ **`Configuration 6 <#1.3.Configuration|outline>`_** `Reference 6 <#1.3.1.Reference|outline>`_ **`Known problems 7 <#1.4.Known%20problems|outline>`_** **`Todo 8 <#1.5.Todo|outline>`_** **`Known bugs 9 <#1.6.Known%20bugs|outline>`_** **`ChangeLog 10 <#1.7.ChangeLog|outline>`_** .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ - `Ameos `_ Formidable RSS Parser, is an extension built to display RSS feed in the frontend. - It is based both on the ameos\_formidable development framework (see : `Typo3 Formidable `_ ) and MagPie RSS .. _Users-manual: Users manual ------------ This extension can be either configured by typoscript or flexform. Using flexform will override the typoscript configuration. Look for the Ameos Formidable Rss Parser in the content element |img-3| Add the content element to your page. Fill in the flexform to override the default typoscript configuration .. _General: General ^^^^^^^ |img-4| General configuration of the plugin. Give the Rss url and (if wanted) the specific categories you want to display .. _Processing: Processing ^^^^^^^^^^ |img-5| By default everything is processed except the atom content. Those checkboxes are made to override your default TS configuration if you de-activate some process This is made to gain a little time on execution. .. _Template: Template ^^^^^^^^ |img-6| Give the template file you want to use Subpart of alternate rows : you can altern the display of the items in you rss. Just give the subpart names you want to use see in pi1/templates for an example. Number of item per pages. Give an int for the number of items you want to display on a page. Leave blank for all. (yes this means you can brose your feed... Date format : strftime format for the date. .. _Misc: Misc ^^^^ |img-7| Delay to get RSS : time you before the rss feed is going to be check again. This prevent to be blacklisted by remote sites for too many connection the the RSS feed Unit of delay to get RSS : choose the unit working with the delay, can be min hours or day. Crop Item content at xx char : this will crop the rss items to a certain number of characters. Output charset : charset to output the content of the feed. Default is utf-8 .. _Configuration: Configuration ------------- .. _Reference: Reference ^^^^^^^^^ .. _General-Settings: General Settings """""""""""""""" .. ### BEGIN~OF~TABLE ### .. _RssFeed: RssFeed ~~~~~~~ .. container:: table-row Property RssFeed Data type string Description Url of the rss feed you want to display Default .. _categories: categories ~~~~~~~~~~ .. container:: table-row Property categories Data type String / Csv Description List of categories to display Default Blank = all .. ###### END~OF~TABLE ###### .. _template: template """""""" .. ### BEGIN~OF~TABLE ### .. _File: File ~~~~ .. container:: table-row Property File Data type string Description Path of the template file Default EXT:ameos\_formidable\_rss\_parser/pi1/templates/formidable\_rss\_pars er.html .. _alternate-rows: alternate\_rows ~~~~~~~~~~~~~~~ .. container:: table-row Property alternate\_rows Data type String / Csv Description List of subpart to alternate the display of items Default ###ROW1###,###ROW2###,###ROWX### .. _dateformat: dateformat ~~~~~~~~~~ .. container:: table-row Property dateformat Data type String / strftime Description Date format schema Default %m-%d-%Y %H:%M .. ###### END~OF~TABLE ###### .. _Template-Pagin: Template > Pagin """""""""""""""" .. ### BEGIN~OF~TABLE ### .. _perpage: perpage ~~~~~~~ .. container:: table-row Property perpage Data type string Description Number of items to display per page Default -1 = all .. _browserwindow: browserwindow ~~~~~~~~~~~~~ .. container:: table-row Property browserwindow Data type int+ Description Number of page to display in the browser window of the pager Default 7 .. ###### END~OF~TABLE ###### .. _Process-Channel: Process > Channel """"""""""""""""" .. ### BEGIN~OF~TABLE ### .. _title: title ~~~~~ .. container:: table-row Property title Data type bool Description Process the channel title or not Default 1 .. _description: description ~~~~~~~~~~~ .. container:: table-row Property description Data type bool Description Process the channel description or not Default 1 .. _link: link ~~~~ .. container:: table-row Property link Data type Bool Description Process the channel link or not Default 1 .. ###### END~OF~TABLE ###### .. _Process-Item: Process > Item """""""""""""" .. ### BEGIN~OF~TABLE ### .. _title: title ~~~~~ .. container:: table-row Property title Data type bool Description Process the item title or not Default 1 .. _link: link ~~~~ .. container:: table-row Property link Data type Bool Description Process the item link or not Default 1 .. _fulllink: fulllink ~~~~~~~~ .. container:: table-row Property fulllink Data type Bool Description Process the item full link or not Default 1 .. _Content: Content ~~~~~~~ .. container:: table-row Property Content Data type Bool Description Process the item content or not Default 1 .. _Summary: Summary ~~~~~~~ .. container:: table-row Property Summary Data type Bool Description Process the item summary or not Default 0 .. _Date: Date ~~~~ .. container:: table-row Property Date Data type Bool Description Process the item date or not Default 1 .. _Creator: Creator ~~~~~~~ .. container:: table-row Property Creator Data type Bool Description Process the item creator or not Default 1 .. _Category: Category ~~~~~~~~ .. container:: table-row Property Category Data type Bool Description Process the item category or not Default 1 .. _atom-content: atom\_content ~~~~~~~~~~~~~ .. container:: table-row Property atom\_content Data type Bool Description Process the item atom content or not Default 0 .. ###### END~OF~TABLE ###### .. _Misc: Misc """" .. ### BEGIN~OF~TABLE ### .. _Crop: Crop ~~~~ .. container:: table-row Property Crop Data type Int+ Description Crop the content at this amount of char Default .. _Rssdelay: Rssdelay ~~~~~~~~ .. container:: table-row Property Rssdelay Data type int+ Description Delay to get the rss url again Default 1 .. _rssdelayunit: rssdelayunit ~~~~~~~~~~~~ .. container:: table-row Property rssdelayunit Data type String Description Unit of time the Rss delay belong to(can be : mn / hr / day Default day .. _encoding: encoding ~~~~~~~~ .. container:: table-row Property encoding Data type String Description Charset to output the rss content Default utf-8 .. ###### END~OF~TABLE ###### .. _Known-problems: Known problems -------------- None at the moment .. _Todo: Todo ---- None at the moment .. _Known-bugs: Known bugs ---------- Mag pie renders the rss channel categories in only one string, so it might be buggy to filter or multiple categories or to filter items that belongs to several categories. .. _ChangeLog: ChangeLog --------- 1.0.0 : First Release 10 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. |img-2| image:: img-2.png .. :border: 0 .. :height: 21 .. :hspace: 9 .. :id: Grafik2 .. :name: Grafik2 .. :width: 87 .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 40 .. :id: Image1 .. :name: Image1 .. :width: 435 .. |img-4| image:: img-4.png .. :align: left .. :border: 0 .. :height: 72 .. :id: Image2 .. :name: Image2 .. :width: 669 .. |img-5| image:: img-5.png .. :align: left .. :border: 0 .. :height: 247 .. :id: Image3 .. :name: Image3 .. :width: 273 .. |img-6| image:: img-6.png .. :align: left .. :border: 0 .. :height: 166 .. :id: Image4 .. :name: Image4 .. :width: 669 .. |img-7| image:: img-7.png .. :align: left .. :border: 0 .. :height: 109 .. :id: Image5 .. :name: Image5 .. :width: 286