Skip to Main Content

Springshare CMS: Home

This LibGuide provides information about the Springshare products Reference oversees or uses extensively. This Guide provides basic "how-to" information for IOT Library employees using these products.

Overview & Purpose of this Guide

This guide will provide standards, best practices, and guidelines for authors to follow when creating and updating guides, and will help create usable, readable and well-designed guides for IOT Libraries.

Fundamental Usability Ideas

Fundamental Usability Icons

Start Here

CHOICE Media Channel - Are you looking to get the most of LibGuides built-in features to increase consistency across your guides? Seeking out ideas for creating your own style guidelines? Looking for tips on how to make your guides more accessible while building in a ‘positive library experience’ for all? Or are you looking to pick up some writing for the web and design tips to make your guides more effective? Then this session is for you! The purpose of this session is to give regular and admin users an overview of some best practices for managing and designing your LibGuides content. Event page: https://www.choice360.org/webinars/be...(1:19:37)

SpringShare and LibApps

The Springshare LibApps platform provides a variety of tools for librarians to help users find resources and information, answer user questions 24/7, promote library services, events and spaces, and maximize the use of library services.

LibGuides: LibGuides is an easy-to-use content management system deployed at thousands of libraries worldwide. Librarians use it to curate knowledge and share information, organize class and subject specific resources, and to create and manage websites.

LibCal: LibCal provides four modules to handle libraries' calendar needs: hours and locations management; room and equipment reservations; event registration and management; and librarian appointment scheduler.

LibWizard: Build interactive tutorials and test users' research skills using forms and surveys, or by building gradable quizzes.

LibAnswers: LibAnswers provides a ticketing system and FAQ builder, as well as LibChat and "Ask Us" widgets for direct communication with users.

LibChat - Live chat with students, tied to LibAnswers and ticketing.

LibInsight -  Tool to gather & analyze all library statistics.

Web Design Best Practices

  • Choose a color scheme and use approved colors for NU and department.
  • Be consistent in colors, fonts and other elements.
  • Don't overdue the use of color. Stick to around 2-3 different colors to keep it looking organized and not busy.
  • The most common forms of colorblindness make it hard for some users to tell the difference between these colors:
    • green and orange
    • red and green
    • blue and purple
    • red and brown
    • blue and green
  • Be consistent to your branding throughout all pages.
  • Adding images help break up written content and give a deeper explanation of content when right image is used.
  • Leave white space between sections to help visually separate content
  • When adding buttons/CTA, make them stand out with a bright color and stay consistent throughout all pages.
  • Simple navigation will help people find what they are looking for.
  • Keep fonts easy to read and consistent. Don’t add more than 2-3 different font families.
  • Make sure to check that the page is responsive, looks good on tablets and phones. 
  • Saving icons, logos or anything without a background color should be saved as a png.
    • Saving images, icons or anything with blank areas as jpegs will add a white background automatically, that’s why icons/logos should be pngs.
  • Use high quality images and icons and make sure the size (pixels) isn’t too big (for a screen wide image, nothing bigger than 1200px wide)
  • Icons are great visuals to help explain what follow content is about
  • Images are good to use when breaking up sections of text.
  • Always compress them so the page load time is as fast as possible.
  • If copy/pasting text into LibApps, make sure to paste as plain text so no styling is brought over from other documents or pages. Style settings from other sources might not match LibApps.
  • Headings/Titles: H1 are the biggest font and explains what the page is about. H2 are secondary topics supporting helping to organize the page. The same goes for the rest of the headings. P(paragraph) is the body text.
  • Body/paragraph font size should be at least 16 pixels.
  • Bullet points are great to help people understand/digest your content.
  • If you add text on an image, make sure it is easily to be seen and read.

Accessibility Best Practices

All webpages use headings to clearly organize and label sections for users. Headings also help users with screenreaders to move around a page and jump to sections that are relevant to them.

If you want to add headings or sections to your website, use heading styles instead of simply enlarging or bolding text. Heading styles are already formatted to stand out from regular paragraph text and help screenreaders to skip directly to the information that the user needs.

Heading styles should always be used in numerical order:

  • Heading 1 (H1): the title of the webpage is automatically a Heading 1. There should be only one Heading 1 on the page.
  • Heading 2 (H2): any main headings on the page below the title. Any labels/names for boxes are automatically a Heading 2.
  • Heading 3 (H3): any sub-heading under a Heading 2, such as any sub-headings within a box.
  • Heading 4 (H4): any sub-heading under a Heading 3

Headings should be in order, so do not go from h3 to h5 (meaning you would be leaving out h4).

              Example:             <h3>Section 1</h3>

                                                           <h4>Section 1.1</h4>

                                                           <h4>Section 1.2</h4>

                                                                          <h5>Section 1.2.1</h5>

                                                           <h4>Section 2.1</h4>

                                            <h3>Section 2</h3>

Example of Heading Hierarchy

In the example below, the title of the webpage is “Institutional Review Board (IRB): IRBManager” and is a Heading 1. There are 3 boxes on the page, and each box label/name is a Heading 2: “Contact the IRB,” Calendar,” and “Introduction to IRBManager.” Within the “Introduction to IRBManager” box, are Level 3 Headings for “Student Researchers” and “Faculty Chairs/Mentors.”

Heading Hierachy on the IRB: IRBManager LibGuide

To add a heading:

  1. Select the text that should be a heading
  2. Click the dropdown menu for “Paragraph Format”
  3. Select the appropriate heading number

Heading Levels on the Text Editor

Best Practice

Add hyperlinks as click-tracked assets under the Asset Manager and add as individual links in a content box. Hyperlinks should be a specific text or phrase that clarifies where the link will take users and should be clear outside of context. No "click here" statements. 

Add Links To the Content Box

  1. Click Add/Reorder link
  2. Select Link from the menuAdd Links to Content Box
  3. On the Create New Link form, add your description phrase for the Link Name.
  4. Type the URL in the Link URL field
  5. Select your Window Target, select New Window if linking external to the guide. 
  6. Enter a Description, More Info, or Description Display settings as needed. 
  7. Click the Ok button to save the link.​​​​​​

Reuse Existing Link

Embed Links Within Content

Adding hyperlinks within your webpage or content box is at times more logical than adding a separate list of links. Caution: Links within text are not added to the Asset Manager or tracked through the Link Checker. 

When linking to a document or webpage, don't just copy and paste the URL onto the page. URLs can be long and complicated for screenreaders to read and don't clarify where the link will take users.

Instead, place the link onto a specific phrase that clarifies where the link will take users. This word or phrase should also be clear outside of context, as screenreaders can read off all the links on a page without their surrounding content.  An example would be a link to the IOT Library Catalog or a link to the WebAim standards for web accessibility. In both cases, you know that the links will take to the IOT Library Catalog website and WebAim website, respectively. Furthermore, if the link will lead to a page outside of your LibGuide, such as a link to another IOT department or another organization, the link should open the site in a new window. This prevents users from getting lost and not being able to return back to your LibGuide.

Add a Hyperlink Within Content (Inline Link)

To add a hyperlink:

  1. Select the text that should be a link
  2. Click the “link” icon (looks like a link from a chain)

Adding Inlink Link Example Screen

  1. Under the “Link Info” tab, paste the URL where the link should go

Link Info Tab

  1. If you will be linking to a page outside of your own website, click the “Target” tab and use the drop-down menu to select “New Window (_blank)” (this will open the link in a new tab)

Add Link Target New Window Blank

  1. Click “OK”

People generally scan for information on web pages. Use different types of lists to group information according to its nature to provide orientation and easier consumption.

Unordered lists

  • Unordered lists are used when the order of the items is not relevant.
  • List items in unordered lists are marked with a bullet.

Ordered lists

  1. Ordered lists are used for sequential information.
  2. List items in ordered lists should follow a logical hierarchy. 

Best practice according to ADA guidelines when adding images is to provide a textual description of the image. If an image is on your web page, it is important to ensure that images that convey important information have appropriate text alternatives or descriptions. A description of an image will ensure that it is accessible to everyone. Alternative text and captions are the most commonly used methods to describe images. However, depending on an image's complexity or overall functionality, other image description approaches may be more suitable. When placing images on your website, be mindful that some users won’t be able to see your image or read content placed within an image. All images should have a textual alternative that can be read by screen readers. Alternative text (or alt text) should always be provided for images that are not decorative. Here are some tips for writing alternative text:

  • Do not begin with “image of” or “photo of”
  • Be concise and use a brief phrase if possible. If more than 2 full sentences are needed to describe the image, then describe the image within the text instead
  • Describe the parts of the image that are relevant in the context of the webpage
  • Include any text that appears in the image
  • If the image acts as a link, describe where the link will take them

How to Add Alt Text

To add alt text for an image:

  1. Select the image that needs alt text
  2. Select the image icon
  3. Type alternative text into the “Alternative Text” box
  4. Click “OK”

Images

The first example is an image that does not contain text or act as a link. The alt text should just describe what you want people to notice in the image:

Example: This image will be used on a page about track tryouts.

Poor Alt Text: "Harvard Runners."

Useful Alt Text: "Harvard Stadium with two lone runners bounding up the steps."

Harvard Stadium with two lone runners bounding up the steps

Logos

Alt text for logos should reference the image's purpose. They may or may not include the word logo.

Institute of Technology branded logo with the reaching for the stars imageExample: This is the Institute of Technology's classic logo used on many branded materials. 

Poor Alt text: "Institute of Technology." 

Useful Alt text: "The Institute of Technology's Reaching for the Stars branded logo."

Icons

Alt text for icons should be the equivalent to the information intended by the icon, such as “Download PDF” or “Visit our Facebook Page.” 

Print the Event ScheduleExample: This printer icon will be used on a page with a schedule of events. 

Poor Alt Text: "Printer icon." 

Useful Alt Text: "Print the Event Schedule."

Images as Links

If the image is being used to link to another page, the alt text should describe what will happen when the image is clicked (rather than what it looks like). 

Contact SupportExample: This question mark links to a help page and is intended to encourage users to click if they need support.

Poor Alt Text: "Question Mark." 

Useful Alt Text: "Contact Support."

Accessible multimedia (visual and auditory content that is synchronized) must include captions—text versions of speech and other important audio content—allowing it to be accessible to people who can't hear all of the audio.

According to US government figures, one person in eight has some functional hearing limitation, and this number will increase as the average age of the population increases. Beyond people with disabilities, captioning helps people who only partially understand the language presented. Captions are also useful in noisy environments like airports, in quiet environments like libraries, and for multimodal learning.

All multimedia content with speech should have accessible captions that are:

  • Synchronized to appear at approximately the same time as the corresponding audio.
  • Equivalent to the spoken words and other audio information.
  • Accessible, or readily available, to those who need it.
  • Closed Captioning is most common, this allows for the accessibility feature to be turned off if unneeded

For multimedia, a transcript can also help users who can neither hear the audio nor see the video. Beyond the spoken words, a transcript should include descriptions of important audio information (like laughter) and visual information (such as someone entering the room). Transcripts help deaf/blind users interact with content using refreshable Braille devices.

Transcripts allow anyone that cannot access content from either web audio or video (or both) to read a text transcript instead. Beyond the spoken words, a transcript should include descriptions of important audio information (like laughter) and visual information (such as someone entering the room). Transcripts help deaf/blind users interact with content using refreshable Braille devices. For most web video, both captions and a text transcript should be provided. For content that is audio only, a transcript will usually suffice—captions are not necessary for audio-only media like a podcast.

Transcripts make multimedia content searchable by search engines and users. Screen reader users also may also prefer a transcript over real-time audio, since most proficient screen reader users set their assistive technology to read at a rate much faster than natural human speech.

All documents on the website should have the option to open in PDF along with a Word document. Word documents are more accessibility-friendly because screen-reading software is able to go through the document and read it aloud to the patron.  PDF does not comply with accessibility standards and is not compatible with screen reading software. 

Documents: Most of us do not think we have a role in accessibility — that is for web designers.  But that is simply not true.  We make documents every day that we put online for our students.   Creating accessible documents (MS Office, Google Apps, PDFs) is key to accessibility for all.  It not only makes our work more useful but it can save us time

Help

Questions? Need an account?

Request via IOT-Library@iot.edu

Subject Category Suggestion Form