KWizCom Share Point Search String Highlighter User Guide v3.0

8/2/2019 KWizCom Share Point Search String Highlighter User Guide v3.0

1/21

SharePoint Search StringHighlighter

Installation & User Guide


2/21

Copyright 2005-2009 KWizCom corp. All rights reserved. www.KWizCom.com

2

Copyright 2005-2009 KWizCom Corporation. All rights reserved.

Company Headquarters

KWizCom

148 Castle Rock Dr.

Richmond Hill, Ontario

L4C 5K5, Canada

E-mail: [email protected]

Web site:http://www.KWizCom.com

Sales

E-mail: [email protected]

Telephone: +1-905-370-0333
http://www.kwizcom.com/http://www.kwizcom.com/http://www.kwizcom.com/http://www.kwizcom.com/


3/21


3

Table of ContentsIntroduction ............................................................................................... 4

Overview _____________________________________________________________5Key Features & Benefits_______________________________________________6Installation ___________________________________________________________7Software prerequisites________________________________________________7Installation Procedure ________________________________________________7Post Installation

______________________________________________________

8Component Localization....................................................................... 10Component Activation .......................................................................... 10User's Guide.............................................................................................. 13SharePoint Search String Highlighter Configuration Utility...15FAQ............................................................................................................... 17

How do I use the SharePoint Search String Highlighter?____________

17Does it work on SPS, WSS, both?____________________________________17Does it work on the new MOSS 2007? _______________________________17I searched for a word, and it is not highlighted _____________________17How do I get the words to be highlighted in the documents I go to

from the search? ____________________________________________________18I changed some settings using the configuration utility, but it doesnthave any effect _____________________________________________________18I did something wrong and the Highlighter stopped working ________ 18Do I have to install anything on my company's client-PCs?

__________

18What happens with non-Office 2003 documents? ___________________19Which MS Office versions are supported? ___________________________19What about PDF documents?________________________________________19

Version Release Notes .......................................................................... 20Version History _____________________________________________________20

Technical Support................................................................................... 21


4/21


4

Introduction

KWizCom SharePoint Search String Highlighter is an add-on to Microsoft

SharePoint that adds word highlighting to the default search page of the

SharePoint portal (SPS 2003/MOSS 2007) and SharePoint team sites

(WSS 2003/2007). When the user searches for a word, the string marker

highlights the word in the search results if it is found in the result

documents description.

The String Highlighter also marks the words that were searched for inside

documents of various formats: .doc, .rtf, .txt, .html, .pdf.

This document provides all the information needed to install, evaluate and

deploy this KWizCom product:

Product overview Installation guide Component localization Component activation User guide FAQ Version release notes


5/21


5

Overview

SharePoint searches for it You will Find it!

You searched for some phrase, you got several documents returned in

SharePoint's search results page you click one of the documents and

WHERE is that phrase you were looking for in the document??

KWizCom SharePoint Search String Highlighter is an add-on to

Microsoft SharePoint that adds word highlighting to the search results

page of the SharePoint (MOSS/WSS) and more important it highlights

the searched phrase inside the found documents!

(PDF, .doc, .docx. .txt. .html and more)


6/21


6

Key Features & BenefitsFeature KWizCom

Search String

Highlighter

MOSS 2007/

WSS 3.0

Supports both WSS 3.0 and MOSS 2007 Provides for free-text searches a more clearresult page with highlighting of the searchedphrase

Supports highlighting the searched words invarious document formats (PDF, .doc, .docx,.rtf, .txt, .htm and more).

Configuration utility allows the systemadministrator to change the behavior of keyfunctions like how the highlight looks,minimum string length to highlight and more.

Cross-browser support IE, Firefox andGoogle Chrome

Multi-lingual (standard for all KWizComcomponents)


7/21


7

InstallationSoftware prerequisites

Server Requirements

1. Microsoft Windows SharePoint Services 3.0or

2. Microsoft Office SharePoint Server 2007 (MOSS 2007)

Client PC Requirements

1. Microsoft Windows XP (SP2)/ Windows Vista2. Microsoft Internet Explorer/Microsoft Internet Explorer 7

or Mozilla Firefox 2+ or Google Chrome

3. Microsoft Office 2003/2007

Installation Procedure

1. Log in to your SharePoint server as a local admin.2. Unzip the KWizCom SharePoint Search String Highlighter .zip file on

your SPS Windows 2003 Server.

3. Double-click the .msi file in order to begin the web installation.4. When the installation process is complete, you need to restart the IIS

Server:

Open the Command Prompt on your server. Type iisreset


8/21


8

Post Installation1. After completion of the installation, you will see a new KWizCom entry

