Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/weggetor/BBNews

The bitboxx bbnews module is a DNN module for collecting and providing news on your portal. It is able to collect news from a RSS/Atom feeds or from twitter. Alternatively you can write your own news. News display is full templated and could be provided as RSS feed too. The minimum DNN Version for this module is 06.01.00 !
https://github.com/weggetor/BBNews

atom-feed dnn dnncms news rss-feed twitter-feed

Last synced: about 1 month ago
JSON representation

The bitboxx bbnews module is a DNN module for collecting and providing news on your portal. It is able to collect news from a RSS/Atom feeds or from twitter. Alternatively you can write your own news. News display is full templated and could be provided as RSS feed too. The minimum DNN Version for this module is 06.01.00 !

Awesome Lists containing this project

README 

        
## Project Description



![BBNews_128](Documentation/BBNews_128_3.png "BBNews_128") The _bitboxx bbnews_ module is a DNN module for collecting and providing news on your portal. It is able to collect news from a RSS/Atom feeds or from twitter. Alternatively you can write your own news. News display is full templated and could be provided as RSS feed too. The minimum DNN Version for this module is **06.01.00** !



* * *



## Whats new ?

_Version 01.02.00 (15.10.2016):_



*   Compatibility for DNN 8+

*   Fixed some issues when retrieving Feeds

*   Added MetaData field to support XML Data in special News Field



_Version 01.01.05 (25.03.2014):_



*   Fixed a bug replacing only first url in twitter feed with a link in the news

*   Fixed a bug attaching complete html code after rss code

*   Fixed a bug when feeditem.pubdate is empty or not present



_Version 01.01.04 (20.01.2014):_



