KB User's Guide - SitePref Tab - Customizing Your Site's Look and Feel

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

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

KB Site Components

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

TouroftheKB2016_labels.png

Content Modules

There are three Content Modules that come ready for use (e.g. "delivered"):

  1. News and Announcements - Displays news content.
  2. Top Documents of the Week - Displays documents that have been most recently viewed.
  3. Most Recently Updated Docs - Displays documents most recently edited and set to the status of Active.

The image below shows the three delivered Content Modules and their subsequent fields in the KB Admin Tools.  Content Modules display document and news item links on the Live site(s). The Limit field has a dropdown menu which allows you to display a list of 5 items and 50 items.

 3 delivered content modules

Below are the descriptions to the Content Module Attributes:

The image below shows two Content Modules, a custom content module, "Welcome", and a delivered content module, "News and Announcements".

example of a delivered content module on a live site

 

Modify a Delivered Content Module

Update the name of a delivered Content Module by:

navigating to the SitePref tab > Content Modules link > Content Modules screen.

Put your cursor in the Module name field and update it to something more relevant to your users. In the image below, a red arrow is pointing to the editable Module name field. Enter text that is more specific to your purposes, for example: "Atmospheric and Oceanic Sciences News".

Be sure to click on the Update button on the bottom of the screen to save your work.

 

Create a Custom Content Module

You may create your own Custom Content Module.

Use Cases:

Step One:

a) Create a document that has all the information you would like to display in the Custom Content Module. This document can have styled text, images, resource links, tables, Google Calendars..anything you can see on any other KB document. While a document has four required fields, only the Body field of this document will display in the Custom Content Module.

b) Set the Priority field of this document to Exclude from search. This will prevent users on the Live site from accidentally "discovering it" (via search keyword search) among your documents / prevent potential confusion.

c) The SiteAccess document setting must be set to the appropriate KB Site, Internal and/ or External. If you set the document to only the Internal site, the Custom Content Module will not display at all on your External Live site, even if you click on the Internal check box Custom Content Module attribute.

d) Set the document status to Active and write down the document ID number for future reference.

Step Two:

Navigate to the SitePref tab> Content Modules link. This will lead you to the Content Modules screen.

create your own custom content module using this series of fields

Step Three:

Enter a Module name, determine which live site to display your Custom Content Module and the order it will appear among your other content modules. Enter the document ID referenced above in Step One in the DocID(s)/ URL field.

Step Four:

Click on the Add button on the far right of the Add a custom content module section.

Step Five:

Scroll to the bottom of the Content Modules screen and click the Update button to save your work.

Custom Modules on the Live Site

Example: The image below, shows a Custom Content Module and a delivered Content Module :

a) Move to Production and Meetings custom content module
Displays the content of a single KB document, the Move to Production and Meetings shows an embedded Google Calendar whose code/content resides in a single KB document.

c) News and Announcements delivered content module
News and Announcements is a delivered Content Module displaying 2 News items
 

an example of live site sontent modules

 

Display Content of a Single KB Document

Create a KB document with the content (e.g. images, links, tables, Google Calendar Code) you want displayed in your Custom Content Module. Enter that single document ID number in the DocID(s)/URL field to display the body of that document. In the image below, the document ID 36843 is circled in red.

 

 

 

Display Custom List of Documents

 

You may display a specific list of documents in the order of your choosing. In the Doc ID(s)/URL field, place a comma delimited list of the documents your would like displayed. In the image below, you will see three comma delimited document IDs for the Custom Module called, "Meteor Data".

 

 

Content Modules: 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/expand and remember the next time you visit your Live site.

 

 

 


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 "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.



Side Modules: A Description

There are seven options for Admins to apply "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 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.



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. 

Visibility Settings

How to Create a Side Module

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


How to Create a Side Module Link

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

 

| KB User's Guide - SitePref Tab |

See Also: