EXT: news¶

New in tt_news 3.0¶

• New backEnd module to manage news records and categories: “news admin”
• FE plugin changes:- OptionSplit for many parameters (even in flexform)- New Display modes (CODEs) and template parts- Build-in processing of generic markers (thanks to Ringer Gerorg ;-) )
• Easy update: new updater script which fixes the most common migration problems
• Serious speed improvements: internal caching of processing intensive values
• Improved usability: reorganized constant editor options, plugin flexform and news record form.

See document “tt_news_3.0_changes.sxw” in the extensions doc/ folder for a more detailed description of the changes in tt_news 3.0

Compatibility¶

This version of tt_rews requires at least TYPO3 4.1.0 to run, some features require TYPO 4.2 or 4.3 (which is recommanded to use).

WARNING !! Do not install this tt_news version on TYPO3 prior to version 4.1.0 because it requires features that are not present in older TYPO3 versions. Don't even try it, because it might break your TYPO3 installation!

PHP version: tt_news should work on all PHP versions that are also supported by TYPO3 (from 5.2.x to 5.3.0).

MySQL version: 5.x.

Handling of Categories¶

Use "General record storage page"

You can configure the handling of news-categories with a checkbox in the extension manager:

The default is, to display categories only from the “General record storage page”. For more Information about categories and the “General record storage page” have a look at the “FAQ” in section “Quickstart”.

Require categories

Check if categories are required for every news item. Note that you can require categories also through page TSConfig using "TCEFORM.tt_news.category.config.minitems=1"

Caching¶

Internal caching

If enabled tt_news caches some processing intensive information (archive period count, category count, categories) in an internal cache.

Caching Mode

Determines the cache entries lifetime and when the internal cache from tt_news will be cleared. "normal": (default) the cache entries will get the same lifetime as normal pages. The tt_news cache will be cleared when the "clear all caches" button is pressed. "lifetime": will set the livetime of cache entries to the given amount of seconds in field "cacheLifetime". The cache table is not cleared when "clear all caches" is clicked. "static": means: the lifetime of cache entries is set to zero (= unlimited). TYPO3 does not clear the tt_news cache (useful if you clear the cache with an external script or for debugging).

Cache lifetime

Lifetime in seconds of the internal cache entries (if "cachingMode" is set to "lifetime"). example: 86400 (a day), 604800 (a week)

Caching engine

Where should the cache entries from tt_news be stored. "internal": store cache records directly in the database using internal methods. "cachingFramework" Requires at least TYPO3 4.3: store cache records in the TYPO3 caching framework (in the default configuration tt_news uses the DB backend of the caching framework).

Labels in List Module¶

You can configure which field is taken as label in the web/list module. Default is to display the title as label but you can change it f.e. to the date field (datetime) if you want to see the datetime as title.

The other options configure the alternative labels which will be shown if the title is empty. If the first alternative label is also empty, “Alternative label 2” will be displayed instead. If “Force alternative label” is activated the alternative labels will be shown always, even if the label field is not empty.

Example:

The author field is configured as “News label”, the title field is the “Alternative Label” and the datetime field is “Alternative Label 2”. Now the titles in lists will look like this:

Localization settings¶

Localization mode for text fields By default, all text fields (text, subheader, imagecaption ...) from a new localized news article will be prepended with "[translate to ...]". If this is not wanted you can disable it here.

Localization mode for images The image field of a localized news article is excluded by default (images are alwas taken from the record in the default language). If you need localized images (f.e. if the images show texts) you can enable the "image" field in translated news by setting "l10n_mode_imageExclude" to 0.

Hide new localizations By default, all text fields (text, subheader, imagecaption ...) from a new localized news article will be prepended with "[translate to ...]". If this is not wanted you can disable it here. If "l10n_mode_prefixLangTitle" is disabled the text "(copy [#])" will be added to the titles of this records unless "prependAtCopy" is disabled (see "prependAtCopy").

Prepend at copy¶

Here you can disable adding of the text "(copy [#])" to titles of copied records.

Category form fields¶

Category ordering in BackEnd trees Here you can configure the the ordering of categories in the category tree in BackEnd forms.

Width of the left category field This field shows the selected categories in the tt_news db-record (or parent categories in the category db-record). If "categorySelectedWidth" is set to 0 (zero) the default width (=180px) will be taken.

Width of the right category field This field shows the category tree in the tt_news db-record (or in the category db-record). If "categoryTreeWidth" is set to 0 (zero) the default width will depend on the browser which displays the TYPO3 BackEnd. The default width for all browsers except IE is 280px, for IE the default width is 320px to suppress the unneeded horizontal scrollbar below the category tree.

Debugging¶

Debug caching info

Which information about internal caching should be written to devlog (extension "devlog" required)."disabled": don't write any information about caching to devlog. "cache misses": log only cache misses. "all": log cache misses and cache hits to devlog.

Debug parsetimes

Write parsetimes to devlog (extension "devlog" required).

Parsetime threshold

Execution time in seconds after which a function is logged to devlog. Default is 0.1 sec = 100ms. Means any function in tt_news which needs more time to be executed will be logged. The execution time indicates the severity of the log entry: 0-0.2 sec = 0 (info), 0.2-0.5 sec = 1 (notice), 0.5-1 sec = 2 (warning) and everything above 1 second get severerity 3 = error.

Include static extension templates¶

The TS-settings are splitted in 3 different parts which should be included with the “Include static (from extensions)” feature.