in Windows Start -> All Programs-> KWizCom containing 4

programs:

About SharePoint Search String Highlighter

Display general information about the component.

Activate SharePoint Search String Highlighter

This utility enables you (the SharePoint Administrator) to activate the

downloaded evaluation version.

SharePoint Search String Highlighter Configuration Utility

this utility enables you (the SharePoint Administrator) configure the

highlighter module preferences (please review details in the "User

guide" section).

SharePoint Search String Highlighter User Guide

Link to this user guide document.

Please review the next sections for further details about component

localization and activation.

2. Before users can use the new offline feature added to your existingSharePoint sites, they will have to configure the following Internet

Explorer settings:

Empty Internet Explorer's cache.This is done by selecting "Tools->Internet Options" on the Internet

Explorer menu bar.


9/21


9

Set the SharePoint server as a Trusted Site.This is done be selecting "Tools->Internet Options->Security", and

adding the SharePoint server's URL to the Trusted sites list.

On the "Internet Options" dialog click the "Delete Files" button, and

then click "OK".


10/21


10

Component LocalizationSharePoint Search String Highlighter is multi-lingual and requires no

localization actions. It works on SharePoint Portal Server regardless of the

portal's language.

Component Activation

KWizCom components are available for evaluation prior to purchase. This

way you can try our components and verify that they indeed meet your

needs. An evaluation version for each KWizCom component contains all

features of the component's production version. The only difference is that

an evaluation version is time-limited, and will operate for a period of one

month.

Once you decide to order a KWizCom component, you will need to follow

the following steps:

1. Order The component on the KWizCom website www.KWizCom.com

2. Send us the installed evaluation version'sproduct Code (you willsee the product Code on the "About" product page:
http://www.kwizcom.com/http://www.kwizcom.com/http://www.kwizcom.com/


11/21


11

Please use theActivation Request web form, on KWizCom web site

to send us your product code.

3. Get the component activation key this key will be sent to you byemail once your order is processed.

4. Activate your installed evaluation version -click Start -> All Programs -> KWizCom ->

Activate SharePoint Search String Highlighter

Product Code
http://www.kwizcom.com/ProductReg.asphttp://www.kwizcom.com/ProductReg.asphttp://www.kwizcom.com/ProductReg.asphttp://www.kwizcom.com/ProductReg.asp


12/21


12

Copy the received activation key into Activation Code text field,

and press Activate Product button.

That's it! Your product is fully operational.


13/21


13

User's Guide

Well..there's nothing much really to explain. Once the component is

installed, users will notice that when they search the SharePoint portal or

a SharePoint team site, the search results page will appear a bit different,

as in the following example:

User searches for theword "kwizcom"

The searched string ishighlighted in thesearch results


14/21


14

User clicks a documentlink.

The searched string isalso marked inside the

document.


15/21


15

SharePoint Search StringHighlighter Configuration Utility

The configuration utility is a Windows Application that is installed on the

SharePoint server as a part of the component installation.

This utility allows you to change the Highlighter's behavior.

Using this utility you can:

Set the HTML code that is used to highlight (use this to change thecolor or background color of the highlight)REMARK: You can only define the highlighting color in

SharePoint search result page. In order to set highlighting

color inside documents you have to define it in MS WORD /

ADOBE Reader.

Set the list of ignored characters. These characters will not behighlighted in the search results. It is not recommended to change

the default setting.


16/21


16

Set the list of file extensions whose links will be modified to beopened with Microsoft Word. This means that you can also cause

the highlighter mark search results in non-Office documents such as

text files (.txt).

Set the minimum number of characters for a word to behighlighted.

Define if highlighting should be done in the SharePoint searchresults page (You may not want it to be active on MOSS 2007,

since MOSS 2007 already displays the searched string in bold

format).

Define if highlighting should be done inside documents. Set if errors in the application will be shown to user in message

boxes. The administrator can choose not to show the errors, and

enable this only to debug.


17/21


17

FAQ

How do I use the SharePoint Search StringHighlighter?

Simply open your SharePoint portal search page and write some words to

search for. The words you write will be highlighted in the search results.

Does it work on SPS, WSS, both?

SharePoint Search String Highlighter supports both SPS and WSS.

Does it work on the new MOSS 2007?

Yes. SharePoint Search String Highlighter V2 supports both SharePoint

2003/WSS 2.0 and MOSS 2007/WSS 3.0.

I searched for a word, and it is nothighlighted

1. Make sure the word you searched for is more than 2 characters long.

2. Please note that special characters are ignored. If your query contained

special characters such as ! or @ (for example) it may be the cause of

the problem. Try running a simpler search (for example sharepoint or

page) and verify that the SharePoint Search String Highlighter works.

3. Try clearing your Microsoft Internet Explorer 6 cache. This is done by

closing all instances (windows) of Microsoft Internet Explorer and then

opening Control Panel>Internet Options and on the General tab

pressing the Delete Files button.


18/21


18

How do I get the words to be highlighted in

the documents I go to from the search?

The SharePoint Search String Highlighter supports highlighting the

searched words in Microsoft Word documents opened from the search

page. For this to work, you must have the portal registered as a safe site

in the Internet Explorer options in the client machines.

I changed some settings using theconfiguration utility, but it doesnt have anyeffect

Try clearing your Microsoft Internet Explorer 6 cache. This is done by

closing all instances (windows) of Microsoft Internet Explorer and then

opening Control Panel>Internet Options and on the General tab pressing

the Delete Files button.

I did something wrong and the Highlighter

stopped working

To reset the highlighter to its starting state, open the configuration utility

(Start>Program>KWizCom> SharePoint Search String Highlighter>

SharePoint Search String Highlighter Configuration Utility) and press

Reset to Defaults

Do I have to install anything on mycompany's client-PCs?

No. KWizCom SharePoint Search String Highlighteris a server installation.

Once you install it on your SharePoint server, all users can start using it.


19/21


19

What happens with non-Office 2003

documents?

The document marking is done using Office Word 2003 API. However,

there are additional document types besides ".doc" that can be viewed

using MS Word (for example: .rtf, .txt).

So, for the SharePoint Search String Highlighter to mark non-MS Office

files you should define these types in the configuration utility.

Which MS Office versions are supported?

Office 2003 and Office 2007.

What about PDF documents?

.PDF files are also supported. When you click a .pdf file from the search

results page, it'll be opened in Search format, showing all searched phrase

occurrences.


20/21


20

Version Release Notes

Primary Software

Version 3.0.0

Base version 2.1.00

Release date February-20-2009

Sub-Modules

Module Version

Configuration Utility 2.2.00

Version History

CR # Description

Version 3.0.00, February-20-2009

51 Highlight whole words only and not part of words.

52 Cancel highlighting in the search results information bar

53 highlight in WORD documents without enabling change tracking

Version 2.1.00, November-20-2007

1.6.00-1 Add support for MOSS 2007

1.5.01-1 Cancel the 15 days expired message

1.5.01-2 Fix bug: User doesn't see highlighting when he has the white default

highlight color in MS word.Now when the user open the word he has yellow highlight color as

default

1.5.01-3 Fix bug: Sometimes there's a Javascript code load error in run time.

1.5.00-1 Fix Bug: Resolve ATL install problem

1.4.0-1 Support highlighting in WSS search results page1.4.0-2 Support .PDF files

1.2.0-1 Writing the combination closing parenthesis + space + closing

parenthesis will stop the application from recognizing any words after

that combination. For example, searching forhello ) ) worldwill only

