SharePoint Search String Highlighter

Installation & User Guide

Copyright © 2005-2009 KWizCom Corporation. All rights reserved.

Company Headquarters KWizCom 148 Castle Rock Dr. Richmond Hill, Ontario L4C 5K5, Canada E-mail: info@KWizCom.com Web site: http://www.KWizCom.com Sales E-mail: sales@KWizCom.com Telephone: +1-905-370-0333

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

. 21 3 Copyright © 2005-2009 KWizCom corp................... 20 Version History _____________________________________________________ 20 Technical Support ............................. 10 User's Guide............................................ but it doesn’t have any effect _____________________________________________________ 18 I did something wrong and the Highlighter stopped working ________ 18 Do I have to install anything on my company's client-PCs? __________ 18 What happens with non-Office 2003 documents? ___________________ 19 Which MS Office versions are supported? ___________________________ 19 What about PDF documents? ________________________________________ 19 Version Release Notes ............. 10 Component Activation ......................................................... www.. 15 FAQ.................. and it is not highlighted _____________________ 17 How do I get the words to be highlighted in the documents I go to from the search? ____________________________________________________ 18 I changed some settings using the configuration utility.................................KWizCom....... 4 Overview _____________________________________________________________ 5 Key Features & Benefits _______________________________________________ 6 Installation ___________________________________________________________ 7 Software prerequisites ________________________________________________ 7 Installation Procedure ________________________________________________ 7 Post Installation ______________________________________________________ 8 Component Localization .Table of Contents Introduction ................................................................................................................................... 13 SharePoint Search String Highlighter Configuration Utility .......... both? ____________________________________ 17 Does it work on the new MOSS 2007? _______________________________ 17 I searched for a word........................................................................ 17 How do I use the SharePoint Search String Highlighter? ____________ 17 Does it work on SPS............................................ All rights reserved..................................... WSS.............................com ...................................................................

All rights reserved. www.txt. . . . When the user searches for a word. . evaluate and deploy this KWizCom product:        Product overview Installation guide Component localization Component activation User guide FAQ Version release notes 4 Copyright © 2005-2009 KWizCom corp.pdf.html.KWizCom.doc. The String Highlighter also marks the words that were searched for inside documents of various formats: .rtf. This document provides all the information needed to install.com .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). the string marker highlights the word in the search results if it is found in the result document’s description.

. .txt. . www.com . All rights reserved.html and more) 5 Copyright © 2005-2009 KWizCom corp.docx. 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.Overview SharePoint searches for it – You will Find it! You searched for some phrase.KWizCom.doc. .

KWizCom. . .doc. Configuration utility allows the system administrator to change the behavior of key functions like how the highlight looks.docx.0 Supports both WSS 3. minimum string length to highlight and more. Cross-browser support – IE. . .0 and MOSS 2007 Provides for free-text searches a more clear result page with highlighting of the searched phrase Supports highlighting the searched words in various document formats (PDF. www.htm and more).txt.Key Features & Benefits Feature KWizCom Search String Highlighter MOSS 2007/ WSS 3. Firefox and Google Chrome Multi-lingual (standard for all KWizCom components)          6 Copyright © 2005-2009 KWizCom corp. .com .rtf. All rights reserved.

All rights reserved. Microsoft Office SharePoint Server 2007 (MOSS 2007) Client PC Requirements 1. 4. Unzip the KWizCom SharePoint Search String Highlighter . Microsoft Office 2003/2007 Installation Procedure 1.com .msi file in order to begin the web installation. Log in to your SharePoint server as a local admin. 2. Microsoft Windows XP (SP2)/ Windows Vista 2.zip file on your SPS Windows 2003 Server. When the installation process is complete. Type iisreset 7 Copyright © 2005-2009 KWizCom corp.Installation Software prerequisites Server Requirements 1. 3. Microsoft Internet Explorer/Microsoft Internet Explorer 7 or Mozilla Firefox 2+ or Google Chrome 3. you need to restart the IIS Server:   Open the Command Prompt on your server. Microsoft Windows SharePoint Services 3.KWizCom. Double-click the .0 or 2. www.