For the first test, open your main TS-template (in list view), scroll down to the “Include static (from extensions)”-sectionand include one of the “base” templates from tt_news, f.e. the “table-based tmpl”. If you dont't know how to do this -> see section “Templates” in the “Getting Started” document: http://typo3.org/documentation/document- library/tutorials/doc_tut_quickstart/0.1.0/view/1/9/

If you want to use the CSS-based HTML-template you you should include the “default CSS-styles” template too, because it contains all the formating information.

The 4 static ext-templates offer you the following settings:

CSS-based tmpl: includes all tt_news TS settings for the new css- based template (but no ccs default styles)

default CSS-styles: This are the CSS-style definitions for the CSS- based template.

News-feed (RSS 0.91, RSS 2 , RDF, Atom 0.3, Atom 1.0): Include these settings if you want to enable XML feeds from your page.

Save your TS-template and open or create a page, where you want the news to appear.

Creating a “news” content-element:¶

Click on the "create new record" link, to add a new content-element. In the next screen click on the wizard link under “Pagecontent”.

The page that now openingis called the “new Content Element Wizard”. At the bottom of this page you'll find an icon called “News”':

Select it and choose the position (column): eg NORMAL:

A form will show up looking almost like this:

It is required, to select at least one item from the "What to display" field. If you don't do this, an error message will appear instead of the news content-element. To select an item, click on its name in the right list. (For the first test choose “LIST” or “LATEST” and leave the other settings at their defaults)

The “Startingpoint” is the page/sysfolder, where the extension looks for news-records. It is not required to set this value in this field, you can also define it with TypoScript for the whole page.See: section “Configuration/Reference” in this manual (-> pid_list)

If you don't insert a page as “Startingpoint” and no value for “pid_list” is defined by TS, the current page is used. That means the news-extension looks for news-records in the same page where the content-element is.

Creating a news database record:¶

To test the functionality of the extension you'll also need at least one news-record. Save & Close the form for the News content-element and click again on the "create new record" link.Choose the "News" item from the list.

A form opens, showing a news database record:

Fill in some dummy information, uncheck the "Hide" checkbox and save & close the form.

Assuming that you did not set a "Startingpoint" in the news content- element, and that the newly created news-record is located in the same page as the news content-element - click on the preview icon and you should see your news article in your browser.

If this is not the case, repeat the steps above. If still no news appear on your website, have a look in the section "Troubleshooting" of this document.

Sheet: General Settings¶

What to display:

Currently there are 7 different options in the “What to display”field (this list can be extended by other extensions). These are the function of this options:

plugin.tt_news = USER_INT

plugin.tt_news = USER

Sheet: Template¶

In the sheet Template, you can overwrite the html-template defined globally by TypoScript with another one.

It is not required to define a template in this place, because in most cases several news content-elements under one pagetree use the same html-template. This can be defined directly in the TS-setup or in the Constant-Editor of your main-(TS)template.

Hint The best way to include your own html-template is to link it directly in TS. Add the following line by hand to your TypoScript setup or edit the default value in the “TypoScript Object Browser” :

plugin.tt_news.templateFile = fileadmin/templates/tt_news_template.html

Do not edit and save the html-template in the extension directory -> it will be overwritten if you update tt_news.

You can change the news display, by simply creating a new template- file for the display of news. There are 2 default template-files included in tt_news (in the folder EXT:tt_news/pi/):

• tt_news_v3_template.html: the new css-based html-template.
• news_template.tmpl: the table-based template.

The main differences between the new css based template and the “traditional” template are:

• In the new template, the visual formating is moved from TypoScript to css-styles. GlobalWraps, GlobalColors and many of the Wraps (like “title_stdWrap”) are not used anymore.
• TypoScript still plays a big role in configuration for processing parts of the output (f.e.:”age_stdWrap”) or for inserting all kinds of conditional wraps (see: “getRelatedCobj” for an example)

if you want to change the template, take a look at that file, make a copy of it and modify it to your own design. Observe the comments in the file - they are markers that define where content is inserted and which parts are used for this and that. Self explanatory to a certain degree...

Max Width/Height for images

These 2 fields offer you the possibility to set the image sizes for a certain content element different from the image sizes defined globally by TypoScript. The setting here will be applied to all images, displayed by this content element (works with: LIST, LATEST, SINGLE and SEARCH)

Sheet: Category settings¶

The sheet “Category settings” offers a range of options regarding how to display category-texts (titles) and category-images.

The default setting is “Use the settings from TS” which is “Display but no link” for images and texts.

Sheet: Other settings¶

PageId for single news display:

This tells the extension on which page the single view is located. It's not required to set a value here, cause it's more efficient to set a global value for the single view (singlePid) in the constant- Editor of your root template. See: “ Configuration ”

PageId to Return to: Here you can set an alternative page for the "back to list" link in the single view. Works of course only if the current content element is SINGLE. By default the “back to List” Link in the SINGLE view points to the page where you came from. The setting here will override a globally given “backPid”.

Don't display first image in single view (firstImageIsPreview):

If you set this checkbox, the SINGLE view will not display the first image atached to the news article. The first image will only appear in LIST and LATEST view and is handled as "preview image" of the news item.(works only if more than one image is atached to the news article).

You can force this behavior even when only one image is assigned to the news record by checking the next checkbox (forceFirstImageIsPreview)

Limit: max items in LIST and LATEST

here you can set a limit only for this content-element. A value from this field will override the limits configured by TypoScript.

Don't display Pagebrowser

as the name says.

Insert pagebreak in SINGLE after this number of words

