Add to the API Call's URLCustomize the CSSExpandable/Collapsible Subject MenuAdd Stripes to Rows
This is the "API Examples" page of the "Widgets & API Utility in LibGuides & LibGuides CMS (v1)" guide.
Alternate Page for Screenreader Users
Skip to Page Navigation
Skip to Page Content

Widgets & API Utility in LibGuides & LibGuides CMS (v1)  

Learn more about widgets and API calls available in LibGuides & LibGuides CMS.
Last Updated: Mar 21, 2015 URL: http://help.springshare.com/guidewidgets Print Guide RSS UpdatesEmail Alerts

API Examples Print Page
  Search: 
 
 

Lists of Guides

The "lists of guides/pages" API has the most options to choose from:

  • Get lists of guides or pages containing a particular term
  • Get lists of guides assigned to a particular subject category
  • Get lists of guides that have a specific tag
  • Get lists of guides in a particular group (LibGuides CMS only)

If you leave the text box in this section blank, it will return all guides in your system - so if you'd like a list of all guides, just choose "return guides that contain this term" and leave the text box blank. The same goes for a list of all subjects.

Once you get past that option, there are a few others to choose from:

  • Number of results (leave blank to show all)
  • Not showing all results? Show/hide the "More Results" link.
  • Window Target: whether to have links open in a new window or the same window
  • Display Order
  • Whether or not to include the guide description
    (doesn't apply if using the drop down menu option)
  • Display format - list, bulleted list, or drop down menu
  • API Request format

List of Guides Example

List of guides assigned to the "Best Practices" subject category.

 

Lists of Subjects or Users

Lists of Subjects Options

  • Whether or not to include subjects with no published guides
  • Whether or not to include associated guides with each subject
  • Display format
  • API Request format

Lists of Users Options

  • Whether or not to include users with no published guides
  • Whether or not to include associated guides for each user
  • Display format
  • API Request format

List of Subjects Example

List of subjects with guide titles/links in a drop down menu.

List of Users Example

List of users with published guides in an unformatted list.

 

User Profile Box & Content Box Options

User Profile Box Options

  • Choose the user you want to display
  • Choose your API output format
  • Copy the code & you're good to go!
     

Content Box Options

  • Choose the guide that has the content box you want to display
  • When the box list comes up, select the box you want to display
  • Choose your API output format
  • Copy the code & you're good to go!

For both options, the boxes display using the API's CSS file, rather than using any CSS you may have defined for your system in the Look & Feel settings. You'll need to modify the API's CSS in order for the box to look like it does on your site. See the Customize the API CSS page for more information.

 

Search Box

Once you choose "Search box", there are no other options to choose from except the API Request Format.

There are, however, some options you can add to the script URL to make some changes to it!

Remove LibGuides icon &icon=off
Set the size of the text box &size=50 Change 50 to whatever size you want.
Results open in same window &target=_self
Change Search button text &btntext=Search+Guides Change Search+Guides to whatever you want.
Be sure to add + between each word, not spaces.

Search Box Example

Search box with icon turned off & search button text modified.

Here's the code I used with the additions in blue:

<div id='api_searchbox_iid432'></div><script type='text/javascript' src='http://api.libguides.com/api_searchbox.php?iid=432&context=object&format=js&icon=off&btntext=Search+Help+Guides'> </script>

 

Tag Cloud

  • Number of tags to display (leave blank to display all tags)
  • Tag Font Size: the more guides that use a tag, the larger the tag will appear in the tag cloud. These options allow you to set the size of the most popular and least popular tags - and everything in between.

    If these boxes are left empty, all tags will be equal in size.

    • Min size: the smallest the tags can get (tags used least often)
    • Max size: the largest the tags can get (tags used most often)
  • Display Format: cloud, list with no bullets, bulleted list
  • Window Target: Whether to have links open in a new window or the same window
  • API Request Format

Tag Cloud Example

Tag cloud showing all tags, with max size 300% and min size 100%.

Description

Loading  Loading...

Tip