All rights reserved.Post Installation 1. Please review the next sections for further details about component localization and activation.KWizCom. 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. 8 Copyright © 2005-2009 KWizCom corp. 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). After completion of the installation. Activate SharePoint Search String Highlighter This utility enables you (the SharePoint Administrator) to activate the downloaded evaluation version. 2. Before users can use the new offline feature added to your existing SharePoint sites. SharePoint Search String Highlighter User Guide Link to this user guide document.com . 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. www.

www. and then click "OK". and adding the SharePoint server's URL to the Trusted sites list. Set the SharePoint server as a Trusted Site.com . This is done be selecting "Tools->Internet Options->Security". 9 Copyright © 2005-2009 KWizCom corp.KWizCom. On the "Internet Options" dialog click the "Delete Files" button. All rights reserved.

Component Localization SharePoint Search String Highlighter is multi-lingual and requires no localization actions. Component Activation KWizCom components are available for evaluation prior to purchase. Order The component on the KWizCom website – www.com 2.KWizCom. you will need to follow the following steps: 1. Once you decide to order a KWizCom component.KWizCom. Send us the installed evaluation version's product Code (you will see the product Code on the "About" product page: 10 Copyright © 2005-2009 KWizCom corp. All rights reserved. It works on SharePoint Portal Server regardless of the portal's language. An evaluation version for each KWizCom component contains all features of the component's production version. This way you can try our components and verify that they indeed meet your needs. www.com . The only difference is that an evaluation version is time-limited. and will operate for a period of one month.

All rights reserved. Activate your installed evaluation version click Start -> All Programs -> KWizCom -> Activate SharePoint Search String Highlighter 11 Copyright © 2005-2009 KWizCom corp.KWizCom. www. Get the component activation key – this key will be sent to you by email once your order is processed.Product Code Please use the Activation Request web form. 4.com . 3. on KWizCom web site to send us your product code.

12 Copyright © 2005-2009 KWizCom corp. All rights reserved. and press Activate Product button.KWizCom.com . That's it! Your product is fully operational. www.Copy the received activation key into Activation Code text field.

the search results page will appear a bit different. as in the following example: User searches for the word "kwizcom" The searched string is highlighted in the search results 13 Copyright © 2005-2009 KWizCom corp. Once the component is installed. www.KWizCom.. All rights reserved.User's Guide Well.there's nothing much really to explain. users will notice that when they search the SharePoint portal or a SharePoint team site.com .

14 Copyright © 2005-2009 KWizCom corp. www.User clicks a document link. All rights reserved.KWizCom. The searched string is also marked inside the document.com .

It is not recommended to change the default setting.com . All rights reserved. www.SharePoint Search String Highlighter Configuration Utility The configuration utility is a Windows Application that is installed on the SharePoint server as a part of the component installation.  Set the list of ignored characters. 15 Copyright © 2005-2009 KWizCom corp. These characters will not be highlighted in the search results. This utility allows you to change the Highlighter's behavior.KWizCom. Using this utility you can:  Set the HTML code that is used to highlight (use this to change the color 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 file extensions whose links will be modified to be opened with Microsoft Word. www.com . and enable this only to debug.   Define if highlighting should be done inside documents.KWizCom. All rights reserved.   Set the minimum number of characters for a word to be highlighted.txt). Set if errors in the application will be shown to user in message boxes. The administrator can choose not to show the errors. This means that you can also cause the highlighter mark search results in non-Office documents such as text files (. Define if highlighting should be done in the SharePoint search results page (You may not want it to be active on MOSS 2007. 16 Copyright © 2005-2009 KWizCom corp. since MOSS 2007 already displays the searched string in bold format).