If you want to override the globally configured value for “maxWordsInSingleVIew” in the current content-element, you can insert the new value here. For more information see section “Pagebreaks” in this manual.

Starting point and Recursive level selection:

"Starting point" is used to tell the extension where the news records are stored. It is possible to select multiple ”Starting points”. This way, you are able to collect news from several folders to display them in one content-element.

If you don't insert a page as "Starting point", tt_news will look for a value for “pid_list” from TypoScript. This is the recommended way to configure many news content-elements from one central point, e.g. from the constants field in your main TS-template. -> see files EXT:tt_news/static/ts_new/constants.txt & EXT:tt_news/static/ts_new/setup.txt for examples. The “Starting Point” can also be set in the Constant editor.

If no value for “Starting Point” is present at all, the current page is used. (the page where you inserted the tt_news content-element).

Recursive level selection:

This tells the extension how many levels of subpages to include below the page(s) given in the "Starting point" field.

Hint If you have your news not stored in a few dedicated sysfolders but scattered around in a huge pagetree it might be helpful to disable the pid_list/recursive functionality completely (see: “dontUsePidList”). Reason: TYPO3 checks each page in the pid_list for visibility and if the current FE user is allowed to see this page. When you have a very long pid_list which is generated from a whole pagetree this will take quite a lot processing power.

Typoscript for this content element

The tab “Other Settings” offers a new field “Typoscript for this content element (plugin.tt_news.[your TS])”. Since access to TypoScript for non-admin users is a security risk, this field is only visible for admin users. The Typoscript in this field is merged with the existing TypoScript setup for “plugin.tt_news”. If you f.i. want to add a wrap to the output of a single plugin simply write this to the TypoScript field:

stdWrap.wrap = <div class”myclass”> | </div>

Title¶

The value inserted here will subsitute the marker ###NEWS_TITLE### in the html template.

Type¶

Here you can define the type of the newsitem. The different types are shown with different icons in the BackEnd. Possible types are:

Restrict editing by non-Admins¶

If this “editlock” is enabled non-admin users can't open this record. All other actions (hide,copy,delete,....) are also disabled.

Hide, Start, Stop and Access¶

With the fields “Hide”, “Start”, “Stop” and “Access” you can configure the visibility of the current newsitem. The settings made here will override visibility settings from categories that are assigned to this news record.

Date/Time¶

The value of this field affects several things:

• The news in lists andin the archivemenu (amenu) are ordered by this field if no other filed is selected (-> see "Order by" this field in section “The tt_news content element”)
• If a value for “datetimeDaysToArchive”, “datetimeHoursToArchive” or “datetimeMinutesToArchive” is set, these value is added to the value of the datetime field and handled as archivedate. (see section “The archive” in this manual)
• The value of these field is taken for the html-template markers ###NEWS_DATE###, ###NEWS_TIME### and ###NEWS_AGE###. (all parsed through the stdWrap functions “strftime” or “age”)

For new created records the current time is inserted atomatically.

Archivedate¶

If archivedate shows a value in the past, the news record will be shown in lists showing only archived news. Of course it will disappear from lists showing only non-archived news.

Transl.Orig¶

This field appears only in translated news records and points to the translation Original. (The translation original has to be in the default language)

Language¶

This field shows the language of the newsitem. This field should be not edited by hand because its value is handled by the translation system of TYPO3.

Author and Email¶

The values of this fields will substitute the html-template markers ###NEWS_AUTHOR### and ###NEWS_EMAIL###. By default only the author will be displayed and linked to the author's email address.

Hint:

If you need an author field which is a relation to another table where the authors are stored (f.e. fe_users), install the extension “News author relations” (extkey: news_author_rel) http://typo3.org/extensions/repository//news_author_rel/ which extends tt_news by this feature.

Versioning Label:¶

The versioning label of this record. This field is only visible when the extension "versioning" (extkey version) is installed.

Subheader¶

The value of this field will substitute the html-template marker ###NEWS_SUBHEADER###. If this field is empty the value of the field “Text” is taken instead.

Text¶

This is the main text of the news article and will substite the html- template marker ###NEWS_CONTENT###.

No automatic pagebreaks for this record¶

this will disable automatic pagebreaks after a certain amount of words for this record.

Keywords¶

The content of this field is written to a TypoScript register ("newsKeywords") which can be used to insert the keywords as "<meta> keywords" to the page header (plugin "metatags" required). If you don't need this field for "<meta> keywords" you can use it as a second "subheader" field (it will substitute the template marker ###NEWS_KEYWORDS###).

Category¶

Here you can assign categories to the current news record (if this record is no translation of another record).The available categories will be displayed in a tree. The titles of the assigned categories will substite the html-template marker ###NEWS_CATEGORY###, the category images will be written to the marker ###NEWS_CATEGORY_IMAGE###. Tt's possible to control editing permissons of news articles with the assigned categories. See section “Categories” for more information.

Images¶

Here you can define images that will be shown in the news item. All images will be rendered to the marker ###NEWS_IMAGE###.

Caption¶

Field for the imagecaption which will be displayed under the image. If more than one image is assigned the value of this field can be splitted by linebreaks.

Image altText and Image titleText¶

In these fields you can define two texts that will be inserted as alt and title texts in the image html tag. If more than one image is assigned the values of these fields can be splitted by linebreaks.

Links¶

The links that are inserted here will be displayed under the "bodytext" in the news single view. They will substite the marker ###NEWS_LINKS###. This field is parsed through the stdWrap function "parseFunc" so it will be possible to enter links as typolink. F.e.: <LINK http://typo3.org _blank>open typo3.org</LINK>

