News (Carousel) Web Part

Todd Chessum -

The News Web Part allows you to aggregate and display news and/or announcements in a variety of attractive, mobile friendly ways.

news-web-part.gif

This article has been broken up into the following sections:

If you're looking for a simple way to Crop and Resize images for use in the New web part, please take a look at our Cropping and Resizing News Images article. If you're uncertain as to what size your news images should be, go ahead and take a look at the What size should I make my News images? article.

Requirements and Activation

To get the most out of the News web part, you'll need to create and populate both a News List and a News Source list with a few sample news items. This process is explained in the sections below.

To activate the News web part on your site collection (this has most likely already been done) navigate to Site settings > Site collection features and choose to Activate the "Emgage | News Web Part."

Creating a News List

In order to display an item in the News web part, it must first be added to a News list. The following steps walk through creating a News list and adding news items.

  1. Navigate to Site Contents on the site you'd like to apply the News web part (Click the Settings Gear located in the SharePoint Ribbon and then click on Site Contents).

    site-contents.jpg

  2. Click on add an app.

    add-an-app.jpg

  3. Find and Select the Atera Prime | News List template. In the dialog box that appears input a Name for your news list (ex: Corporate News) and click the Create button. This will create the news list. Feel free to create more than one news list if you'd like (ex: HR News, Company Events, etc.). 

    news-list.jpg

  4. From Site Contents click the newly created news list to open the all items view and select Add new item.

    add-new-item.jpg

  5. Fill in the fields accordingly (see field descriptions below the image), then click the Save button.

    news-item.jpg

    Title:  Enter the title of your news item.

    Body:  Enter the details of your news item.

    Image:  Enter the URL of an image you would like display with your news item.

    Link Options:  Select whether you would like your news item to: Link to list item popup (opens SharePoint view item dialog), Link to supplied URL (links to the URL supplied in the Link filed), or Does not link.

    Link:  Enter the URL you would like the news item to link to (applied to the "Links to supplied URL" link option only).

    Open in new window:  Select this option if you would like news item link to open in a new browser window/tab (applied to the "Links to supplied URL" link option only).

    Expires:  Set an expiration date for the news item. The item will no longer display in the News web part after this date has past.

  6. Your news list will now contain the news items you just created. Go ahead and create at least two news items with unique images if you'd like to preview the news cycle options.

    news-items.jpg

Creating a News Source

The News Source list will be used to define which News Lists are available as sources for a given News web part instance. This allows for aggregation of news items from various lists within a single News web part. The following steps walk through creating a News Source list and the addition of News Lists as sources.

  1. Navigate to Site Contents on the site you'd like to apply the News web part (Click the Settings Gear located in the SharePoint Ribbon and then click on Site Contents).

    site-contents.jpg

  2. Click on add an app.

    add-an-app.jpg

  3. Find and Select the Atera Prime | News Source list template. In the dialog box that appears input a Name for your news source (ex: Main Page News Source) and click the Create button. This will create your news source list. Feel free to create more than one news source list if you'd like (ex: Side Bar News Source, All Departments News Source, etc.). 

    news-source-list.jpg

  4. From Site Contents click your newly created news source list to open the all items view and select Add new item.

    add-new-item.jpg

  5. Now fill in the fields accordingly (see field descriptions below the image), then click Save.


    news-source-item.jpg

    Title:  Enter the display title of your news source item. This will be displayed when selecting news sources while configuring the News web part.

    NewsType:  Select whether the new source is a SharePoint list or an RSS Feed. In this article we are using a SharePoint List.

    URL:  The URL of the News list or RSS feed from which news items will be sourced.

    SharePoint List

    For a SharePoint list, simply open a new browser tab, navigate to Site Contents and click on the desired news list, then copy the URL from your browsers URL bar after the all items view of the list opens.

    RSS Feed
    For an RSS feed, simple copy and past the RSS Feed URL into this field.

    MaxItemsToShow:  Select how many items from the news source you would like to have displayed.

  6. Your news source list will now contain the news source items you just created. Go ahead and add another news source if you have multiple News list created.

    news-source-items.jpg

Adding the News Web Part

Now that you have content created, you're ready to put the News wed part into use! The News web part can be added to a page using the following steps:

  1. Place the page you would like to add the News web part to in Edit mode by either selecting Edit from the SharePoint Ribbon, or Edit page from the Site Settings dropdown (pictured below).

    edit-page.jpg

  2. The page is now in Edit mode. To add the News web part to a web part zone click on Add a Web Part in the desired zone (pictured below). To add a News web part to a content zone, select the Insert tab in the SharePoint Ribbon and click the Web Part ribbon item.

    add-a-web-part.jpg

  3. The SharePoint Ribbon will expand to display two columns titled Categories and Parts. Under Categories select the Emgage folder and then choose News/Announcements from the Parts section. Now click the Add button or press the Enter key to add the web part.

    NOTE: If the Emgage category or News/Announcements web part is not available, please review the Post Install Configuration article to ensure Prime was installed and configured correctly.

    select-news-web-part.jpg

  4. Congratulations! You have successfully added the Emgage News Web Part. The News Web Part will display an error message as it has not yet been configured. Now it's time to configure the News Web Part and connect it to the content we created in the previous sections.

    news-web-part-added.jpg

