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: RSS Reagregator¶
Author: | Kasper Skårhøj |
---|---|
Created: | 2002-11-01T00:32:00 |
Changed by: | Nicolas Garabedian |
Changed: | 2006-03-27T18:01:29 |
Classification: | RSS Réagrégator extension documentation |
Description: | Initial version extension 0.1 Revision Date : March 2006 longue vie à T3! Merci Kasper & Co --Onext--Oxcs |
Keywords: | RSS Fil reagregator XML channel bouquet package |
Author: | Onext / Nicolas Garabédian |
Email: | ngarabedian@onext.fr |
Info 3: | |
Info 4: |
EXT: RSS Reagregator¶
Extension Key: oxcs_rssreagregator
Copyright 2000-2002, Onext / Nicolas Garabédian, <ngarabedian@onext.fr>
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: RSS Reagregator 1
Introduction 2
What does it do? 2
Screenshots 2
Users manual 3
Channel : Post a wire of information 4
Package(Bouquet) : Display a RSS group 7
To post all wire 7
Select wire one by one 7
Administration 8
Ups-TO-DATE 19
Configuration 21
Tutorial 24
Known problems 24
To-Do list 24
Changelog 24
This document is related to version 0.1 of the extension
T3 engine : v4 beta 2
Revision date: 27/03/06
Documentation en français (une extension "doc" sera publiée) .
Introduction¶
What does it do?¶
This extension allows you to centralize and publish news in the form of wire RSS resulting from several sources.
Reagregator RSS imports wire RSS, then allows to gather (reagregation) by the association of categories and keywords (semantic enrichment).
This version currently manages the RSS in version 2.0 and 1.0 (for more details to see To-DO)
Users manual¶
To edit content, insert a Plugin content type, as usually :
choose in the plugin category the element "RSS field View"
a form to be filled opens :
Channel : Post a wire of information¶
Select a channel (a wire RSS) by the browser for records
the browser for records opens in a popup;
Select then the Sysfolder (see the administration part: prerequisite) in which wire RSS will be already indicated in the form of recordings with the icon .
Choose one, then you see :
Then, indicate the display mode; For example "LIST" mode.
Save; the point of exclamation disappears you then carried out the basic configuration;
Other parameters:
Template Tab:
You can define your HTML with the markers according to your needs.
The «alternative write if no date» is the posted mention when wire RSS doesn't have an associated category [1]
Advanced Options Tab:
Principle of the reagragation:
You associate this wire RSS with some parameters.
So, you can limit the items which will be displayed.
Package(Bouquet) : Display a RSS group¶
The operation is appreciably the same one as the next one except that here the type of source is "bouquet"(package); select this type in the listbox; it will be noticed that the elements posted in the sysfolder are preceded by the icon.
To post all wire¶
Select wire one by one¶
Administration¶
1- Plugin Installation **see configuration
2- Creating a sysFolder
3- Creating a channel (importation of a wire RSS/Channel)
The form is posted as a new item : an importation RSS:
1- Go on the web site which interests you
2- Seek a wire and choose the URL corresponding
Only paste the url, example : http://epp.eurostat.cec.eu.int/cache/RSS/rss_estat_news.xml
Alternative: click on the link which opens pop-up
Save and Close : the update of Xml flow will be posterior because asynchronous (to see further for synchronization)
4- Creating a Category of Reaggregation
Then specify the name of the categories as well as principal information e-mail; etc.
As well as wire corresponding to this category.
4bis association of wire to a Category
5- Reaggregation by item
Method 1 - by the items of sysfolder (possible but we recommend to pass by the 2nd méthode=by the module *)
The first part is the recovery (reading) of item, the second is categorization (left underligned on the screen printing)
{ Method 2 - since the module ** see below }
MODULE
Item details:
When you click on "link feed" you accede with the article on the site of origin
To specify the categorization of one item it is then necessary to click on "Reaggred":
Reading of item with categorization (multi-selection)
Then select (multiple) keyword
The most important is to select «reaggregator chanel»
after the selection, click on "Send"
Come back to the list view. You can now select the "View by chanel of reaggregation"
Observe whereas wire that you categorized finds well in the desired channel
Ups-TO-DATE¶
The 3rd menu allows to carry out the maintenance actions manually:
**Note that these operations are irreversibles**
UPDATE : import the contents of recorded wire RSS
DELETE : remove all flows (supression of the contents)
CLEAN : remove flows former to a number of day [ according to the parameter: see Instalation **]
REAGBYCHANNEL : Make the rules define for the classification by category
REAGBYWORD : make the rules define for the classification by keys word
**Operations of automatic updates:**
- Windows by the .bat**TO-DO
- Unix by the CRON
initial Step:¶
1- creation of a user BE: one simulates a user to carry out these operations
2 - "parameterize" the rights of the sysfolder to allow this user to reach this file, either directly or by including the user in the global group
Edit files¶
Then in the directory where is your extension (in general in [ - - - - ] /typo3conf/ext/ ) select the directory extension : " oxcs_rssreagregator "
then open " *cronmod/* "
- global_conf.php global configuration file
- import.sh file of configuration showing the path and the file to execute
- log_rssimport.txt log file
- rssgrab_sh.php file of execution
publish import.sh:
1. then configure the relative path of the extension + the directory cronmod for variable SH_DIR 2.
2. the file by default or the desired file name (to be modified if you have particular tasks or config)
#!/bin/shSH_DIR=/var/www/typo3conf/ext/oxcs_rssreagregator/cronmod
$SH_DIR/rssgrab_sh.php
*Cron is a Unix order which launches a task recursively.*
Launch job CRON in line of order:
crontab -e 0 8,16,23 * * * /var/www/typo3conf/ext/oxcs_rssreagrega tor/cronmod/import.sh>>/var/www/typo3conf/ext/oxcs_rssreagregator/cro nmod/log_rssimport.txt
crontab¶
Command / argument
crontab
explanation
task name
-e¶
Command / argument
-e
explanation
option edition
0 (zero)¶
Command / argument
0 (zero)
explanation
minutes [according to specified hours below here 8:00 16:00 etc. ]
8,16,23¶
Command / argument
8,16,23
explanation
hours to which the task is launched
* * *¶
Command / argument
* * *
explanation
successively day/month/year here the job is carried out all the time
..../import.sh¶
Command / argument
..../import.sh
explanation
file containing the parameters in absolute path.
>>¶
Command / argument
>>
explanation
redirect flow text generated towards a file (here log_rssimport.txt)
.../log_rssimport.txt¶
Command / argument
.../log_rssimport.txt
explanation
file in which information relating to the operations is stored either the log
Configuration¶
((generated))¶
Installation¶
Dependances : cms, **api_macmade** , **oxcs_apilistcard** , **oxcs_fieldcontrol**
Reference¶
source¶
Property
source
Data type
Text, StdWrap
Description
type=options[tx_oxcsrssreagregator_channelsrss,tx_oxcsrssreagregato r_reagchannel,ALL,ITEMS]
Default
ALL
uid_list¶
Property
uid_list
Data type
List id
Description
Where the content come from if type "ITEMS": list of uid of RSS items or Channel or reag channe. This list change with source.
Default
templateFile¶
Property
templateFile
Data type
file
Description
type=file[html,htm,tmpl]
Default
EXT:oxcs_rssreagregator/pi1/static/rss_template.tmpl
linkFeed¶
Property
linkFeed
Data type
Text, sdtWrap
Description
Alternative text for link to RSS Feed
Default
Link Feed
controlThemes¶
Property
controlThemes
Data type
List id
Description
List items of categorisation
Default
controlPublics¶
Property
controlPublics
Data type
List id
Description
List items of categorisation
Default
controlAuthors¶
Property
controlAuthors
Data type
List id
Description
List items of categorisation
Default
controlCountrys¶
Property
controlCountrys
Data type
List id
Description
List items of categorisation
Default
controlRegions¶
Property
controlRegions
Data type
List id
Description
List items of categorisation
Default
controlDepartement¶
Property
controlDepartement
Data type
List id
Description
List items of categorisation
Default
limit¶
Property
limit
Data type
Int()
Description
Limit records view
Default
10
CMD¶
Property
CMD
Data type
String, stdWrap
Description
Comman LIST, SEARCH, SEARCHRESULT
Default
LIST
noData¶
Property
noData
Data type
String, stdWrap
Description
Default
Pas de données
[plugin.tx_oxcsrssreagregator_pi1]
"
Tutorial¶
See above (!)
Known problems¶
problem for the reading of some RSS to format 1.0
RSS 0.91 not compatible
We appreciate all objective remarks which would make it possible to improve this extension ( ngarabedian@onext.fr )
As indicated in the To-DO list the translation of this document could be approximate on certain parts, (apologies); If you have courage of it, send us corrections which we will publish in the version following, thank you.
If you want, you can use "evolution tracking" directly in OOo (you know... Menu: Edit>Modifications>...)
To-Do list¶
- .bat file for windows
- checking English translation (language by default not always correct)
- Multi PID management, importation in a single pid and reading of the channels and channels of reagregation (bouquet) on the whole of the site.
- Test for RSS version to day no test Rss version
- Test of url channel disponibility (if channel isn't dispo the program returns error on log files)
- **API oxcs_rsslib part documentation (in progress).**