Related News¶

In this field you can select news records or pages that will be displayed as related news. Related news with type “news” will point to the single view of the related news record. Related news with type “External URL” or “internal Link” will point to the url or page id that is inserted in the news record. Related pages will be handled as news with type “internal link”.

Related news will substite the marker ###NEWS_RELATED###.

Files¶

Here you can attach files to a newsitem. Files will substite the marker ###FILE_LINK###.

Controlling editing permissions with assigned categories:¶

It's possible to control the editing permissions for news records with the assigned categories. This is either possible by editing the Tsconfig field of the be_user/group or – since tt_news 2.5.0 – by selecting the allowed/visible categories from a category tree in the be_user/group record. The category tree in be_user records appears only if the user is not admin. In the sreenshot below you see a be_user record where the user is only allowed to edit or assign the category “Commitees” and its subcategories.

If thís user opens a news record he will only see the category “Commitees” and its subcategories.

If a BE-user is restricted to certain categories he can only change news records that have these categories assigned. If he performs any action (move, delete, hide, localize, copy, version, modify) with a record that has non-allowed categories assigned an error message will be displayed and the action will be ignored.

Another message will be displayed in the news record above the fields "Type" and "Category". Non-selectable categories will be displayed in grey text and not linked. See screenshot below. Defining allowed categories is also possible by inserting their uids in the Tsconfig field of a be_user or be_group record.

Example:

(user/group TSconfig)

# this enables the use of the list below
options.useListOfAllowedItems = 1
# users of this group are only allowed to save news records with the following categories:
tt_newsPerms.tt_news_cat.allowedItems = 35,36,37

If the BE-user with this configuration opens a record that has at least one category assigned that is not in the list of allowed items he will see the error message below.

The category rootline¶

The tt_news html template contains a marker ###NEWS_CATEGORY_ROOTLINE###. This marker will be filled with the titles of the parent categories of the first assigned category in SINGLE view or with the parents of the selected category in LIST view. It doesn't work in LIST view if more than one category is selected.

The category titles can be linked to the category shortcut page which is configured in the category db-record.

plugin.tt_news {
  # settings for the category rootline
  catRootline {
    showCatRootline = 1
    catRootline_stdWrap.wrap = <div class="news-catRootline">|</div>
    # if titles are linked the link points to the page which is configured as category shortcut
    linkTitles = 1
    title_stdWrap.wrap =
    divider = &nbsp;&gt;&nbsp;
  }
}

Title and Title language overlays¶

In the field “title language overlays” you can define titles for other languages. If you have more than one additional language, you can split the titles with the “|” symbol. Example: if you have a website with 3 languages (en,de,fr) you write the category title for the default language in the field “Title”. The titles for german an french are stored in the field “title language overlays” like this:

the order of the overlay titles has to be the same as the order of your system languages.In this example: en=0, german=1, french=2

Parent category¶

In the Field “Parent category” you can define the current category as a subcategory of the category which is selected in this field. That will include the current category and the newsitems which have this category assigned when the parent category is selected. This works recursive.

Hide, Start, Stop and Access¶

With the fields “Hide”, “Start”, “Stop” and “Access” you can f.e make this category and the newsitems that have this category assigned only visible for a certain usergroup. Works recursive for subcategories.

Category Image¶

You can upload or assign an image for each news category which is shown in the CATMENU element (“catmenuIconMode = -1”) and as category images (f.e. instead of the category title). The behavour of the category titles/images can be configured in the sheet “Category settings” in the news content element.

The category titles/images can act as shortcut to a page or as “category selector” which means: the contents of a news-list ist filtered by category. Filtering by category works recursive for subcategories.

Category shortcut¶

Category titles or images can also act as shortcut to an internal page. If this is enabled and a visible page is defined as shortcut, the link from the category title or image points to this page.

Target for news category shortcut¶

With the field “Target ...” you can configure a target for the category shortcut (this setting will have priority over a global setting for link targets in your website)

Single-view page for news from this category¶

The field "Single-view page for news from this category" gives you the possibility to define a single-view page for each category. If you want to use this feature it is required to add "useSPidFromCategory = 1" to the TypoScript setup.

If a news-record has 2 or more categories assigned the SinglePid will be taken from the first category which is assigned to the news record.

Description¶

Here you can enter a description for the current category which will be shown as tooltip in the category tree in BE and in the CATMENU content element in FE. If you have long description texts (>70 chars) Firefox and Mozilla will not display the tooltips correctly. Solution: There are some Firefox extensions which correct this problem. I tried "Popup Alt Attribute" which works flawless for me (see screenshot).

Example:C ategory description as tooltip in the category select field:

mode “tree”¶

The tree mode has some special options for configuring the icons. The option “catmenuIconMode” configures the behaviour of the icons showing left to the category titles. “catmenuIconMode” offers the following options:

• -1 = display no icons at all
• 0 = display the default icon (tt_news_cat.gif)
• 1 = display image from category record as icon
• 2 = display the icon which is configured as “catmenuIconFile” (default: EXT:tt_news/res/arrow.gif)

The icon for the “root” item of the tree (the catmenu header) can be configured separately (“catmenuRootIconFile”) or completely disabled by seetting “catmenuNoRootIcon” to 1.

The sizes for the normal icons in catmenuIconMode “1” and “2” and for the root icon can be configured separately.

plugin.tt_news {
  displayCatMenu {
    # select root icon file
    catmenuRootIconFile = EXT:tt_news/res/tt_news_cat.gif
    # enable root icon
    catmenuNoRootIcon = 0
    # disable other icons
    catmenuIconMode = -1
  }
}

mode “ nestedWraps ”¶

In this mode each level of the "catmenu" has its own wrap. 1 is the first level.

plugin.tt_news {
  displayCatMenu {
    mode = nestedWraps
    # wrap for the complete "catmenu"
    catmenu_stdWrap.wrap = <div class="news-catmenu">|</div>
    # wraps for active or inactive category links in the tree
    catmenuItem_ACT_stdWrap.wrap = <img src="tslib/media/bullets/bullet1_h.gif" />|
    catmenuItem_NO_stdWrap.wrap = <img src="tslib/media/bullets/bullet1_n.gif" />|

    # wrap for level "n"
    catmenuLevel1_stdWrap.wrap = <div class="level1">|</div>
    catmenuLevel2_stdWrap.wrap = <div class="level2">|</div>
    catmenuLevel3_stdWrap.wrap = <div class="level3">|</div>
    catmenuLevel4_stdWrap.wrap = <div class="level4">|</div>
  }
}

.news-catmenu  {
   padding:5px 0px 0px 5px;
   margin:10px;
   border:1px solid #666;
   background-color:#F9FFE5;
}
.news-catmenu DIV IMG {
   margin:0px;
   padding: 0px 3px 3px 0px;
   vertical-align: middle;
}

Pagebreaks¶

When you have long articles in SINGLE view, you might want to split them into multiple pages and have a page navigation inserted to navigate between these split pages.

This can be done automatically by specifying the amount of words after that a pagebreak is inserted. When the amount of words is reached, the extension looks for the next dot (.) and inserts a pagebreak after it (default). Alternatively you can configure tt_news to insert pagebreaks only after paragraphs (an empty line in the bodytext field) by setting “useParagraphAsPagebreak=1”.You can disable this feature for each news record (“No automatic pagebreaks for this record”).

You can also add a manual pagebreak at a specific position in the text. At the desired position, enter the text:“<---newpage--->” (default) or the string that you configured as “pagebreakToken”. This will trigger a pagebreak at this position. On the new page, the wordcounter starts again for automatic pagebreaking. However, manual pagebreaks work even when the automatic pagebreak feature is disabled.

The subheader is by default only displayed on the first page of a single view with multiple pages. If this is not wanted the subheader can be configured to appear on all those pages by setting “subheaderOnAllSViewPages=1”.

One thing to note is the way images are handled on multiple pages. The images for the additional pages in single view are asssigned by their position in the Image-list of the news record.

Example: If you have 6 images assigned and “imageCount” for the single view set to “2”, then the first 2 images will appear on the first page, the second two images at the second page and so on.

There is a seperate marker for the pagebrowser in single view:

###NEWS_SINGLE_PAGEBROWSER###

Alternatively it is possible to simply append the pagebrowser to the bodytext without a special marker by setting “appendSViewPBtoContent=1” (this is the default).

Example:

# TS setup
plugin.tt_news {
  useMultiPageSingleView = 1
  pageBreakToken = <break>
  maxWordsInSingleView = 300
  useParagraphAsPagebreak = 1
  subheaderOnAllSViewPages = 0
  appendSViewPBtoContent = 0
}

