-
Notifications
You must be signed in to change notification settings - Fork 2
Home
The UCF-News-Plugin provides a standard set of tools for fetching and displaying news stories from UCF Today on a WordPress site. It comes with a widget and shortcode for displaying stories, and currently a single default layout. Additional layouts can be added via code in the functions.php file or could be bundled in an additional plugin for distribution.
Currently, the plugin does not have any plugin or javascript dependencies. Any dependencies for layouts should either be handled in the theme or bundled together with (or included by) a separate plugin.
Currently, the classic layout for the external-stories and ucf-statements shortcodes utilize classes from the Athena Framework and do not have default styles provided by the plugin. If using an Athena based WordPress theme, these layouts will have styles associated with the framework. If not using an Athena based theme, styles will need to be provided using the general classes assigned to each element in the layout.
To install the plugin:
- Upload the (unzipped) [plugin project] to the
/wp-content/plugins/directory. - Activate the plugin through the "Plugins" screen in the admin screen of your site.
- Configure the plugin in the "UCF News Settings" page found at
Settings > UCF Newsin the admin screen.
UCF News Feed URL: The base URL of the UCF News JSON feed.
Include CSS: When checked, the ucf-news.min.css file included with the plugin will be included on pages using the widget or shortcode.
Fallback Image: The classic layout includes an image next to each story. If an image is not available from the feed, this fallback image will be used. If no image is provided, the image tag will not be output, which could potentially result in some awkward layouts.
There is currently one provided layout that comes with the plugin, labeled "Classic Layout". This layout is used by default when using the shortcode or widget. This layout should closely match the current layout for news items on www.ucf.edu. For more information on adding layouts, see the layout development page.