*   Twitter feeds are working again now. To get this running you need some app credentials. Create a new app on [https://dev.twitter.com/apps](https://dev.twitter.com/apps) and get your consumer and access keys and tokens. Enter these in the “Manage BBNews”-Twitter Tab.

*   Fixed some errors in the UI (DNN Form Pattern)

*   Fixed a bug not showing the correct favicon

*   Fixed an error which occured while retrieving some RSS feeds (e.g. blogs-feed on dotnetnuke.com).

*   Fixed an error with ambiguous NewsId when opening "Manage BBNews".

*   RSS icon has wrong path if DNN is installed in subdirectory

*   Added some error tolerance to parsing of RSS feeds

*   Added default values for settings "NewsInRow" and "RowsPerPage" to avoid error message if these are not set.  



* * *



## Installation



Install the module like every DNN module as a host account in System – Extensions or directly from the DNN Forge. After installation place a _bitboxx bbnews_ module on the page where you want to show the news entries.



* * *



## Module Settings



![image](Documentation/image_39.png "image")



In the module settings you have 3 main options for the display:



*   The first is “Table”. That means that the news will be displayed in a tabular way. You can define how many news per row and how many rows should be displayed. (If you choose 3 news per row and 5 rows, 15 news would be shown if present). If you have more news, paging would be enabled automatically. To prevent paging, enter a number in “News Count”.

*   The second Option is “Marquee”. If you choose this option, your news are scrolling through your module with speed and direction how defined in the settings.

*   Last possible option is “Detail”. This option is for displaying only one news with its full text. A module of this type should be placed on an extra “News” page which is not included in menu. Another news module on another page with setting “Page for own news” pointing to this page shows then a list of your own news with summary text. Clicking on the link brings you to the page with the detailed news text.



The settings in detail:



View

Select the style of your news display - as marquee text or as tabular templated display. Select "Detail" only if on "Page for own News"



Category

If you choose a category, only news from this category are shown.



News Count

Show only the N newest News in display. Leave empty or set zero for no limiting. You need this to suppress possible paging



Start Date

Show only news newer then (Date)



End Date

Show only news older then (Date)



Show RSS icon

Select if/how you want to display a RSS icon in the module title



Page for own news

Select a page with a _bitboxx bbnews_ module in detail-view to show own news



News per row

Enter the amount of News you want to see in one row



Rows per page

Enter the amount of rows with news per page



Select Template

Select a display template from the list or create a new one



Marquee Direction

Scroll direction for the marquee-text. "Direction = Left" scrolls from right to left(Left, Right,Up,Down)



Marquee Scroll Amount

Amount of pixels between 2 scroll states (Default:6)



Marquee Scroll Delay

Time in milliseconds between 2 scroll states (Default:85)



Marquee Alternate

Check if you want to have the text scrolled between left/right or top/bottom



* * *



## Templates



_bitboxx bbnews_ module contains the new template editor. You can select from a predefined list of templates which are shown as thumbnail. If you select “New” or “Edit”, display changes and you can edit the template text or create a new one. To support multilanguage websites, the same mimic as the resource files is used. There is one neutral template (“Shortnews.htm”). This one could only be edited by the host. If a non-host user is logged in, he can only edit the portal-specific template “Shortnews.Portal-0.htm”. If he wants to have a special template for german language, he edits the ”Shortnews.de-DE.Portals-0.htm”. When the news is shown, _bitboxx bbnews_ module looks for special portal and language versions. If none is found, the default is chosen.



## ![image](Documentation/image_40.png "image")   ![image](Documentation/image_31.png "image")



the template editor contains a list of all special bbnews tokens:



![image](Documentation/image_41.png "image")



* * *



## Manage BBNews



In the BBNews Administration you can manage your feeds and news and how the are collected:



![image](Documentation/image_8.png "image")



Categories

Categories build a collection of feeds. You can have multiple feeds in one category and assign this category to a specific _bitboxx bbnews_ module . The news of all feeds in the selected category will be shown in this module.



Feeds

Feeds are the source for your news. You can have different types of feeds. The feed type None means that you manually write the news. Furthermore, you can still choose between a RSS / Atom feed, the Twitter timeline and the search for a keyword in Twitter.



CategoryFeeds

After selecting a category you are able to choose one or more from the list of your defined feeds which should belong to the this category. You can select the same feed in multiple categories!



News

Search news, edit saved news and / or create new news. You can hide any news from display without deleting them!



Scheduler

The DNN scheduler checks in the defined interval your feed table for feeds that should be refreshed. You can disable the scheduler (no new news will arrive) or edit the interval.



* * *



## Categories



Categories build a collection of feeds. You can have multiple feeds in one category and assign this category to a specific _bitboxx bbnews_ module . The news of all feeds in the selected category will be shown in this module.



![image](Documentation/image_11.png "image")



Category Name

Enter / edit the name of your category



Description

Enter a description for your category (will be used if category is used as outgoing RSS feed)



* * *



## Feeds



Feeds are the source for your news. You can have different types of feeds. The feed type None means that you manually write the news. Furthermore, you can still choose between a RSS / Atom feed, the Twitter timeline and the search for a keyword in Twitter.



![image](Documentation/image_16.png "image")



Feed Name

Please enter an decriptional name for your feed



Feed Type

Please select the type of your feed. If you want to create your own news select "none". If you want to collect news from an RSS/Atom feed or from twitter, select the corresponding entries



Feed Url

Please enter the feed Url (RSS/Atom-Feed) or the search term (twitter search). If "None" leave this empty.



Retrieve interval

Select the Interval you wish to collect information from the feed (in seconds). Zero collects feed on every hit



Try interval

Select the Interval when the application tries again to collect the feed after an unsuccessful try (in seconds) . Zero collects feed on every hit



Reorg interval

Enter the number of days passing before automatic delete. If zero, news are never deleted



Active

Enable / disable collection of news



Last retrieve

Date / time of last check



Last try

Date / time of last retry after collection fails



* * *



## CategoryFeeds



After selecting a category you are able to choose one or more from the list of your defined feeds which should belong to the this category. You can select the same feed in multiple categories!



![image](Documentation/image_21.png "image")



Category

Select a category first to select the corresponding feeds



Feeds

Select which feeds should be shown in the selected category



* * *



## News



Searching news, edit saved news and / or create new news. You can hide any news from display without deleting them! You can search a special news by Text, by Category and by publishing date:



![image](Documentation/image_42.png "image")



Editing a news or creating a new one brings you to the following options:



Hide

Check if you dont want to show this news.



Internal news

Check if you want to display the news on your own website.



Feed

Select the feed this news belongs to.



Title

Enter the news headline.



Publish Date

Date the news is published



Author

Name, Profile,Email + nick of author



Link

Source-URL of news. Leave blank if internal news.



Image

Enter the link to the news Image.



Summary

Enter the summary text of your news.



News

Enter the complete news (use this for internal news)



* * *



## Scheduler



The DNN scheduler checks in the defined interval your feed table for feeds that should be refreshed. You can disable the scheduler (no new news will arrive) or edit the interval



![image](Documentation/image_26.png "image")



Friendly Name

Enter a name for the scheduled job.



Schedule Enabled

Check to enable the schedule. A disabled schedule will  collect NO news from ANY Feed



Time Lapse

Example: "5" and select "Minutes" to run task every 5 minutes. Leave blank to disable timer for this task.



Retry Frequency

Example: "5" and select "Minutes" to retry the task every 5 minutes after a failure. Leave blank to disable retry-timer for this task.



Retain Schedule History

Example: Select "10" to keep the ten most recent schedule history rows.



## MetaData



New in version 01.02.00 for DNN8+ : The news table has a new MetaData field that is NOT filled by the RSS collector. But it can be used by other developers to fill in some xml:

```xml



   

        Article

        Lorem ipsum dolor..

    

    

        BackLink

        http://www.auktionsbuddy.de

    

    ...



```



These values can then used as placeholder tokens in the template:

[BBNEWS:Meta|Article] or [BBNEWS:Meta|Backlink]