Collection Spotlight#
Use a Catalog Widget to recommend a long list of titles in a blog post or on a web page.
Note about lists in Aspen#
Lists in Aspen have three options:
- Private: Can be seen only by the user that created it within their My Account page.
- Public: Can be shared via URL but otherwise will be same as Private; e.g., https://catalog.library.nashville.org/MyAccount/MyList/63302
- Show in Search Results: This option is only available if the list is marked 'Public' and the user has an elevated permissions.
'Show in search results' lists, aka searchable lists, will appear in the scoped collection 'Lists':
- They are what you search when you choose 'in Lists.' Searchable lists will also appear in the Explore More widget.
- Finally, searchable lists will appear in the 'Appears on list' field of a record:
Create Catalog Spotlight in Library Catalog (Using a List)#
-
Create a list. If you already have a list, skip this step.
-
Go to the lists page:
-
Click the user icon in the upper right.
-
Select “lists” from the menu.
-
On the list page, click the Edit button.
-
On the edit screen, mark the list public. Your list must be public to create a catalog spotlight.
-
Once your list is marked public, you have the option to include or exclude the list from search results. Select yes or no, then click Update to save your changes.
-
After saving your changes, you’ll see “create spotlight” at the top of your list. Click “create spotlight.”
-
You’ll be asked to give your spotlight a name. We recommend naming the spotlight the same as your list so the spotlight and list titles match. IMPORTANT! Your spotlight title must have less than 50 characters.
-
On the next page, we need to customize the widget. Click Edit.
-
Fill out the following fields:
-
Name: If you need to edit the spotlight name, do it here. The name must be less than 50 characters.
-
Description: Add a note about where the spotlight is used. If you’re adding to a blog post, type something like “spotlight for newbery winners blog post 2015.”
-
Number of Titles: Default is 25, which is generally a good number. You can make this smaller if you like.
-
Uncheck the next three boxes. We do not want to show the title, author, or ratings for titles.
-
Style When Displaying List Featured Titles: Choose Horizontal Carousel.
-
Cover Size to Use: Choose Medium.
-
Custom CSS File: Copy this URL into field.
https://assets.library.nashville.org/css/aspen-widgets-update-view-all.css
-
Cover Size to Use: Medium
-
For the next two boxes: Uncheck “show the display's title bar.” But DO check “show the view more link.”
-
Display Mode for Search Results: Choose Covers.
-
Click Save Changes and Return.
-
Scroll down until you can see the “Collection Spotlight with Resizing” code. Copy ONLY the iFrame URL -- this is the URL in the blue box above the iFrame code. You do NOT need the entire iFrame code snippet. You only need the URL, like the example highlighted below.
Create Catalog Spotlight in Library Catalog (Using a Search)#
-
Do a search.
-
If you do a search AND you’re logged in to your account, Create Spotlight will be at the bottom of the screen, just above the footer.
-
Click “create spotlight.”
-
You’ll be asked to give your spotlight a name. We recommend naming the spotlight the same as your list so the spotlight and list titles match.
-
On the next page, we need to customize the spotlight. Click Edit.
-
Fill out the following fields:
-
Name: Give your spotlight a name.
-
Description: For description, specify who created the list it’s based on, and when it was created, and where this spotlight will be used (home page, Books Movies Music). For example: List created by Jane Librarian, for Blog post on library website: The Twelve Days of YA Reading, Dec 2020.
-
-
Number of Titles: Default is 25, which is generally a good number. You can make this smaller if you like.
-
Uncheck the next three boxes. We do not want to show the title, author, or ratings for titles.
-
Style When Displaying the Featured Titles: Choose Horizontal Carousel.
-
Cover Size to Use: Choose Medium.
-
Custom CSS File: Copy this URL into field.
https://assets.library.nashville.org/css/aspen-widgets-update-view-all.css
-
Cover Size to Use: Medium
-
For the next two boxes: Uncheck “show the display's title bar.” But DO check “show the view more link.”
-
Display Mode for Search Results: Choose Covers.
-
Click Save Changes and Return.
-
Scroll down until you can see the “Collection Spotlight with Resizing” code. Copy ONLY the iFrame URL -- this is the URL in the blue box above the iFrame code. You do NOT need the entire iFrame code snippet. You only need the URL, like the example highlighted below.
Add the Collection Spotlight to the Website#
-
Add the Catalog Widget component to your post.
-
Fill out the form:
- Title and iFrame Title: The type title for your widget that will display to the user.
- iFrame URL: Paste the iFrame URL from the spotlight code in catalog. Add
&myLang=es
at the end of the URL. It should look something like this:
https://catalog.library.nashville.org/API/SearchAPI?method=getListWidget&id=99&resizeIframe=on&myLang=en
- iFrame Title: Use the same title in both the Title and iFrame Title fields.
-
Review and verify that the everything looks correct. If anything looks weird, check your spotlight settings in catalog (where you set up the spotlight).
Find the List or Saved Search that Populates a Widget#
- Go to https://catalog.library.nashville.org.
- Log in using the List Admin account.
- Select Pika Configuration.
- Select List Widgets.
- Search for the list that appears on the BMM page.
- Click in the empty text box under Description.
- Paste in one of these searches (see above) and search:
- children's books movies music page
- teen books movies music page
- adult books movies music page
- Note the List Title and List ID or Saved Search ID.
- You’ll need the List Title if you want to add titles to the list.
- You'll need the List ID or the Saved Search ID to easily find the list and remove items.
Remove Titles from a Widget List#
- Go to https://catalog.library.nashville.org.
- Log in using the List Admin account. If you do not know the List Admin account number, contact Shared Systems.
- Copy this URL into your browser and replace insert-list-id with the List ID number you pulled from the widget description:
https://catalog.library.nashville.org/MyAccount/MyList/
insert-list-id. You can also go to My Lists and look for the list by name. - Select Edit.
- Remove titles by clicking Delete on the far right of each item block.
Add Titles to a Widget List#
- Go to https://catalog.library.nashville.org.
- Log in using the List Admin account. If you do not know the List Admin account number, contact Shared Systems.
- Search for a title.
- When you locate the title, click the Add to List button.
- Select the list from the drop down menu.
- Save.
Update a Widget Based on a Saved Search#
- Go to https://catalog.library.nashville.org.
- Log in using the List Admin account. If you do not know the List Admin account number, contact Shared Systems.
- Search for a topic and apply filters.
- Enter.
- If the search looks good and is returning the type of titles you expect, click Save Search at the bottom of the screen.
- In the left menu, select My Account > Search History.
- Copy the search ID for the search you just saved (it will be at the top).
- Select Pika Configuration.
- Select Catalog Spotlights.
- Find the widget you need to update and select Edit.
- In the Source field at the bottom of the widget, replace the search ID with the new number. It should say source:xxxxxx where x is the new number.
- Save changes.
- Go to the BMM page where the widget lives and make sure the changes took effect as expected.
Update 5-Tab Widget on the Homepage#
- Create your new list in Pika with lists account.
- Locate the existing 5-tab widget:
- Go to https://catalog.library.nashville.org.
- Log in with lists account
- Click on Pika Configuration
- Select Catalog Spotlights
- Find “Drupal Home Page - 5 Format Catalog Widget”
- Edit the existing Drupal Home Page - 5 Format Catalog Widget.
- Swap out one of the old lists for the new lists by updating the list number.
- There is no need to edit anything on Drupal. Your list should automatically update on Drupal.
- Double check the homepage to verify the widget updated correctly.