KB User's Guide - General Info - Highlighting in the Live Sites and in the KB Admin Tools

This document will discuss how to highlight a single document within a list of document results either in the Live Sites or in the KB Admin Tools. We will also discuss how your search terms in the in the live document can be highlighted /or have the highlighting removed.

Highlighting that Occurs in the Live Sites

Hovering over a document title

A keyword search of a live KB site has yielded results of one or more documents.

In the example below, a search for TOC has yielded a set of 8 documents.

KB live site search results from the 'TOC' keyword

Place your cursor anywhere in the table and the document line will become highlighted in yellow. Clicking on the document title link opens the document.

Mouse hovering over a KB live site search result highlighting a specific document

Highlight Matching Terms button in the Live Site

If you were to click on a KB document from the Live Site, on the far right of the screen, you will see a button called Highlight search terms.

KB document showing the title, header, and highlight search term buttons on the right side

When you click on the Highlight search terms button, it will highlight the keyword(s) you entered. The example below demonstrates the highlighting of a single keyword that was entered in the search box, TOC .

KB document with the search keyword TOC highlighted throughout the document

Below is an example of multiple keywords entered into the search box leading to this document. The keywords were TOC, containers and headers. Notice how each word is highlighted in a different color.

document with multiple search keywords each highlighted in a different color

Click on the Remove highlighting button on the far right to remove highlighting.

Highlighting That Occurs within the KB Admin Tools

Whether you (have the correct permissions and) click on a link of the left navigation bar of the Document tab...

  • Use Docs from...
  • New Doc from...
  • Active
  • In Review
  • In Progress
  • Inactive
  • Trash
  • Expired
  • Expiring
  • Aging
  • Shared-out
  • Batch Update
  • Batch Transfer

...or use the filters prescribed in KB User's Guide - Documents Tab - Searching for Documents, you will likely see a table of one or more documents. Below is an example of a table of documents in the KB Admin Tools.

Table of documents within the KB admin tools

If you hover your cursor over a document in this table, it will be highlighted in yellow.

Table of documents with one result highlighted with a mouse cursor hovering over that result

Document Quickview

There are triangles pointing to the title of each document.

Table of documents highlighting sideways facing triangles next to each document title

If you click on the triangle pointing to the document title, you will see a "Quickview", or a complete view of the document's content without leaving the search results table. Simply click on the downward pointing arrow to close the Quickview. This Quickview feature is modified specially for those using screen readers, so these triangles can be engaged by a keyboard, specifically by the spacebar.

Expanded quick view in a table showing a downwards facing triangle and a document preview

The highlighting continues to highlight the document under your cursor, even if the QuickView is displaying content. KB Admins may disable this feature, please see Quickview.




Keywords:searching searched documents live site highlight high light matching terms keywords yellow Quickview quick view quickview quick view triangle   Doc ID:18580
Owner:Leah S.Group:KB User's Guide
Created:2011-05-16 18:00 CSTUpdated:2022-06-13 13:19 CST
Sites:KB User's Guide
Feedback:  0   0