highlight the word hello and not the word world.

1.2.0-2 Some special characters cause the highlighter not to function properly.

It is recommended that you do not change the settings in the

configuration utility and you should avoid using either of the following

characters: !@#$%^&*()-=_+{}[]:;,.?/ in your search query.


21/21

21

Technical Support

You can obtain technical support using any of the following methods:

The KWizCom Web site

The KWizCom website atwww.KWizCom.com contains the most updated

valuable information, including:

Answers to frequently asked questions (FAQ's) about our products usability and technical questions.

Product updates, which provide you with bug fixes and newfeatures.

The Web Form

For technical support through the Internet, please fill in our support web

form on our web site

For more information on technical support, please review oursupport

programs page.
http://www.kwizcom.com/http://www.kwizcom.com/http://www.kwizcom.com/http://www.kwizcom.com/ProductSupport.asphttp://www.kwizcom.com/ProductSupport.asphttp://www.kwizcom.com/ProductSupport.asphttp://www.kwizcom.com/ContentPage.asp?PageId=57http://www.kwizcom.com/ContentPage.asp?PageId=57http://www.kwizcom.com/ContentPage.asp?PageId=57http://www.kwizcom.com/ContentPage.asp?PageId=57http://www.kwizcom.com/ContentPage.asp?PageId=57http://www.kwizcom.com/ContentPage.asp?PageId=57http://www.kwizcom.com/ContentPage.asp?PageId=57http://www.kwizcom.com/ProductSupport.asphttp://www.kwizcom.com/ProductSupport.asphttp://www.kwizcom.com/ProductSupport.asphttp://www.kwizcom.com/

Documents

KWizCom Share Point Search String Highlighter User Guide v3.0