Please note that special characters are ignored. The words you write will be highlighted in the search results. both? SharePoint Search String Highlighter supports both SPS and WSS. and it is not 1.com .0. www. Try clearing your Microsoft Internet Explorer 6 cache. Make sure the word you searched for is more than 2 characters long. Does it work on the new MOSS 2007? Yes. 17 Copyright © 2005-2009 KWizCom corp.0 and MOSS 2007/WSS 3. All rights reserved. Try running a simpler search (for example “sharepoint” or “page”) and verify that the SharePoint Search String Highlighter works. Does it work on SPS. WSS. 3. 2. I searched highlighted for a word. If your query contained special characters such as ! or @ (for example) it may be the cause of the problem. 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.FAQ How do I use the SharePoint Search String Highlighter? Simply open your SharePoint portal search page and write some words to search for. SharePoint Search String Highlighter V2 supports both SharePoint 2003/WSS 2.KWizCom.

I changed some settings using the configuration utility. www. Once you install it on your SharePoint server.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. All rights reserved. all users can start using it.KWizCom. I did something wrong and the Highlighter stopped working To reset the highlighter to its starting state.com . For this to work. open the configuration utility (Start>Program>KWizCom> “Reset to Defaults” SharePoint Search String Highlighter> SharePoint Search String Highlighter Configuration Utility) and press Do I have to install company's client-PCs? anything on my No. KWizCom SharePoint Search String Highlighter is a server installation. 18 Copyright © 2005-2009 KWizCom corp. but it doesn’t have any effect 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. you must have the portal registered as a safe site in the Internet Explorer options in the client machines.

PDF files are also supported.txt). Which MS Office versions are supported? Office 2003 and Office 2007. What about PDF documents? .pdf file from the search results page.rtf. So. All rights reserved. showing all searched phrase occurrences.com . 19 Copyright © 2005-2009 KWizCom corp.doc" that can be viewed using MS Word (for example: . for the SharePoint Search String Highlighter to mark non-MS Office files you should define these types in the configuration utility.What happens documents? with non-Office 2003 The document marking is done using Office Word 2003 API. it'll be opened in Search format. www.KWizCom. However. . When you click a . there are additional document types besides ".

5.2.?/ in your search query. November-20-2007 1. It is recommended that you do not change the settings in the configuration utility and you should avoid using either of the following characters: !@#$%^&*()-=_+{}[]:.00-1 1.01-1 1.00.6. 20 Copyright © 2005-2009 KWizCom corp.5.4.01-3 1.5.com . Fix Bug: Resolve ATL install problem Support highlighting in WSS search results page Support .00-1 1. searching for “hello ) ) world” will only highlight the word “hello” and not the word “world”.2.2.Version Release Notes Primary Software Version Base version Release date Module Configuration Utility 3.PDF files Writing the combination closing parenthesis + space + closing parenthesis will stop the application from recognizing any words after that combination.0-1 Fix bug: Sometimes there's a Javascript code load error in run time.’”<>..5. For example.0.00 Version History CR # 51 52 53 1.0-2 Some special characters cause the highlighter not to function properly.0-1 1. Cancel highlighting in the search results information bar highlight in WORD documents without enabling change tracking Add support for MOSS 2007 Cancel the 15 days expired message Fix bug: User doesn't see highlighting when he has the white default highlight color in MS word.0 2.0.01-2 Description Highlight whole words only and not part of words.00 February-20-2009 Sub-Modules Version 2.1. www.00. 1. Now when the user open the word he has yellow highlight color as default Version 3.KWizCom. February-20-2009 Version 2.1.0-2 1.4. All rights reserved.

including:   Answers to frequently asked questions (FAQ's) about our products – usability and technical questions. 21 Copyright © 2005-2009 KWizCom corp. which provide you with bug fixes and new features.com contains the most updated valuable information. please fill in our support web form on our web site For more information on technical support.com .KWizCom. Product updates. All rights reserved. please review our support programs page.KWizCom. The Web Form For technical support through the Internet. www.Technical Support You can obtain technical support using any of the following methods: The KWizCom Web site The KWizCom website at www.