Skip to Main Content

LibGuides Best Practices

Internal UCI Libraries resource guide to promote best practices in guides.

Email this link:

Social media

Social media links can be difficult to update as both link assets and in-line hyperlinks in Rich Text.

It is generally recommend to avoid links to social media (i.e., a Twitter/X thread on a research topic) and to find a more stable resource for that information.

The exception would be social media datasets used for research. For examples, visit: Social Media Data.

Adding content to a guide

Content can be added to boxes with the Add / Reorder drop down menu at the bottom of a box.Screenshot of the content types under the Add / Reorder button of a LibGuides box.

To check what the guide would look to users, you can click the "eye" icon in the top right of the page.A screenshot of the preview (eye) button.

All content types except Rich Text / HTML are added to the box as an asset. You can view your assets by going to: Contents > Assets > Filter by your name in the Owner field.

Once you have created content in a box, you can edit it by selecting the small paper and pen edit icon near the content. For assets like databases and links, the edit icon will be directly next to the title of the asset. For Rich Text / HTML, the edit icon will be in the corner of the section with your text.

Rich Text / HTML

The most commonly used content type is Rich Text / HTML - where you can add text and images. Selecting to Add this content will bring up a rich text editor with formatting options, similar to a document editor like Word.

Rich Text tips

  • You can add Headings under Format. The heading level starts at Heading 3--this is because Heading 2 is the box name and Heading 1 is the page name. Learn why integrating headings is important on LibGuides Accessibility: Heading Levels & Logical Order.
  • The only way to add images to a guide is through the image icon in the formatting ribbon. Selecting this will open the Image Manager. Find more information on the Image Manager in the next section.
  • Rich Text / HTML does NOT appear as an asset, and can only be replicated on another guide by mapping the entire box.

Image Manager

All images used on LibGuides have to be uploaded and added through the Image Manager. You can access the Image Manager in two ways:

  1. While you are editing a rich text content item, select the image icon in the Rich Text editor in the ribbon at the top of the editing window. This will open Image Properties, where you then select "Browse Server" to open the Image Manager.

Screenshot of the rich text editor ribbon with the image icon in a red box.

 

  1. You can also navigate to Content > Image Manager to open the same window. Once you are in the Image Manager, you can upload images. Here are some considerations:
  • Pay attention to the folder you are in. [ROOT] is the default folder in your Personal Library. You can navigate to Shared Library to add or access images available to others LibGuide creators.
  • Alternative text can be added to individual instances of images using the rich text editor, but to add standardized alt-text use the Image Manager. For more information on alt-text, visit: LibGuides Accessibility: Alt-Text for Images.

A screenshot of the Image Manager showing the navigation area.


Springshare help center

Databases

In order to convey consistent information about databases, always use the preexisting database assets.

  • If a database falls within your liaison subject area, you are responsible for managing said database in the Databases A-Z list. For more information about this, visit: Databases A-Z.
  • Databases are individually managed by subject liaisons, but anyone can add any database to their guide. Once you have added a database to your guide, you can select edit to create a custom description: this will override the standard description and allow you to add necessary subject information, such as "use [search string] to find articles on [subject]".

Below is an example of a database asset for JSTOR.


Springshare help center

Links

Link assets are less standardized than database assets, but it is still important to create and reuse links as assets for resources, instead of in-line hyperlinks because link assets can be more easily updated and deleted across guides if a link is broken or changes.

We recommend searching for a link under "reuse link" before creating a new one to see if that link has already been created by someone else.

Also, you can see statistics (click counts) for link assets, but not for in-line hyperlinks, and LibGuides' built-in link checker only works on link assets.

Below is an example of a link asset for Springshare's "Add a link to a guide" page.


Springshare help center

Other assets and content

Media / widget

This asset type embeds HTML content into your guide, such as YouTube videos or tools from other Springshare products like LibAnswers. It can be difficult to create widgets without HTML knowledge. If you want help with widgets, contact the Working Group (libguides@exchange.uci.edu).

To add streaming media to a guide from places like AVON, Docuseek, Kanopy, etc., find the share options for the media and copy the "embed code."

Below is an example of an embedded media asset: a documentary from the streaming media platform Kanopy.


Springshare help center

Book from the catalog

Book assets are individual records of books that you can add to your guide. Here are some important notes on book assets:

  • The easiest way to add a book asset is to find the ISBN, enter it into the ISBN field, and select Get Book Info.
  • If you know or think that the book you want to use has already been used in LibGuides, search for it under Reuse Existing Book.
  • Books assets are NOT connected to UC Library Search. If you want the asset to be connected to the catalog, you will need to enter the permalink and/or call number manually.
  • You can put books and other assets in a gallery box for a carousel of the book covers. However, book assets need to already be added in LibGuides order to add them to the gallery box.
    • Go to Content > Assets > Add Content Items, and add the book(s) you want in your gallery box. Then, add a new box to your guide and select 'gallery' in the box type drop down. Then select the settings wheel and add a new slide with your book.
    • You can also adjust the gallery settings (e.g., to change the number of slides that display, change the number in Slides to show).

Below is an example of a book asset.


Springshare help center

Document / file

Attach and display documents such as pdfs, docx, ppt, etc. directly in your guide. Make sure the files you are uploading are accessible!

Below is an example of a pdf document asset.

Springshare help center

RSS feed

If a journal/provider has an RSS feed, you can display a constantly updating feed of recent publications.

Below is an example of an RSS feed asset.

Loading ...

Springshare help center

Guide list

Create a list of relevant guides from the UCI Libraries to display in a box.

Below is an example of a manually selected guide list.


Springshare help center

Interactive poll

Create a poll for users to take on your guide. Note that you will not get notifications when someone responds to your poll, and you will only be able to view poll results in the editing side of your LibGuide.

Below is an example of an interactive poll.

How do you feel about creating LibGuides?
I love it!: 1 votes (100%)
It's okay: 0 votes (0%)
It's not my favorite: 0 votes (0%)
It's the bane of my existence: 0 votes (0%)
I have never created one: 0 votes (0%)
Total Votes: 1

Springshare help center

Google search

Embed a Google search bar for normal google or google scholar. We recommend not using this content item and adding a google or google scholar link asset instead (reuse an existing link).

Below is an example of a Google search box.

Google Web Search

Springshare help center