Standards for Creating LibGuides

This section addresses the different asset types in LibGuides and how to incorporate these various mechanics into your guides properly.

Choose this asset type if you need to add written content that does not include links (e.g. introductory statements, descriptions, etc), images, or dynamic javascript code for widgets, forms or other tools.

Do not use this asset type for adding links to Temple-restricted content, such as databases, ebooks, articles, etc.

It is recommended that you use the content type for all non-Temple-restricted content; however, if you must use links to non-Temple-restricted content inside a Rich Text/HTML asset type:

• Use descriptive, concise link label language
• Do not type the naked URL and then link it -- e.g. Try the Library Search: library.temple.edu.
• Leave the Window Target set to the system default.

Keep in mind that any content added as a Rich Text/HTML asset type needs to be individually monitored and updated manually. For example, if links are added, those links cannot be managed by the link asset manager -- i.e. global edits do not apply to this type of content.

Font

• Use only the default style text.
• Don’t use ALL CAPS.
• Bold and italicize content sparingly (ex. bold a word or phrase, but not an entire sentence or paragraph).
• Don’t underline text as it can confuse users to believing the content is linked.
• Text should be aligned left, not centered or aligned right.
• Avoid any styling that may result from copying and pasting from other documents or applications. Selecting > Edit > Paste and Match Style or copy first to a text editor first will eliminate unintentional text styling. Hit the button to view your code and ensure you have not included any additional styling.

Colors

Use only the default font color to ensure sufficient contrast between background and the font color for ease of readability.

Accessibility

• Any links should make sense if the linked text is read by itself. Screen reader users may choose to read only the links on a web page. Make sure linked text makes sense out of context. Ambiguous phrasing obscures what the link is about. Avoid phrases like “click here.”
  • Bad: Go to this US Government source for comprehensive homeowner data by clicking here
  • Good: The US Government provides comprehensive homeowner data
• Any images must include a meaningful description in the Alternative Text field of the image.
• Any tables must include proper markup, specifically a summary, a caption, and headings.
  • Any database search boxes must contain a label tag in order for screen readers to be able to read them. Search boxes in the box repository are ADA compliant. If creating a new search box, please do so in the box repository to ensure that it is checked for ADA compliance.

Choose this asset type if you need to add a link to anything not found on theDatabases A-Z list.

• List items (links, books, articles, etc.) in order of importance rather than alphabetically as users tend to use the first item listed.
• Keep lists of items short – aim for no more than the top five featured prominently.  Break up long lists of items into logical groups so that they can be skipped by screen readers. Further, consider breaking long lists of items into different boxes based on similar content type, topic, theme, etc.
• Strive for usability, not comprehensiveness.

How to link to a book

Choose the Book from the Catalog asset type when adding a link to an ebook, ejournal, print book, or print journal listed in the Library Search.

Enter the book information:

• First enter the ISBN and click Get Book Info.  This should work to auto-populate most fields, and the book cover. Note that if a description is available, it, too, will auto-populate. If including the description, select the Display beneath item title option. Otherwise, select the Hide description option. Don't hide the description behind a hover-over button as this is not accessible.

​

• If Get Book Info does not work, manually enter the book information. In the Cover Art field, enter a URL for an image or enter an ISBN to search for an image in Syndetics or Amazon. Note that using an Amazon image will automatically link it to the product page.
• Do not put locations and call numbers in your guides. Instead, link to the Library Search record, which has the most recent location information, provides the status, and allows the user to place requests.
• For ebooks, use the permalink found via the database vendor (e.g. credo, Oxford Reference Online, etc.).
• Select 'No' to use proxy if using Library Search permalinks. If using database vendor permalinks, check if proxy is already included; if not, select Yes to use proxy.
• Do not use your browser window URL as a link.
• Keep mentions of print resources to a minimum. The best resource may be print; however, long lists of resources inaccessible via the web will frustrate or confuse user (Boston College Libraries’ LibGuides Standards and Best Practices).

How to link to an article

Choose the Link asset type when adding a link to an article listed in the Library Search or any of the Libraries’ subscription databases.

Enter the article information:

• Enter the article citation in the Link Name field, using the citation style relevant to the subject area. If including a brief description, select the Display beneath item title option. Don't hide the description behind a hover-over button as this is not accessible.

• Enter an available permalink found via the database vendor (e.g. EBSCOhost, ProQuest, etc.) as the URL in the Link URL field. Don’t use your browser window URL or Library Search. Select No to use proxy.

Proxy URLs

Most of the Temple-restricted content you add to your LibGuide will be proxied automatically, if you follow the guidelines for choosing Proxy: Enabled/Disabled as described above. A few additional notes about proxying:

• The Libraries’ website and its pages, in addition to the Library Search, DO NOT need to be proxied.
• If you need to include the proxy for any kind of code/widget content, use libproxy.temple.edu/login?url= as a prefix Example:

http://libproxy.temple.edu/login?url=http://www.oxfordreference.com/view/10.1093/acref/9780199206087.001.0001/acref-9780199206087-e-107)

URL Shorteners

URL shorteners (e.g. TinyURL, bit.ly, and goo.gl) should not be used as a replacement for directing users to Temple-restricted content, nor should they be used to direct users to unrestricted content. Use the full link and allow users to make an informed decision based on a complete destination link.

• Descriptive, narrative content is chunked to make reading and understanding easier
• Link labels are unique and descriptive, clearly telling users where they’re going