EXT: JS-Ticker newsfeed export¶

Table of Contents¶

EXT: JS-Ticker newsfeed export 1

Introduction 1

What does it do? 1

Screenshots 2

Users manual 2

FAQ 3

Configuration 3

Reference 3

Known problems 4

To-Do list 4

Changelog 4

Introduction¶

Users manual¶

Install the extension via the EM.

You can then insert a new content element type “JavaScript Newsticker” on any page:

Enter a header title and tick the checkbox “Protect external access to this newsticker?” if you wish it to be protected.

Protection in this case means that

a user needs to be logged in as a valid FE user in order to be presented the URL to the ticker

the URL for external access to the ticker will contain the user's username and his md5'ed password hash

The URL a user is shown in order to view our JS ticker basically looks like this:

1. non-protected ticker:

index.php?id=<id_of_this_page>&type=222&feed_id=<content_element_id>&<some_settings_stuff>

2. protected ticker:

index.php?id=<id_of_this_page>&type=333&feed_id=<content_element_id>&user=<fe_username>&pass=<md5_hash>&<some_settings_stuff>

An extension template needs to be created on the page the newsticker resides on to make some adjustments that are necessary in order to get properly formatted link tags etc.

An exemplary template setup should look somewhat like this:

cm_jstickernews >
cm_jstickernews = PAGE
cm_jstickernews {
  typeNum = 222
  config.disableAllHeaderCode = 1

  includeLibs.cm_jsticker = EXT:cm_jstickernews/pi1/class.tx_cmjstickernews_pi1.php

  10 = USER
  10 {
    userFunc = tx_cmjstickernews_pi1->make_ticker

    # prefix for direct tt_news item links
    # set up a news details page (code=SINGLE) with an extension template
    # that sets the correct backPID value to a news overview page!
    tickerItemLinkPrefix = http://your.domain.tld/newsfeeddetail.html?tt_news=

    # select news from these tt_news sysfolders, default=all
    #newsPidList = 38

    # which news categories to show, default=all
    #newsCatList = 1,2,3,5

    # how many items are shown, default=all
    #newsItemCount = 2

    # SQL sorting by tt_news field name, default=no ordering
    #newsItemOrderBy = crdate DESC
  }
}

Modify this to your situation, save and view the page. This should be it. A reference of the possible TS params is available below.

Several parameters in the resulting user URLs of the newsticker page can be adjusted by the end user who wants to include your ticker in his web page.

These are:

• &style=[vertical | horizontal]
• &bgcolor=[HEX value without leading #]
• &speed=[int value (1-10)]
• &width=[int value in px]
• &height=[int value in px]

Inclusion on external pages is easy.

Add this snippet to your PHP-enabled page (.php):

<?php
        include(“http://link.generated.by.the.extension”);
?>

Configuration¶

This section refers to the possible TS parameters that can be used to configure this extension.

<a href=”tickerItemLinkPrefix<tt_news_item_id>” target=”_blank”><tt_news_cat>: <tt_news_header></a>

[crit1] [crit2] [crit3] ... [DESC] | [ASC]

newsItemOrderBy = crdate uid DESC

Known problems¶

None yet.

To-Do list¶

Come up with your ideas/concerns/feedback/whatever. I'm glad about any input I can get ;)

Changelog¶

• 0.0.1.: first public version, should work as intended
• 0.0.2.: fixed a minor bug: links in horizontal scroller make now use of the itemLinkPrefix

EXT: JS-Ticker newsfeed export - 4