KB User's Guide - SitePref Tab - Customizing Your KB Site's Front Page

Admins with access to the SitePref tab may modify the Front Page of their Internal and External Live Sites.

Live KB Site Components

Key elements of a KB Site are identified in the screen shot below. Most can be customized as needed.

tourofkb.png

Content Modules on the Live Site

This Content Module part of the Live Site allows you to modify the content of the center of your KB site. There are three delivered Content Modules:

  • News and Announcements
  • Top Documents of the Week
  • Most Recently Updated Docs

You may also create Custom modules to accomplish a variety of things on your Internal /or External KB page.

Example: In the image below you will see three Content Modules circled in red; Status of Production, Recent Featured and Improvements and KB Basics - Start here! The Status of of Production Custom Content Module is an embedded Google Calendar. The KB Basics Custom Content Module list three specific documents.

Create/Modify a Content Module

To create/modify a Content Module, go to the SitePref > Content Modules link on the left navigation bar. This will lead you to the Content Modules screen. The image below shows a Custom Content Module and a named News Module on the Content Modules screen.

You can set the following preferences for your content modules:

  • Module name - Name the delivered field. Example, for the delivered News Content Module in the image above, the module may be named "News This Week in the Department of Classics". This field is required.
  • Internal - Check this box if you want the Content Module availability on the Internal Live site.
  • External - Check this box if you want the Content Module availability on the External Live site.
  • FullView - Check this box if you would like your Content Module to appear when viewing on a full desktop/ laptop screen view.
  • MobileView - Check this box if you would like your Content Module to appear when viewing on mobile devices.
  • Order - Select what order the Content Modules will appear on your site. Please remember we start with 0, 1, 2..
  • Limit of number of items to display - The dropdown list indicates how many items will appear in the delivered Content Module. It defaults to 8 items.
  • DocID(s) /URL - this field appears when creating a Custom Content Module. Enter one or a comma delimited string of document IDs. You may also enter a URL here.

Content Modules on the Live Sites: Expand and/or Collapse

After creating Content Modules that best suit your KB site, you will see a downward pointing arrow/ chevron in the right corner. This arrow indicates that the content module is collapsible and then expandable. The KB will remember what you choose to collapse and what you choose to keep expanded the next time you visit your live site. 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.

Display Single Document - instead of/ in addition to News, Top Documents, Most Recent Documents

By entering a single document ID number in the DocID(s)/URL field, the body of that document will be displayed in the center module. These modules can be on internal, external, or both sites, provided the document used in the Content Module is active for the respective site(s) where it will be displayed. Click on the Update button at the bottom of the screen to save your changes. There is no limit to the number of Custom Modules you can create.


Display Custom List of Documents

A comma delimited list of document ID numbers were placed in the Doc ID(s)/URL  field in a Custom Module, those documents will be listed on your site's main page. In the image below from our test KB, you will see a Custom Module called "Featured Docs - Example". It will appear in its own section very similar to the Top Documents of the Week or Most Recently Updated Documents sections.

featureddoc1.png

In the KB Admin Tools > Site Pref tab > Content Modules link, enter the name of your Custom Module and the comma delimited list of documents that you would like to appear. In the image below, you will see three comma delimited document IDs for the Custom Module called, "KB Basics - Start here!".


Side Modules

To create/modify a Side Module, go to the SitePref > Side Modules link on the left navigation bar. This will lead you to the Side Modules screen. The image below shows a Side Module and displays all the options in the Position dropdown menu.

This section allows you to define as many Side Modules as you would like for your KB site. Think about the Side Module as a container and as the Side Module Links as the contents in the container. You can specify the following about your modules:

  • Module name - Name of your Side Module.
  • Position - select one from the dropdown menu.
    • Top Left
    • Top Right
    • Link Bar - Between Logo and Search
    • BetweenLogoAndSearch
    • Link Bar - Under Logo and Search
    • MenuBarUnderSearch
    • Menu Bar Dropdown - Under Search
    • DropdownMenuUnderSearch

    • Internal - Check this box if you want the Side Module availability on the Internal Live site.
    • External - Check this box if you want the Side Module availability on the External Live site.
    • FullView - Check this box if you would like your Side Module to appear when viewing on a full desktop/ laptop screen view.
    • MobileView - Check this box if you would like your Side Module to appear when viewing on mobile devices.
    • Landing Page -  Side Module will appear on the homepage. (recommended)
    • DocPage -  Side Module will appear on any other page within your KB.
    • Order - Select what order the Content Modules will appear on your site. Please remember we start with 0, 1, 2..

    Click Update or Add to save changes.

    Side Modules on the Live sites: Expand and/or Collapse

    After creating the Side Modules that best suit your KB site, you will see downward pointing arrows on the upper right corner of each Side Module. The arrow indicates that the Side Module is collapsible and then expandable. The KB will remember what you choose to collapse and what you choose to keep expanded the next time you visit the live site.These downward pointing arrows/ chevrons are accessible to those accessing the KB via a screen reader by means of the keyboard, specifically the spacebar.


    Note: For information about adjusting your Side Module width, please see Document 30020 is unavailable at this time..

    Side Module Links

    Once you have created side modules for your KB site, you may add links to your modules. You can add and delete links at any time. You can set the following link attributes:

    • 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)
    • 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

    Populating the Side Modules of your Live Site via Side Module Links

    Include x.php in the Link URL field. The image below displays the contents of the Reference (acting as a "container") Side Module with four Side Module Links (acting as contents of the "container"): Acronyms, Contact Us, Frequently Asked Questions and Glossary.

    Displaying KB Delivered Features in the Side Modules of your Live Site via Side Module Links

    You may add x.php to the Link URL field in the Side Module Link.

    Display on the Internal and/or External Site

    • topics.php- Displays KB Site's Topics Map
    • topics_map_sidemodule

    • keywords.php- Displays all keywords and usage.
    • keywords_side_module

    • glossary.php- Displays all glossary items.
    • glossary_sidemodule

    Internal Only

    These features are limited to the Internal Sites only.

    Include x.php in the Link URL.

  • assessments.php- Displays Assessments which are available as well as Results of past Assessments.
  • assessments_side_module

  • dropbox.php- Displays the Dropbox.
  • dropbox_sideModule


See Also:




Keywords:modules side center footer links link custom facebook plug in plugin google analytics metrics measures IP Masking "content module" chevron   Doc ID:5787
Owner:Teresa A.Group:KB User's Guide
Created:2007-04-19 19:00 CDTUpdated:2016-08-29 16:33 CDT
Sites:KB User's Guide
Feedback:  1   0