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

You must have full user permissions for your space to perform these steps.

The Side Module 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).

    Example: you may create a Side Module called "Media Outlets"

    ...inside which you will have Side Module Links to "BBC Mundo", "CNN", "NPR", "Tech World" and "Wired".

    Side Modules

    Navigation: SitePref 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's 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.

    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, 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 circled in yellow.

      Appearance in Default Theme
      Top left and top right links appear in the upper left and right hand corners of the page
      Appearance in New UW Theme
      Top left and top right links appear in the upper left and right hand corners of the page
    • 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 blue arrow pointing to the Link Bar.

      Appearance in Default Theme
      The search bar is moved from next to the logo to below the link bar
      Appearance in New UW Theme
      The search bar is moved from next to the logo to below the link 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 blue arrow pointing to the Link Bar.

      Appearance in Default Theme
      The link bar appears below both the logo and search bar
      Appearance in New UW Theme
      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 a blue arrow pointing to the Menu Bar. Under the "Publications" menu item, you will see four items to choose from in the dropdown menu.

      Appearance in Default Theme
      The dropdown menus appear below the logo and search bar
      Appearance in New UW Theme
      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 spacebar.

      Appearance in Default Theme
      The expand/collapse arrow appears to the right of the module name
      Appearance in New UW Theme
      The expand/collapse arrow appears to the right of the module name

    Visibility Settings

    • Internal - Check/enable if you want the Side Module availability on the Internal Live site.

    • External - Check/enable if you want the Side Module availability on the External Live site.

    • FullView -Check/enable if you would like your Side Module to appear when viewing on a full desktop/ laptop screen view.

    • MobileView - Check/enable if you would like your Side Module to appear when viewing on mobile devices.

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

    • DocPage -Check/enable so the Side Module will appear on any other page 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.

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

    • *Add - 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.

    Side Module Links

    Navigation: SitePref tab > Side Module Links > Side Module Links screen. The image below shows a blank Side Module Link waiting to be customized. Note the red arrow leads to the names of existing Side Modules. This image shows "References" as the Module name. the aptly named Position field's 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.


    • 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
    • Internal - Check this box if you want the Side Module Link available on the Internal Live site.
    • External - Check this box if you want the Side Module Link 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 - 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.

    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:Teresa A.Group:KB User's Guide
    Created:2012-10-24 09:14 CSTUpdated:2019-08-29 15:40 CST
    Sites:KB User's Guide
    Feedback:  2   0