Reference

This chapter describes the settings which are available in news. Except of setting the template paths and overriding labels of the locallang-file, the settings are defined by using plugin.tx_news.settings.<property>.

A simple way to get to know the default settings is to look at the file EXT:news/Configuration/TypoScript/setup.txt

General properties

Property: Data type: Description: Default:
view.templateRootPath string Path to the templates. The default setting is EXT:news/Resources/Private/Templates/ Extbase default
view.partialRootPath string Path to the partials. The default setting is EXT:news/Resources/Private/Templates/ Extbase default
view.layoutRootPath string Path to the layouts. The default setting is EXT:news/Resources/Private/Templates/ Extbase default
Settings.cssFile string

Path to the css file. The default setting is

EXT:news/Resources/Public/Css/news-basic.css

  
format string Set a different format for the output. Use e.g. “xml” for RSS feeds. html
displayDummyIfNoMedia boolean If set, a dummy image is displayed if no preview image can be found 1
overrideFlexformSettingsIfEmpty string

The default behaviour of news and extbase is to override settings from TS by the one of the flexforms. This is even valid if the setting is left empty in the flexforms.

Set a comma separated list of fields which get the value of the TS setting if the setting is not defined in the plugin configuration.

 cropLength
pidDetailFromCategories boolean Enable selecting ID of the detail page from the related categories. This overrides the detail view setting which can be set with TypoScript/Plugin. 1
link.hrDate array

The url to a single news record contains only the uid of the record. Sometimes it is nice to have the date in url too (e.g. domain.tld/news/2011/8/news-title.html). If enabled, the date is added to the url.

Each parameter (day, month, year) can be separately configured by using the full options of the php function date() . This example will add the day as a number without leading zeros, the month with leading zeros and the year by using 4 digits.

link {
        hrDate = 1
        hrDate {
                day = j
                month = m
                year = Y
        }
}
0
link.typesOpeningInNewWindow string Comma separated list of news types which open with target=”_blank” Default is 2 which is the type “Link to external page” 2
cropMaxCharacters integer Length of the teaser in list view. 150
orderBy string Field which is used to sort news records datetime
orderDirection string Field which is used to set sorting direction. This can either be desc or asc. desc
topNewsFirst boolean If set, news records which are are flagged as “Top News” are shown before the others 0
interfaces.media string List of classes which are considered for rendering media elements  
facebookLocale string Facebook locale which is used to translate facebook texts. Examples de_DE, fr_FR, … en_US
demandClass string Set a class which is used instead of the Demand class  

[tsref:plugin.tx_news.settings]

Reference for list view

The following table describes the settings concerning the list view.

Important: Those are set by using plugin.tx_news.settings.list!

Property: Data type: Description: Default:
paginate. array

news uses a custom viewHelper to render the pagination as the default one from fluid is very limited.

Following settings are available:

itemsPerPage

Define how many items are shown on one page.

insertAbove

Set it to TRUE or FALSE to either show or hide the pagination before the actual news items.

insertBelow

Set it to TRUE or FALSE to either show or hide the pagination after the actual news items.

maximumNumberOfLinks

If set, not all pages of the pagination are shown but only the given amount. Imagine 1000 news records and 10 items per page. This would result in 100 links in the frontend.

prevNextHeaderTags

Add additional header tags <link rel=”prev” href”” /> and <link rel=”next” href”” /> to tell google about the pagination. Read more at http://googlewebmastercentral.blogspot.co.at/2011/09/pagination-with-relnext-and-relprev.html

templatePath

Set a custom template file for the paginate widget. The path has to point to the template file, for example EXT:foobar/Resources/Private/Templates/ViewHelpers/Widget/Paginate/Index.html

Important: list.paginate.templatePath needs to be added to the setting overrideFlexformSettingsIfEmpty!

itemsPerPage = 10

insertAbove = TRUE

insertBelow = TRUE

lessPages = TRUE

forcedNumberOfLinks = 5

pagesBefore = 3

pagesAfter = 3

prevNextHeaderTags = 1
media.image.maxWidth integer/string Maximum width of images. If you need to crop the images, you need to use the attribute “width” instead of “maxWidth” and a value like “120c”. See http://docs.typo3.org/typo3cms/TyposcriptReference/Functions/Imgresource/Index.html?highlight=width for more information. 100
media.image.maxHeight integer/string Maximum height of images. The cropping feature can also be used, see the property media.image.maxHeight 100
media.dummyImage string Path to the used dummy image typo3conf/ext/news/Resources/Public/Images/dummy-preview-image.png

Reference for detail view

The following table describes the settings concerning the detail view.

Important: Those are set by using plugin.tx_news.settings.detail!

Property: Data type: Description: Default:
disqusShortname string If set, the commenting system of disqus (www.disqus.com) is used with the given name.  
errorHandling string If no news entry is found, it is possible to use various types of error handling. * redirectToListView: This will redirect to the list view on the same page. * redirectToPage: Redirect to any page by using the syntax redirectToPage,<pageid>,<status>. This means e.g. redirectToPage,123,301 to redirect to the page with UID 123 and error code 301. Important: A 404 status code is not allowed in PHP “Location:” header. Only 201, 3xx status codes are possible. * pageNotFoundHandler: The default page not found handler will be called.  

Reference for searchform view

The following table describes the settings concerning the list view.

Important: Those are set by using plugin.tx_news.settings.searchform!

Property: Data type: Description: Default:
       

Reference for Date Menu

The following table describes the settings concerning the list view.

Important: Those are set by using plugin.tx_news.settings.list!

Property: Data type: Description: Default:
       

Reference for rendering content elements

If news is configured to use relations to content elements, a basic TypoScript configuration is used to render those. This look like this:

lib.tx_news.contentElementRendering = RECORDS
lib.tx_news.contentElementRendering {
        tables = tt_content
        source.current = 1
        dontCheckPid = 1
}

If you need to extend this, you can either change the TypoScript (e.g. using a UserFunc) or the maybe easier way would be to change it in the template where the content elements are included by using the cObjectViewHelper of Fluid:

<f:if condition="{newsItem.contentElements">
        <f:cObject typoscriptObjectPath="lib.tx_news.contentElementRendering">{newsItem.contentElements}</f:cObject>
</f:if>

You could use your own ViewHelper to render those content elements as you need it.