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: gkh_rss_import¶
| Author: | Christopher |
|---|---|
| Created: | 2010-12-18T19:57:23 |
| Changed: | 2013-07-03T08:13:00.880000000 |
| Classification: | gkh_rss_import |
| Description: | The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) ---- |
| Keywords: | RSS, FE, Show, Feeds |
| Author: | Gert Kaae Hansen |
| Email: | gertkh@gmail.com |
| Language: | en |
EXT: gkh_rss_import¶
Extension Key: gkh_rss_import
Language: en
Version: x.y.z
Keywords: RSS, FE, Show, Feeds
Copyright 2006-2013, Gert Kaae Hansen, <gertkh@gmail.com>
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¶
`EXT: Name of your Extension 1 <#__RefHeading__5708_1738894311>`_
`Introduction 3 <#__RefHeading__5710_1738894311>`_
`Users manual 4 <#__RefHeading__467_413120346>`_
`Administration 5 <#__RefHeading__31511_818911409>`_
`Configuration 6 <#__RefHeading__31515_818911409>`_
`Tutorial 8 <#__RefHeading__31523_818911409>`_
`Known problems 9 <#__RefHeading__31525_818911409>`_
`To-Do list 10 <#__RefHeading__477_413120346>`_
`ChangeLog 11 <#__RefHeading__31623_818911409>`_
`Important guidelines 12 <#__RefHeading__31625_818911409>`_
HowTo: Update a manual to the new layout 13
HowTo: Alternative updating possibility: Import the styles from another document 14
HowTo: Fix the Table Of Contents when it is empty 15
HowTo: Fix the Table Of Contents when a chapter is missing 15
Introduction¶
What does it do?¶
This extension inset a RSS feed on a FE page, and it gives you a high level of configuration options. Included is a function that trims the text to a specified length. Words are separated by space characters, and they are not chopped if possible. Logo from pages can be set to a maximum width. If the feed is in coded with a special language code this can be set also.
Now with support for templates, you can easy select a new template in the flex form.
The output i fully configurable via CSS.
The extension uses the RSS parser from Last RSS http://lastrss.oslab.net/ witch is modifyed to work with Typo3
Screenshots¶
Here you see what the extension does:
Users manual
------------
- Inset the plugin on a page.
- Change the settings to your needs.
RSS feed URL : The URL of the RSS feed that you want to show.
Maximum feeds to show : The amount of items that you want to show.
Length of item content : Defines how many characters you want to display for each item
Length of header description : Defines how many characters you want to display in the description of the feed
Target of URL : Select if all URL should open in a new window or on the same page.
Width of LOGO : Defines the pixel width of the logo
Error message : If a feed cant be reached this message will be shown
Date format : Select the format you want for the publishing date. Please be aware of the date only is shown if it is a valid date format.
Remove HTML from RSS feed : Select if you want HTML content in the feed to be shown.
RSS Feed cache time : The amount of time the RSS feed will be stored locally. Can be adjusted from 1 to 24 hours.
Template file : There are two template files located in /gkh_rss_import/template/. If no template file is selected it will use the template “tmpl_rssimport.htm”
Include rss_feed (gkh_rss_import) to your static templates if you want to use all the standard settings.
Select template via TS¶
You can now via Typoscript link to at template file
plugin.tx_gkhrssimport_pi1.templateFile = fileadmin/templates/gkh_rss_import/tmpl_rssimport-div.htm
Administration¶
If you want to change the design of the output you can use the following CSS code:
.tx-gkhrssimport-pi1-rss_title, tx-gkhrssimport-pi1-rss_title a {
font-size: medium;
font-family: Georgia, Times New Roman, Times, serif;
font-weight: bold;
color: #FF6100;
width: 100px;
padding-bottom: 1px;
}
.tx-gkhrssimport-pi1-description {
font-weight: bold;
padding-bottom: 10px;
border-bottom-width: 0px;
border-bottom-style: solid;
border-bottom-color: #2763A5;
margin-bottom: 15px;
}
.tx-gkhrssimport-pi1-header {
font-weight: bold;
}
.tx-gkhrssimport-pi1-content, .tx-gkhrssimport-pi1-download {
margin-bottom:10px;
}
.tx-gkhrssimport-pi1-pubbox, .tx-gkhrssimport-pi1-date, .tx- gkhrssimport-pi1-author, .tx-gkhrssimport-pi1-category {
display: inline;
}
.tx-gkhrssimport-pi1-content p img {
float: left;
width: 150px;
height: 100px;
padding-right: 5px;
padding-bottom: 5px;
}
Configuration¶
Reference¶
Possible subsections: Reference of TypoScript options.
templateFile¶
Property
templateFile
Data type
link
Description
Link to the template file
plugin.tx_gkhrssimport_pi1.templateFile = fileadmin/templates/gkh_rss_import/tmpl_rssimport-div.htm
Default
item_stdWrap¶
Property
item_stdWrap
Data type
wrap
Description
plugin.tx_gkhrssimport_pi1.item_stdWrap {
removeBadHTML = 1
HTMLparser = 1
HTMLparser.keepNonMatchedTags = 1
HTMLparser.tags.img.fixAttrib.src.userFunc = tx_gkhrssimport_pi1->fixRssURLs
HTMLparser.tags.a.fixAttrib.href.userFunc = tx_gkhrssimport_pi1->fixRssURLs
HTMLparser.tags.img.fixAttrib.style.unset = 1
}
Default
itemSummary_stdWrap¶
Property
itemSummary_stdWrap
Data type
wrap
Description
plugin.tx_gkhrssimport_pi1.itemSummary_stdWrap < plugin.tx_gkhrssimport_pi1.item_stdWrap
plugin.tx_gkhrssimport_pi1.itemSummary_stdWrap.parseFunc.userFunc = tx_gkhrssimport_pi1->smart_trim
Default
_CSS_DEFAULT_STYLE¶
Property
_CSS_DEFAULT_STYLE
Data type
string
Description
plugin.tx_gkhrssimport_pi1._CSS_DEFAULT_STYLE (
.tx-gkhrssimport-pi1-rss_title, tx-gkhrssimport-pi1-rss_title a {
font-size: medium;
font-family: Georgia, Times New Roman, Times, serif;
font-weight: bold;
color: #FF6100;
width: 100px;
padding-bottom: 1px;
}
.tx-gkhrssimport-pi1-description {
font-weight: bold;
padding-bottom: 10px;
border-bottom-width: 0px;
border-bottom-style: solid;
border-bottom-color: #2763A5;
margin-bottom: 15px;
}
.tx-gkhrssimport-pi1-header {
font-weight: bold;
}
.tx-gkhrssimport-pi1-content, .tx-gkhrssimport-pi1-download {
margin-bottom:10px;
}
.tx-gkhrssimport-pi1-pubbox, .tx-gkhrssimport-pi1-date, .tx- gkhrssimport-pi1-author, .tx-gkhrssimport-pi1-category {
display: inline;
}
.tx-gkhrssimport-pi1-content p img {
float: left;
width: 150px;
height: 100px;
padding-right: 5px;
padding-bottom: 5px;
}
Default
[tsref:cObject.TEST]
Example¶
Here you would show an example of the stuff from the reference or so:
plugin.tx_gkhrssimport_pi1.item_stdWrap {
removeBadHTML = 1
HTMLparser = 1
HTMLparser.keepNonMatchedTags = 1
HTMLparser.tags.img.fixAttrib.src.userFunc = tx_gkhrssimport_pi1->fixRssURLs
HTMLparser.tags.a.fixAttrib.href.userFunc = tx_gkhrssimport_pi1->fixRssURLs
HTMLparser.tags.img.fixAttrib.style.unset = 1
}
Tutorial¶
None
Known problems¶
None
To-Do list¶
None