Add a plugin description

UCF Resource Search Plugin

Provides a custom post type, shortcode, functions, and default styles for displaying a resource search input and list of resources.

Description

The resource search and links are added to pages using a ucf-resource-search shortcode.

The ucf-resource-search shortcode has several options:

Classic Layout

column_width - col-md-4 col-sm-4
column_count - 3
default_sorting - term
layout - classic or card
meta_key
meta_value
non_alpha_section_name - Other
order_by - title
order - ASC, DESC
post_type_name - post, page, etc
show_empty_sections - true|false
show_sorting - true|false
show_sorting - true|false
show_uncategorized - true|false
uncategorized_term_name - Uncategorized
taxonomy - category

Card Layout

layout - classic or card
order_by - title
order - ASC, DESC
post_type_name - post, page, etc
resource_link_type_filter - filter results by resource_link_type
taxonomy - category

Installation

Manual Installation

Upload the plugin files (unzipped) to the /wp-content/plugins directory, or install the plugin through the WordPress plugins screen directly.
Activate the plugin through the "Plugins" screen in WordPress
Configure plugin settings from the WordPress admin under "Settings > UCF Resource Search".

WP CLI Installation

$ wp plugin install --activate https://github.com/UCF/UCF-Resource-Search-Plugin/archive/master.zip. See WP-CLI Docs for more command options.
Configure plugin settings from the WordPress admin under "Settings > UCF Resource Search".

Dependencies

Athena-Framework or Bootstrap 4
FontAwesome (if using the card layout)

Changelog

1.0.9

Enhancements:

Added composer file.

1.0.8

Enhancements:

Update packages and gulpfile in #35
Updated social links in the card layout to use differentiating sr-only text in #36
Added a card_layout_title_element shortcode attribute in #36
Adjusted default underline styles for the resource-links in #36

1.0.7

Moved resource search initialization JS to the document footer
Fixed enqueuing of ucf-resource_search_js to declare jQuery as a dependency
Fixed some missing variables and CSS class names and values

1.0.6

Added late JS enqueuing
Added plugin version cache-busting to enqueued assets
Updated constants for consistency with other plugins
Prepended plugin dir to required files in main plugin file
Added Github issue/PR templates and contributing doc; updated gitignore
Upgraded packages + re-ran gulp

1.0.5

Added setting to exclude the social media fields from the admin.

1.0.4

Added card layout option for ucf-resource-search shortcode
Added fields for social links

1.0.3

Updated plugin description

1.0.2

Fixed PHP notices
Removed Athena classes
Fixed search

1.0.0

Initial release

Upgrade Notice

n/a

Installation Requirements

None

Development & Contributing

NOTE: this plugin's readme.md file is automatically generated. Please only make modifications to the readme.txt file, and make sure the gulp readme command has been run before committing readme changes.

	ob_start();
	?>
	<script type="text/javascript">
	if (typeof jQuery !== 'undefined') {
	jQuery(document).ready(function ($) {
	PostTypeSearchDataManager.register(new PostTypeSearchData(
	<?php echo json_encode( $args['column_count'] ); ?>,
	<?php echo json_encode( $args['column_width'] ); ?>,
	<?php echo json_encode( $items ); ?>
	));
	});
	} else {
	console.log('jQuery dependency failed to load');
	}
	</script>
	<?php
	$script = ob_get_clean();

	public static function enqueue_styles() {
	if ( get_option( 'ucf_resource_search_include_css' ) ) {
	wp_enqueue_style( 'ucf_resource_search_css', plugins_url( 'static/css/ucf-resource-search.min.css', UCF_Resource_Search__PLUGIN_FILE ), false, false, 'all' );
	}
	}

ucf / ucf-resource-search-plugin Goto Github PK

ucf-resource-search-plugin's Introduction