KB User's Guide - Settings Tab - Side Modules and Side Module Links

NoteInformation symbol

You must have full administrative permissions in your space to perform these steps. This means access to the Documents, Settings, and Users tabs.

Side Modules appear on your Live KB Site(s). There are seven distinct places where an Admin can apply a Side Module. Please know this feature has become so robust, its name has become a misnomer. Side Modules are not just restricted to the "sides" of your KB site. This document will help describe Side Module functionality and how you can use it to best engage your users.


A Quick Analogy about Side Modules and their Side Module links

For you visual thinkers, imagine when you create a Side Module, that you are creating a "container" in which you will place Side Module Link(s).

Container of water representing the side modules and a thermometer within the container representing the side module links


Example: you may create a "container" named "Tech Media" as a Custom Left Side Module.

...inside this "container", you will have Side Module Links of  CNN, Wired, NPR and BBC Mundo.

This is what this Left Side Module would look like on the Live Site.

Example left side module containing CNN, Wired, NPR, and BBC Mundo links

Side Modules: A Description

There are seven options for Admins to apply "Side Modules".

Navigation: Settings tab > Side Modules > Side Modules screen.

The image below shows a blank Side Module waiting to be customized. Note the positional options in the aptly named Position field dropdown menu. The image below shows a blank Module field circled in red and also shows all the options available. These options will be further illustrated below.

UI for adding a custom side module with arrows pointing to position and how to add

Positional Options Attributes

You may define as many Side Modules as you would like. After you enable the specifics of your Custom Side Module, click the Add button. Should you only click the Update button at the bottom of the screen, your custom Side Module will not be saved. *The Update button saves edits to existing Side Modules*.

Module name - The name of your Side Module. The name you enter here will be displayed to users if the module position is Menu Bar Dropdown - Under Search, Side Left or Side Right. For the other positions, the module name will only be referenced by admins working on this page in the KB Admin Tools. 

If you are choosing one of the other module positions, such as Link Bar - Between Logo and Search, it is recommended you set the name to something simply like "Link Bar" for easy reference.

Position- The position you choose has a significant impact on the layout of your KB site. Below are descriptions of each position option. 

  • Top Left

  • Top Right

    Top Left and Top Right Links appear in a bar at the very top of the page in their respective corners. When multiple links are added to a Top Left or Top Right module, they will be displayed horizontally, with the first link appearing the further left and progressing to the right.

    The image below has Top Left and Top Right Links pointed to by blue arrows. 

Top banner of the UW Theme showing the position of the top left links and the top right links

  • Link Bar - Between Logo and Search

    When this position is selected, the search bar will be moved out from alongside the site logo and will instead display in a separate section below, with the Link Bar appearing between the logo and new search areas. When multiple links are added to a Link Bar, they will be displayed horizontally, with the first link appearing the further left and progressing to the right.

    The image below shows a Link Bar between the logo and the search bar.


UW theme top banner showing menu bar links in between the logo and the search bar

  • Link Bar - Under Logo and Search

    When this position is selected, the Link Bar will appear below the combined logo and search area. When multiple links are added to a Link Bar, they will be displayed horizontally, with the first link appearing the further left and progressing to the right.

    The image below shows a link bar under the logo and search field.


The link bar appears below both the logo and search bar

  • Menu Bar Dropdown - Under Search

    When this position is selected, the Menu Bar will appear below the combined logo and search area. Each module added with this position represents its own dropdown menu in the menu bar area, ordered left to right, with the name of each module displaying in the menu bar. When a user hovers over the dropdown name in the menu bar, the links will be displayed in a vertical list.

    The image below shows the Menu Bar. Under the "Learn More" menu item, you will see three links to choose from in the dropdown menu.


The dropdown menus appear below the logo and search bar

  • Side Left

  • Side Right

    When one of these positions is selected, a column will be created to the right and/or left the main content area. Each module added with this position will be a separate grouping of links in the column, ordered top to bottom. The module name will be displayed at the top of the link grouping, and an expand/collapse arrow will appear next to the module name.

    If a user collapses a side module, their selection will be stored in a browser cookie, and this will be retained if the user goes back to your site in the same browser session. Additionally, UW-Madison sites configured with the new UW Theme layout will have side modules auto-collapse at smaller screen widths.

    These downward pointing arrows/ chevrons are accessible to those accessing the KB via a screen reader by means of the keyboard, specifically the space bar.

The expand/collapse arrow appears to the right of the module name

Visibility Settings

  • Internal - Check/enable for Side Module availability on the Internal Live site.

  • External - Check/enable for Side Module availability on the External Live site.

  • FullView -Check/enable for the Side Module to appear when viewing on a full desktop/ laptop screen view.

  • MobileView - Check/enable for the Side Module to appear when viewing on mobile devices.

  • LandingPage - Check/enable for the Side Module to appear on the homepage. (recommended)

  • DocPage -Check/enable so the Side Module will appear on all other pages within your KB.

    In the image below, you see that the Side Modules appear whenever you pull up a document. If your content is better presented using the full screen, then do not check DocPage.


Side Module appears when you open a document

  • Order - Select what order the Side Modules will appear on your site.

  • *Add button - Please be sure to click this button to add the your Custom Side Module. If you only click on the Update button on the bottom of the screen, your new Custom Side Module  will not be added. The Update button only updates existing content.

How to Create a Side Module

  1. Navigation: Settings tab > Side Modules > Side Modules screen.
  2. Put your cursor in the Module name field and enter a name for your Side Module.
  3. Choose a position in the Position drop down menu where you want this side module to appear.
  4. Determine whether you want this Side Module to appear on the Internal/ or External site by checking the appropriate boxes.
  5. Click on Fullview, Mobileview, LandingPage and/ or DocPage check boxes as you see fit.
  6. In the Order field, enter a number. This field determines where this Side Module will appear in the sequence of current Side Modules.
  7. Click the Add button to save this Side Module that you just created.

     Note: Scrolling to the bottom and clicking Update does not save your Side Module.

 

Side Module Links: A Description

Navigation: Settings tab > Side Module Links link > Side Module Links screen.

The image below shows a blank Side Module Link waiting to be customized. Note the red circled arrow leads to a dropdown menu of the names of already existing Side Modules. This image shows "References" as the Side Module name.

Blank side module link to be customized, circles highlighting the side module name dropdown and the add button

  • Module name - which specifies the Side Module in which you'd like the link to appear
  • Link name - Name you would to appear when (required field)
  • Link URL - Enter link url here (required field). If linking to a KB document, you need only enter the document ID number
  • Internal - Check for the Side Module Link to be available on the Internal Live site.
  • External - Check for the Side Module Link to be available on the External Live site.
  • Popup - which specifies if you'd like the link to open in a new window/ tab in your browser.
  • Order - sequence in which the links are to be displayed within the Side module
  • *Add button - Please be sure to click this button to Add the your Custom Side Module Link. If you only click on the Update button on the bottom of the screen, your new Custom Side Module Link will not be added. The Update button only updates existing content.

How to Create a Side Module Link

  1. Navigation: Settings tab > Side Modules Link link > Side Modules Link screen.
  2. Put your cursor on the Module name dropdown menu and select the desired Side Module.
  3. Enter a name for your Side Module link in the Link name field.
  4. Enter the link in the Link URL field..
  5. Select Internal and/or External check boxes to make your Side Module link available on the site(s) you wish.
  6. Select the Popup box if you want your link to appear in a new window.
  7. In the Order field, enter a number. This field determines where this Side Module will appear in the sequence of current Side Modules.
  8. Click the Add button to save this Side Module that you just created.

     Note: Scrolling to the bottom and clicking Update does not save your Side Module link.

 

See Also:



Keywords:module name position FullView full view MobileView mobile view LandingPage landing page DocPage doc page order navigation menu bar update modify change container document   Doc ID:27019
Owner:Leah S.Group:KB User's Guide
Created:2012-10-24 10:14 CDTUpdated:2023-06-01 16:19 CDT
Sites:KB User's Guide
Feedback:  0   0