Configuring the News Web Part

The News Web Part can be configured using the web parts tool pane as follows:

  1. Place the page you would like to configure the News web part on in Edit mode by either selecting Edit from the SharePoint Ribbon, or Edit page from the Site Settings dropdown (pictured below).

    edit-page.jpg

  2. Expand the web part menu and select Edit Web Part.

    edit-web-part.jpg
    Or by clicking on the desired News web part and selecting the Web Part Properties option from the Web Part tab in the SharePoint Ribbon.

    web-part-properties.jpg

  3. This will open the web part Tool Pane on the side of the page. Here you can configure the News web part to best meet your needs. There are four tabs which can be expanded and configured: News Web Part SettingsAppearance, Layout and Advanced. Our focus will be on the News Web Part Settings area (the other three sections contain general SharePoint settings you can adjust as desired).

    Important:
      The Height and Width options within the Appearance tab should be kept at the "No. Adjust height/width to fit zone" setting to maximize the responsive behavior of the web part.

    news-web-part-settings.jpg

    Source List:  Select the News source list (created in the Creating a News Source section) you'd like to use for this News web part instance. Only valid News Source lists will be displayed as options.

    Display Style:  Select the style you'd like the News web part to use when displaying news items. A brief description and sample of each style is shown below:

    Stacked
    Displays the Title and Body of multiple news items stacked below a single image area, which displays the Image associated with the currently highlighted news item. The highlight and image change at the specified cycle interval.

    news-stacked.jpg

    Image on Left
    Displays the Image, Text, and Body of multiple news items stacked, with the image aligned to the side of the text. Try this one with the Show Image option unchecked for displaying RSS feeds, or news items without images.

    news-image-on-left.jpg

    Image on Top
    Displays the Image, Title, and Body of one or more news items (dependent upon Items per page setting and web part zone width), and cycles through additional items by sliding them in from the side. This style is also know as a Carousel. Try this style with just the Show Image option selected.

    news-image-on-top.jpg

    Text Overlay
    Displays the Title and Body overlaid atop the news item Image. This one is my favorite! Note: The Emgage Webparts section of the Prime Stylizer provides options for controlling the overlay background and text colors for this style.

    news-text-overlay.jpg

    Items Per Page:  The number of news items to include per page. If the number of news items is greater than the items per page value, then pagination will be enabled.

    Cycle Preferences:  Controls whether the News web part cycles through only the items on the current page (Cycle page items), or through all items on all pages.

    Cycle Interval (seconds):
      The time interval at which the News web part cycles through items. We recommend somewhere between 3 - 7 seconds.

    Show Image, Show Title, Show Body:
      Use these options to fine tune how news items display by selecting whether or not the items Image, Title, or Body is shown. By default all options are selected/checked. Note that for certain Display Styles some option may not be editable.

    Body preview length (characters):
      Number of characters to that will be shown from the news items body field before the text in truncated. Use this option to control the length of body text displayed by the News web part.

    Refresh Interval:  Refresh interval for the web part cache. Default is 30 minutes (recommended).

  4. Configure the above options as desired, then click on OK to save changes. Note: You may need to save the page before you see the selected configuration options applied to  the News web part.

Administering the News Web Part 

The final step is to select which news source(s) should be displayed in the News web part. This is performed from the New web part instance as follows:

  1. Click the Admin gear located in the bottom corner of the News web part instance you would like to administer.

    news-admin-gear.jpg

  2. This will open the web parts admin panel, where you can select which source(s) you would like to have the News web part display items from.

    news-select-source.jpg

  3. Clicking once on a source selection checkmark will select that source for your user only. This allows users to subscribe to just the news items they find relevant.

    news-check-source.jpg

  4. Clicking again (twice) on the source selection checkmark will lock in that source for all users. Note that only members of the Prime News Manager group have the option the "check-lock" a new source. This group was created when the News web part  feature was activated and can be accessed by navigating to Site settings > People and groups, selecting Groups from the side nav, and paging through the available groups until you've found the Prime News Manager group. Click the group name to edit the groups membership.

    news-lock-source.jpg

  5. When the news sources have been configured to your liking, click the Done button to save.

    news-two-sources.jpg

  6. Congratulations! The News web part is now configured!

    news-web-part.gif 

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk