News-Blog Group Items Listing Content Managed Webpage Area Login

Contents

  1. Prerequisites
  2. Area Overview
  3. Area Formats
  4. Area Settings
  5. Dependent Configurations
  6. Recommendations

This document describes how a News/Blog Group Items Listing area works when being displayed on a content managed web page within the TOTECS platform. This area is used to display a list of news/blog items that are assigned to a news/blog group, this allows users to be informed of a number of news items or blog posts that is occurring on the website.

Prerequisites

Please ensure that you have read and understand the following topic links before reading on.

Area Overview

News/Blog Group Items Listing area allows guests and/or logged in users view a content managed web site to have the ability to view a list of news items or blog posts. From this listing the users then can have the ability to click on links to view a single news/blog item in more detail.

The news/blog items that are displayed in the area are based on news/blog group that the items are assigned to. The area can be configured so that a news/blog group is assigned to the area, this ensures that only the items of the assigned group always display in the area. The area can also be configured so that it can load items of any news/blog group that has had its ID passed within the URL. This allows other web pages to set links that will determine the items that display in the area when the web page is loaded.

This area provides a way for users to find out articles of information that administrators of the TOTECS project deem relevant.

Area Formats

The area contains the following formats:

News/Blogs Group Listing Header

The format displays once within the area above the list of news/blog items. This format has hooks that allow details of the news/blog group to be displayed, as well as hooks that allow users to paginate through the news/blog items assigned to the news/blog group.

News/Blog Item Record

This format can display zero-to-many times, based on the number of news/blog items that are assigned to the news/blog group, and limited by the setting in the area that sets the total number of records that are allowed to be listed. Each news/blog item record format has hooks that allow the details of the news/blog item to display, and information about the user who created the news/blog item.

News/Blogs Group Listing Footer

The format displays once within the area below the list of news/blog items. This format has hooks that allow details of the news/blog group to be displayed, as well as hooks that allow users to paginate through the news/blog items assigned to the news/blog group.

Layout of Formats:

News/Blogs Group Listing Header Format
News/Blog Item Format
News/Blog Item Format
News/Blog Item Format
News/Blogs Group Listing Footer Format

Area Settings

Below are the following settings that can be configured through the area's editor when modifying the area in the Web Page Editor, within the Administration Centre.

Setting Label Description
News/Blog Group: Set the News/Blog Group that will have its items display in the area. Set the option "Allow Any News/Blog Group To Display Items" to allow the area to load items for any news/blog group that has been passed in the web page's URL. If this setting is selected then the area will not display any items by default until the news/blog group ID is in the URL.
News/Blog Items Webpage Link: Set the content managed web page that the "more" link will link to from within the News/Blog Item format. Use this to set the web page that gets called when the user wishes to view more details of the news/blog item.
Number of News/Blog Items To List: Set the maximum number of news/blog item records that can be listed in the area. Leave this setting empty to allow the entire list of news/blog items associated with the news/blog group to display in the area.
Date Format:

The setting customises how news/blog item dates are formatted in the News/Blog Item format.
This setting accepts a string of characters according to the Java date string format, details at 
http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html
For example if the setting is set to YYYY-MMM-dd that will output "2015-Mar-24", where as dd/MM/YY would output "24/03/15".

Dependent Configurations

In order for the the area to display news/blog item data the following configurations are required to be set up:

  • For news/blog items to appear in the area, the items must be assigned to a news/blog group that has its setting "Displayed In" set to either "Trade interface and Content Managed Websites", or "Content Managed Website". This setting is available within the News/Blogs interface under the Marketing menu in the Administration Centre.
  • For news/blog items to appear in the area, the items need be assigned to a news/blog group that has its setting "Users View News/Blog Items" set to "All Users". If this setting is set to "Users With Assigned Accounts", the users will be only able to view the items if their account is explicitly assigneds to the news/blog group This setting is available within the News/Blogs interface under the Marketing menu in the Administration Centre, as well as the ability to assign customer accounts to news/blog groups.

Recommendations

  • Link this area with the News Group Forum area to create forum functionality, where users can click on a forum (news/group category), then use this area to view all the posts (news/blog items) of the selected forum.
  • We recommend setting the limit of the amount of news/blog items that appear in the area, to reduce the length of the web page that the area is displayed on. With the use of the paginator hooks in the header and footer formats it still allows users to view the entire list of items associated with a news/blog group by clicking through the next/previous page links.