Skip to Main Content

Standards for Creating LibGuides

Requirements

  Guide Content
  Databases must be linked to the A to Z
  Database descriptions are brief and display beneath the item
  Video content from other institutions is used sparingly
  Images include alternative text (ALT tags)
  Search box is easy to locate and justification is provided if it appears next to database links
  Search box is reused, mapped either to an individual’s box repository or the primary box repository (code must be copied from box repository)
  Instructional content is easy to locate when scanning the page
  Instructional content is in a separate box, but next to the links from resources

Boxes

LibGuides offers 4 different box types: Standard, Tabbed, Gallery, and Profile.

  • Use Standard boxes when possible, as these will help your page look uncluttered. The standard box allows for creating the most frequently used content types in LibGuides such as rich text and database links.
  • Do not use Gallery boxes. This type of feature (often referred to as a “carousel” in web design) can be frustrating to users and pose accessibility issues.
  • Use Tabbed boxes sparingly.

Databases

The purpose of guides is to get the user started in their research, not to provide a comprehensive list of all the possible databases in the subject area.

Recommended:

  • One general database
  • One or two of the primary subject databases in the area
  • One featured database: include a new database—perhaps something new, or a database that might be useful for specialized research, or for locating related multimedia material

Database descriptions

Use standard database description included in the Database A to Z, when possible.

Using the standard description means that length and language are agreed upon and appropriate to the guide. It also saves time and creates greater consistency across all of the guides. There is less confusion.

Customizing a database description
Sometimes a course-related guide will need to be more customized with database guidance.

  • Consider how the database description will read when reused on other guides. Subject specific acronyms and abbreviations may confuse readers who are unfamiliar with the subject.
  • Keep your description short.

Database asset

  • Always add databases as a Database asset type. The Electronic Resources Librarian maintains databases in the central Databases A to Z.

  • Never add a link to a Temple subscription database using a “Link” asset type.

To add a database asset:

  1. Click Add/Reorder. Select Database, and search for your database by title.
  2. The recommendation is to use the standard database description. However, If adding a Custom Description for a course guide, note how the database relates to course assignments, types of materials found in that database (articles, government documents, policy papers, book chapters), or other information about how the database is useful for the intended guide audience. The description should be 1-2 lines.
  3. Check Display beneath item title beside Description Display, so that the user doesn’t  have to mouse over the database name to see the description, and is able to view the description on a mobile device.

Rationale: Users read database descriptions when deciding which resource to use. Short descriptions help users scan the page for information more easily. (source: Temple University Libraries’ LibGuides Usability Testing, 2015)

Checklist for Databases

  • Databases must be linked to the A to Z list
  • Database descriptions are brief and display beneath the item 

Images

Images can break up content on a page and liven up your guide with a nice, eye-catching visual element.

  • Use images that complement your other content and break up space, not as a focus point on the page.
  • Images can be used anywhere on your guide.
  • Limit use of screenshots. Screenshots require frequent updates as interfaces change. If using screenshots, make sure that they meet accessibility requirements.

Adding Images

  1. In a rich-text box, select the image icon and Browse Server

     

  2. Upload an image or access one from your personal library
  3. Select the image icon under the image and click Save

     

  4. In Image Properties box, resize the image to a reasonable width. Add Alternative Text. When adding an image to a LibGuides page, always make sure to put a meaningful description into the alternative text, or “alt tag” of the image. The alt tag is a brief description of the image and its purpose on the page. Remember that users who will be seeing the alt tag will likely not be able to see the image, so be sure to adequately describe the the image’s appearance.
  5. Enter values in the HSpace and VSpace to create white space around your image. For example, the values here are HSpace 50 and VSpace 10.

Videos

  • Use video sparingly. Videos must be short, relevant and to the point, and up to date. Instructional videos from other institutions should rarely be used. This type of content may not be accessible, and it may break or become outdated, causing content and usability issues.
  • Videos must adhere to copyright and accessibility standards
  • Video content should be of high quality and exhibit principles of good instructional design.
  • Indicate in the link description or title if a link goes to a video.
Rationale: Users are attracted to video tutorials, and may click on them and spend time watching them even if they are not directly related or helpful to the task they are trying to complete. (source: Temple University Libraries’ LibGuides Usability Testing, 2015).

Checklist for images and videos

  • Video content from other institutions is used sparingly  
  • Images include alternative text  (ALT tags)

Search Boxes

  • When adding a search box, ask yourself if you need both a search box and a list of of databases. Choose either an embedded search box or a list of databases.
  • If you include both, ensure the search box makes sense alongside a list of databases and is highly visible. Provide an explanation for the user as to why they might use the search box vs. databases list.
  • Limit to one search box per page.

 

Rationale: Users like search boxes, and are drawn to them, but may also overlook a search box when a page is cluttered with a large volume of other content types (source: Temple University Libraries’ LibGuides Usability Testing, 2015).

 

 

Reusing Search Boxes

  • The Box Repository guide has search boxes and other frequently used content. Search boxes are centrally managed and updated, so it's recommended that you reuse search boxes from this guide as much as possible. Mapping to these search boxes will reduce work during future system upgrades or migrations. Currently, other boxes, such as instructional content, are not centrally managed and updated.
  • Note that when you select Reuse Existing Page/Box, you have the option to select copy this page/box. If this is selected, the content won’t be updated when changes are made to the box repository boxes.

Reusing Boxes (including Library Search (Primo) search widgets): 

To reuse boxes, in edit mode,

  1. Add New Box
  2. Click the Reuse Existing Box tab
  3. Select Box Repository (or other guide)
  4. Locate box (you customize the Box Name field; however, the name of the box will not be updated automatically in the future)
  5. Check Copy if you would like to customize the box. For search boxes in the box repository, the recommendation is to map to those boxes, not copy.
  6. Click Save when done.

If you would like to create your own customized search boxes, consider doing one of the following:

  • Map the search widget as opposed to the entire box (instructions below).
  • Create your own box repository with the content and search boxes that you reuse frequently and map to those boxes. They won't be updated automatically, but it will be easier for you to maintain the content.
  • Ask the Review Team to create a customized box for this page. Others might want the same box!
  • Avoid creating new search boxes for each guide--you should be mapping to search boxes in the box repository or your own repository.

Tips for creating your own search boxes

  • There are two options for creating customized search boxes (for when you don't want to map to the entire box content). You can map to just the search widget (instructions below) or create your own search widget (instructions and code below). 
  • Create your own box repository with the content and search boxes that you reuse frequently and map to those boxes. They won’t be updated automatically, but it will be easier for you to maintain the content.
  • Ask the Review Team to create a customized box for this page. Others might want the same box!

  • Avoid creating new search boxes for each guide -- you should be mapping to search boxes in the box repository or your own repository.

 

 

Reusing (just the) search widgets

  1. Add/Reorder content
  2. Click Media/Widget
  3. Reuse Existing Widget
  4. Search for the widget
  5. Do not click copy
  6. Select and save

Content Types to Avoid

  • RSS Feed
  • Google Search
  • Poll
  • Embedded content from external applications such as Scribd
  • Remote Script

Rationale

Rationale: External applications such as Scribd create confusion and may cause content to load slowly. Users are confused by the presence of Google searches on library web pages as they expect library resources and services on our pages (source: Temple University Libraries’ LibGuides Usability Testing, 2015).

Checklist for search boxes

  • Search box is easy to locate and justification is provided if it appears next to database links  
  • Search box is reused, mapped to where possible, either to an individual’s box repository or the primary box repository