README

Elgg plugin for posting news and announcements by administrators, group owners or news staff.

Features

This plugin offers administrators the following options:

Post news items
Add other Elgg entities as news items
Customizable news list view
Option to determine more users who can post news/announcements
Option to allow post news/announcements on groups, only by group owners
Option to change the default news icon in settings
Option to allow or not staff news to set/unset news as featured
Option to display featured news on sidebar

As an example of "adding other Elgg entities as news items", if there is blog post by any user, administrator can add this as news post. So it will be displayed in list of news but if users click on this item, will redirected to original blog post. The same action could apply to any post like pages, bookmarks, videos etc.

Also administrator can allow to group owners for posting new/announcements inside the group only.

Summarizing permissions, the following options are available:

Who can post site news

Administrators
News Staff

Who can set/unset site news as featured

Administrators
News Staff (if enabled in settings)

Who can post group news (if enabled in settings)

Administrators
Group owner/managers

Who can set/unset group news as featured (if enabled in settings)

Administrators
Group owner/managers

How to use a customizable news list view

If need to have a different view for listing news, e.g. in a custom front page, you could use the following code:

echo elgg_view('elgg-news/custom_list_view', [
    'entities' => $entities,    // list of news entities, previously retrieved
    'read_more' => true,        // set true if want to add a "Read more" link for each news item
    'item_class' => '',         // set a custom class on news items, so it could be customized through CSS
    'photo_size' => 'custom',   // set the size of the news photo, see more details below
    'photo_cover' => false,     // set true if want to use the news as cover image, otherwise it will be displayed inline with title and intro
    'photo_class' => '',        // set a custom class on news photo
]);

You can see an example about how to use this view at elgg-news/views/default/resources/elgg-news/custom_list_view.php. This sample view will be accessible at http://www.YOURCOMMUNITYURL.com/news/custom_list.

Especially about photo sizes, you can use any of the predefined photo size, which are:

elgg_set_config('elggnews_photo_sizes', [
    'topbar' => ['w' => 16, 'h' => 16, 'square' => true, 'upscale' => false],
    'tiny' => ['w' => 25, 'h' => 25, 'square' => true, 'upscale' => false],
    'small' => ['w' => 40, 'h' => 40, 'square' => true, 'upscale' => false],
    'medium' => ['w' => 100, 'h' => 100, 'square' => true, 'upscale' => false],
    'large' => ['w' => 200, 'h' => 200, 'square' => true, 'upscale' => false],
    'master' => ['w' => 2048, 'h' => 2048, 'square' => false, 'upscale' => false],
]);

Or you can set a custom photo size (width and height) in plugin settings, so for each photo upload on news item, it will be saved in this size too.

How to change the default icon

Site administrators can select the icons to use for default news icon in plugin settings.

If need to add a custom icon, just uploaded it to folders mod/elgg-news/graphics/icons for default news icon. All file uploads will be available for selection in plugin settings.

nlybe / elgg-news

Maintainers

Details