DEPRECATION WARNING

This documentation is not using the current rendering mechanism and will be deleted by December 31st, 2020. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

Plugin

The news plugin is used to output a defined list of records.

It can be added to create a content element with the type “Plugin” and by selecting the plugin type “News system”.

The available actions are:

List

The list action displays a list of defined records. The filters can be defined either in the plugin or by using TypoScript and are described here.

2 different list modes are available.

List view

If a plugin is configured to show this implementation of the list action, it will change its behaviour if the URL contains a link to a detail action! If this is fulfilled, the detail action will be shown instead of the list action.

List view (without overloading detail view)

The described behaviour of the first implementation might not be desired all the time. A typical example is to show a list view in the sidebar of a detail view page. If the above action would be used, the detail view would be shown in the sidebar too.

List of articles

Show a specific list of articles

Detail

There are 2 typical use cases for this action:

  • Use this action to show a full news record which is linked by a list view.
  • Provide a specific news record to output that one. This is very useful to embed a news record e.g. in a newsletter.

Date menu

Use this action to show a list of news items grouped by the date. A typical output can look like:

2015
        January: 13 entries
        February: 9 entries
        March: 6 entries
        June: 4 entries
        ...
2014
        March: 81 entries
        April: 32 entries
        May: 1 entry

If you define a specific page id in field “PageId for list display” (inside the tab “Additional”) and placing a news plugin with the type “List” there, it is possible to create a date filter.

Search form

Use this action to show a basic search inside news records.

Search result

The search result action is based on the list action including an additional filter provided by the search form.

Category menu

Use this action to show a list of categories. The categories are listed as tree.

If you define a specific page id in field “PageId for list display” (inside the tab “Additional”) and placing a news plugin with the type “List” there, it is possible to create a category filter.

Tag list

Use this action to show a list of tags.

If you define a specific page id in field “PageId for list display” (inside the tab “Additional”) and placing a news plugin with the type “List” there, it is possible to create a tag filter.