This will enable the pagebrowser for the Single view. The string “<break>” will trigger a manually pagebreak. If the text is longer than 300 words, a pagebreak will be inserted automatically after the next paragraph (an empty line in the field bodytext). The subheader will be displayed only on the first page and the pagebrowser will be rendered to its own marker (###NEWS_SINGLE_PAGEBROWSER###).

For a detailed description of the TypoScript options that are mentioned here, take a look at the section “Reference”.

Related news or related pages¶

The news records that are inserted in the field “Related news” in the tt_news db-record are shown in the single view. If those records are “normal news”, their links point to the single view of the related news article. Related news with type “link external URL” or “link internal page” will link directly to the url or page id that is configured in the news record.

Additionally to news records, relations can also point directly to internal pages. Related pages will be handled as news that link to internal pages.

tt_news can be configured to insert the link that points back from the related record to the current one automatically. This feature can be enabled by setting “useBidirectionalRelations” to 1.

The display of related news and pages is configured by TypoScript. For more information search for “getRelatedCObject” in the section reference of this manual. The details of the link configuration can be found in the section “Link Configuration”.

Related news by category¶

The single view can also be configured to show a list of news articles with the same category as the current article. The feature is disabled by default and can be enabled by setting “showRelatedNewsByCategory=1”.

If news with the same category are found, they will be rendered as news LIST to the marker “###NEWS_RELATEDBYCATEGORY###”. The header will be rendered to the marker “###TEXT_RELATEDBYCATEGORY###”.

By default the code LIST causes tt_news to render the content to the template ###TEMPLATE_LIST### This can be changed with “altMainMarkers” to take an userdefined template instead which f.e contains only the news titles. The template for “related news by category” is included in the file tt_news_v2_template.html -> part: “###TEMPLATE_CAT_RELATED###”

plugin.tt_news {
  # wrap for all related news by category
  relatedByCategory_stdWrap.wrap =  <dl class="news-single-related">|</dl>
  # wrap for the header
  relatedByCategoryHeader_stdWrap.wrap = <dt>|</dt>
  # globalwrap 3 is used to wrap the list items
  wrap3.wrap = <dd>|</dd>

  # change the name for template LIST to TEMPLATE_CAT_RELATED
  altMainMarkers.TEMPLATE_LIST = TEMPLATE_CAT_RELATED
  altMainMarkers.TEMPLATE_LIST.wrap = ### | ###
}

# this changes the template part for list only if a SINGLE view was requested
[globalVar = GP:tx_ttnews|tt_news > 0]
plugin.tt_news {
  altMainMarkers.TEMPLATE_LIST = TEMPLATE_CAT_RELATED
  altMainMarkers.TEMPLATE_LIST.wrap = ### | ###
}
[global]

News 1¶

News 2¶

News 3¶

News 4¶

News 4a¶

News 5¶

enable¶

0¶

- 2 3 4 4a 5

1 2 3 4 4a 5

1 2 3 4 4a 5

1 2 3 4 4a 5

1 2 3 4 4a 5

0¶

- - - 4 4a 5

- - - 4 4a 5

1 2 3 - -  -

1 2 3 - -  -

1 2 3 4 4a 5

1¶

- 2 3 4 4a -

1 2 3 4 4a -

1 2 - - 4a 5

1 2 - - 4a 5

1 2 3 4 4a 5

1¶

- - 3 4 4a -

- - 3 4 4a 5

1 2 - - -  -

1 2 - - -  -

1 2 3 4 4a 5

Note that newsitems with an empty archivedate will appear in all lists.Starting from version 2.5.2 newsitems without archivedate will not be displayed in the list of archived items if item is archived according to other criterias (see bugs 3930, 3714). To enable old behavior, set “compatVersion” to “2.5.0” in TypoScript setup.

FAQ¶

• Q: Is the singlePid required? A: yes, since tt_news 1.3.0 it is not possible to see the single view on the f.e. LIST page when no singlePid was defined.
• Q: What means this error message: "Attempt to insert record on page '[root-level]' (0) where this table, tt_news_cat, is not allowed"? A: That means, that you didn't define a "General Records Storage page" (-> see next question) and so TYPO3 tries to create the new news-category in the rootpage (page id=0).
• Q: what is the "General Records Storage page" (GRSP) and where do I have to set it? A: If you set “use StoragePid” in the extension manager, the "GRSP" points to the page, where to look for categories that are displayed in forms in the BackEnd. The “GRSP” has to be set in the page properties of your websites rootpage (the page with “is root of the website” flag)Remember: The "General Records Storage page" (or “StoragePid”) is not the “Starting Point”

¶

¶

plugin.tt_news {
  pageTypoLink.target = _top
}

Links in “normal” newsitems that points to the single-view.¶

<!--###LINK_ITEM###-->
###NEWS_IMAGE###
<!--###LINK_ITEM###-->

plugin.tt_news {
  singlePid = 132
}

plugin.tt_news {
  singlePid = 465
}

Category Shortcut¶

plugin.tt_news {
  catImageMode = 2
}

Catselector¶

plugin.tt_news {
  catTextMode = 3
}

plugin.tt_news {
  itemLinkTarget = page
  catSelectorTargetPid = 78
}

Archive Link¶

plugin.tt_news {
  archiveTypoLink.parameter = 34
}

Pagebrowser links¶

Links in the “SINGLE” view

Some of the link-types in the single view are configured with the same parameters as shown in the table above:

• Links to internal pages (see -> getRelatedCObject)
• Links to external URLs (see -> getRelatedCObject)
• Category-links that point to category-shortcuts (2) (the catselector mode will not work - and does not make sense - in single view)

Links to “related news”¶

Links to Files¶

News Links¶

<LINK http://mysite.com _blank>open mysite</LINK>

Back-Link¶

Image Link in Single view¶

Email link¶

Search page id¶

((generated))¶

options.useListOfAllowedItems = 1
tt_newsPerms.tt_news_cat.allowedItems = 35,36,37

tt_newsPerms.tt_news_cat.excludeList = 1,2,3

tt_newsPerms.tt_news_cat.includeList = 4,5,6

options.saveDocNew.tt_news = 1
options.saveDocNew.tt_news_cat = 1

options.disableDelete.tt_news_cat = 1

TCAdefaults.tt_news.hidden = 0

((generated))¶

tx_ttnews.singlePid = 37

TCEFORM.tt_news.type.removeItems = 2

content(default)¶

RTE.default {
  proc {
    preserveTables = 1
    overruleMode = ts
  }
}

content(default)¶

RTE.default {
  proc {
    preserveTables = 1
    overruleMode = ts
  }
  showButtons = table
}

css_styled_content¶

Notice: If your news sysfolders are not located under your website's “root-page” you'll have to add the settings from the table above to the PageTSconfig of your news sysfolders.

((generated))¶

RTE.config.tt_news.bodytext {
  proc {
    preserveTables = 1
    overruleMode = ts_css
  }
  showButtons = textcolor,bgcolor
}

((generated))¶

TCEMAIN.clearCacheCmd = 647,637

pi/class.tx_ttnews.php¶

class.ext_update.php¶

class.tx_ttnews_catmenu.php¶

class.tx_ttnews_tcemain.php¶

class.tx_ttnews_treeview.php¶

class.tx_ttnews_itemsProcFunc.php¶

pi/news_template.tmpl¶

pi/news_help.tmpl¶

res/tt_news_languageMenu.php¶

res/example_itemMarkerArrayFunc.php¶

res/example_amenuUserFunc.php¶

res/example_imageMarkerFunc.php¶

res/example_userPageBrowserFunc.php¶

folders:static/ts_new¶

pi/tt_news_v2_template.html¶

res/tt_news_v2_styles.css¶

res/rss_0_91.tmpl¶

res/realurl_localconf.txt¶

General Settings¶

plugin.tt_news {
  templateFile = fileadmin/my_templates/tt_news.html
}

# clear the value
plugin.tt_news.pid_list >
# display news records located in page 582 & 584
plugin.tt_news.pid_list = 582,584

plugin.tt_news.dontUsePidList = 1

plugin.tt_news.recursive = 3

plugin.tt_news.code = LATEST

# singlePid for a news element inserted by TS
plugin.tt_news.singlePid = 590

TEMPLATE_LATEST
TEMPLATE_LIST
TEMPLATE_SINGLE
TEMPLATE_SINGLE_RECORDINSERT
TEMPLATE_ARCHIVE
TEMPLATE_SEARCH
TEMPLATE_ARCHIVE_NOITEMS
TEMPLATE_HEADER_LIST
TEMPLATE_CAT_RELATED
/+ stdWrap

plugin.tt_news {
  altMainMarkers.TEMPLATE_SINGLE =   SINGLE_CUSTOM
  altMainMarkers.TEMPLATE_SINGLE.wrap = ### | ###
}

Settings for Links:¶

plugin.tt_news {
  useHRDates = 1
  useHRDatesSingle = 1
  useHRDatesSingleWithoutDay = 1
}

plugin.tt_news {
  pageTypoLink.target >
  pageTypoLink.target = _blank
}

# points to the page with id=34 and adds '&myvar=foo' to all links.
plugin.tt_news {
  archiveTypoLink.parameter = 34
  archiveTypoLink.addParams = &myvar=foo
}

plugin.tt_news.displayList {
  linkTitleField = title
  linkTitleField.wrap = go to  |
}

<a href=”news/single/title.html” title=”go to title”>the title</a>

Global Wraps¶

I f you use the new css-based html-template you don't need to define “Global Wraps” and “Global Colors” because the complete visual formating is done with CSS-tyless. But of course those wraps and markers can be used for other purposes.

plugin.tt_news.wrap1.wrap = <strong> | </strong>

Search Settings¶

Pagebrowser Settings¶

-> pageBrowser.[options]¶

This is the configuration array for the pagebrowser. All settings here start with “pageBrowser.”. The formating of the pagebrowser is done by CSS. See _CSS_DEFAULT_STYLE at the end of this list for an example.

plugin.tt_news {
  pageBrowser {
    maxPages = 10
    showPBrowserText = 1
    tableParams = cellpadding=2
    showResultCount = 1
  }
}

plugin.tt_news.pageBrowser {
  browseBoxWrap.wrap = <div class="browseBoxWrap">|</div>
  showResultsWrap.wrap = <div class="showResultsWrap">|</div>
  browseLinksWrap.wrap = <div class="browseLinksWrap">|</div>
  showResultsNumbersWrap.wrap = <span class="showResultsNumbersWrap">|</span>
  disabledLinkWrap.wrap = <span class="disabledLinkWrap">|</span>
  inactiveLinkWrap.wrap = <span class="inactiveLinkWrap">|</span>
  activeLinkWrap.wrap = <span class="activeLinkWrap">|</span>
}

Archive Settings¶

plugin.tt_news.archive = 1

plugin.tt_news.datetimeDaysToArchive = 30

plugin.tt_news.archiveMode = month

plugin.tt_news.archiveTitleCObject {
    10 = TEXT
    10.field = start
    10.strftime = %B - %Y
}

plugin.tt_news {
  reverseAMenu = 0
  archiveMode = quarter
  archiveTitleCObject >
  archiveTitleCObject = COA
  archiveTitleCObject {
    10 = COA
    10 {
      10= TEXT
      10 {
        field = start
        strftime = %b - 
        wrap = <strong>|
      }
      11 = TEXT
      11 {
        field = stop
        strftime = %b %Y
        wrap = |</strong>
      }
      if {
        value.field = start
        equals.data = GPvar:tx_ttnews|pS
      }
    }

    20 = COA
    20 {
      10= TEXT
      10 {
        field = start
        strftime = %b -&nbsp;
        wrap =
      }
      11 = TEXT
      11 {
        field = stop
        strftime = %b %Y
        wrap =
      }
      if {
        value.field = start
        equals.data = GPvar:tx_ttnews|pS
        negate = 1
      }
    }
  }
}

Display Settings for “SINGLE”,”LIST” and “LATEST”¶

plugin.tt_news {
  general_stdWrap >
  general_stdWrap {
    parseFunc < tt_content.text.20.parseFunc
  }
}

plugin.tt_news {
  listStartId = 4
  limit = 3
}

plugin.tt_news.listOrderBy = title desc

plugin.tt_news.listOrderBy = random

lib.newsLatest < plugin.tt_news
lib.newsLatest {
  code >
  code = LATEST
  catImageMode = 0
  catTextMode = 1
  listOrderBy = title asc
  listGroupBy = category
}

plugin.tt_news.displayList.subheader_stdWrap {
  crop = 300 | ... | 1
  ifEmpty.field = bodytext
}

plugin.tt_news.useBidirectionalRelations = 1

plugin.tt_news {
### Settings for Related News:
  related_stdWrap.wrap = <dl class="news-single-related">|</dl>
  relatedHeader_stdWrap.wrap = <dt>|</dt>

  # icon for related news
  tmp.5 = IMAGE
  tmp.5 {
    file = EXT:tt_news/ext_icon.gif
    file.width = 11
    file.height = 12
    wrap = | &nbsp;
  }

  # end-wrap for the getRelated objects
  tmp.20 = TEXT
  tmp.20 {
    field = datetime
    strftime = %d-%m-%y %H:%M
    wrap = &nbsp;-&nbsp; |
  }

  # Build the list of related news:
  getRelatedCObject = COA
  getRelatedCObject {
    # groupBy =
    orderBy = datetime desc

    10 = CASE
    10.key.field = type
    # settings for 'normal' related news
    10.default = COA
    10.default {
      wrap = <dd> | </dd>
      5 < plugin.tt_news.tmp.5
      10 = TEXT
      10.field = title
      10.typolink.parameter = {$plugin.tt_news.singlePid}
      10.typolink.additionalParams.data = register:newsAddParams
      10.typolink.useCacheHash = 1
      20 < plugin.tt_news.tmp.20
    }
        # settings for related news, that point to internal pages
    10.1 = COA
    10.1 {
      wrap = <dd> | </dd>
      5 < plugin.tt_news.tmp.5
      5.file = EXT:tt_news/res/tt_news_article.gif
      10 = TEXT
      10.field = title
      10.typolink.parameter.field = page
      20 < plugin.tt_news.tmp.20
    }
    # settings for related news, that point to external URLs
    10.2 = COA
    10.2 {
      wrap = <dd> | </dd>
      5 < plugin.tt_news.tmp.5
      5.file = EXT:tt_news/res/tt_news_exturl.gif
      10 = TEXT
      10.field = title
      10.typolink.parameter.field = ext_url
      20 < plugin.tt_news.tmp.20
    }
  }
}

plugin.tt_news.getRelatedCObject.orderBy = title

plugin.tt_news.getRelatedCObject.groupBy = type

plugin.tt_news.noNewsToListMsg_stdWrap.wrap = <p>|</p>

plugin.tt_news.substitutePagetitle = 1

SINGLE view with pagebreaks¶

plugin.tt_news {
  useMultiPageSingleView = 1
}

plugin.tt_news {
  pageBreakToken = <break>
}

plugin.tt_news {
  singleViewPointerName = page
}

plugin.tt_news {
  appendSViewPBtoContent = 1
}

News Images¶

plugin.tt_news.displayList.imageCount = 0

plugin.tt_news.displayList.image {
    file.maxW = 120
    file.maxH = 90
    imageLinkWrap = 1
    stdWrap.spaceAfter = 5
}

plugin.tt_news.displayList.image.noImage_stdWrap {
  cObject = IMAGE
  cObject {
    wrap =
    file = GIFBUILDER
    file {
      XY = {$plugin.tt_news.listMaxW},{$plugin.tt_news.listMaxH}
      backColor = #ffffff

      10 = TEXT
      10 {
        text = No image
        fontSize = 14
        niceText = 1
        fontColor = #000000
        offset = {$plugin.tt_news.listMaxW}/2-30, {$plugin.tt_news.listMaxH}/2+4
      }
    }
  }
}

plugin.tt_news.firstImageIsPreview = 1

News Files¶

plugin.tt_news {
  newsFiles_stdWrap.wrap = <dl class="news-single-files">|</dl>
  newsFilesHeader_stdWrap.wrap = <dt>|</dt>
  newsFiles {
    path = uploads/media/
    icon = 1
    stdWrap.wrap = <dd>|</dd>
  }
}

Date & Time wraps¶

plugin.tt_news.displayList {
    date_stdWrap.strftime= %A %d. of %B %Y
}

plugin.tt_news.displaySingle {
    time_stdWrap.strftime = %H:%M
}

plugin.tt_news.displaySingle {
  age_stdWrap.age =  Minuten | Stunden | Tage | Jahre
}

Category Settings¶

plugin.tt_news {
  useSubCategories = 1
  displaySubCategories = 1
}

plugin.tt_news.categoryMode = -1

# this will only show items with category 2 or 3
plugin.tt_news {
  categorySelection = 2,3
  # show only selected categories
  categoryMode = 1
}

plugin.tt_news {
  categorySelection.data = register:whatever
}

# don't display any category images
plugin.tt_news.catImageMode = 0

# don't display any category titles
plugin.tt_news.catTextMode = 0

plugin.tt_news.latestWithCatSelector=1

plugin.tt_news {
  displayList {
    subCategoryImgItem_stdWrap.wrap = <span class="scat-img">|</span>
    subCategoryTitleItem_stdWrap.wrap = <span class="scat-title">|</span>
  }
}

# this will order the categories in news articles and in the CATMENU alphabetically
plugin.tt_news {
  catOrderBy = title
}

plugin.tt_news {
  # order categories in LIST by uid
  displayList.catOrderBy = uid
  # order categories in SINGLE and CATMENU by title
  displaySingle.catOrderBy = title
  displayCatMenu.catOrderBy = title
}

# This is the default setup
plugin.tt_news {
  categoryDivider = ,
  categoryDivider_stdWrap.noTrimWrap = || |
}

Settings for the CATMENU -> displayCatMenu.[options]¶

This is the configuration array for the content element “CATMENU”. All settings here start with “displayCatMenu.”

plugin.tt_news {
  displayCatMenu {
    mode = nestedWraps
  }
}

plugin.tt_news {
  displayCatMenu.excludeList =
  displayCatMenu.includeList =

plugin.tt_news {
  displayCatMenu {
    catmenuIconMode = 2
    catmenuIconFile = EXT:tt_news/res/arrow.gif
    catmenuIconFile {
      width = 18
      height = 16
    }
  }
}