edshelf Widget

Description

edshelf helps you find the most effective educational tools for your specific needs. You can also create shelves of tools you like, or browse shelves created by others.

This plugin provides a shortcode so you can easily embed an edshelf widget onto your site.

The shortcode is: [edshelf-shelf-widget id="NNNN" height="YYY" format="FFFF"]

The template tag is: edshelf_shelf_widget( NNNN, YYYY, 'FFFF' );

Where NNNN is the ID of the shelf you want to embed, YYY is the height of the widget in pixels, and FFFF is the format of widget. You can get this ID from the shelf on edshelf, in the Widget module at the bottom of the right column. The choices for the format of widget are “grid” (the default setting), “list”, or “compact”.

Installation

  1. Download and unzip the plugin file.
  2. Upload the edshelf-widgets folder into your /wp-content/plugins/ directory.
  3. Go to the Plugins section of your WordPress admin and activate the “edshelf Widgets” plugin.
  4. Go to edshelf and view a collection you want to embed.
  5. Look for the Widget module at the bottom of the right column. In that module will be some code.
  6. Look for a 5 or 6-digit number in that code. That number is the ID number of the shelf.
  7. Go to the blog post or page on which you want to embed this shelf widget.
  8. Type in the following WordPress shortcode in the text editor: [edshelf-shelf-widget id="NNNN" height="YYY" format="FFFF"].
  9. The settings are: NNNN is the shelf ID you just found. YYY is the height of the widget in pixels. FFFF is the format of widget, where your choices are “grid” (the default setting), “list”, or “compact”.
  10. Or use the template tag edshelf_shelf_widget( $id, $height, '$format' ); if you are familiar with PHP.
  11. And you’re done!

FAQ

Do I need to use this plugin to embed an edshelf widget?

If you want to embed this widget within a blog post, then yes. The WordPress text editor strips out JavaScript by default. Since the edshelf widget’s embed code uses JavaScript, simply copying and pasting the embed code seen on edshelf will not work.

This widget gives you the next best thing: a shortcode for your blog posts and pages that will automatically embed the edshelf widget for you.

If you know PHP, a template tag is also available.

I only see one widget. Is that it?

Yes, edshelf only has one widget so far. More will be coming. Stay tuned!

How tall can I make the widget?

As tall as you want!

How can I set the width of the widget?

We don’t offer that option yet, but the widget will automatically stretch to 100% of whatever space you put it in – so if you know HTML and CSS, you can just set the width of the parent container holding this widget.

Can I embed more than one widget to a page?

Yes! Embed as many as you would like.

Is this widget available in other languages?

Sorry, not yet. We do intend to offer multiple language support in the future though.

Where can I go for more help?

If you need additional assistance, email us at support@edshelf.com.

Contributors & Developers

“edshelf Widget” is open source software. The following people have contributed to this plugin.

Contributors

Changelog

1.2

  • Added backwards compatibility with previous shortcode, [edshelf-collection-widget]

1.1

  • Added image assets.

1.0

  • Updated code to reflect the new naming scheme (“shelves” instead of “collections”) and architecture of the edshelf site. Changed settings and controls accordingly.

0.2.2

  • Replaced the parameter and term “type” with “format” for future compatibility of upcoming features.

0.2.1

  • Added support for widget types, such as full, list, and compact.