Highlighting Hits In The Search Results
Overview
This example explains how to highlight the search hits within the page content of your E-Book.
Requirements
Instructions - Create a file called hilite.js and place in your source file. This file can be created using Notepad or any other plain text editor.
Please note: If using Notepad on a version of Windows prior to Windows XP, when you save in Notepad, be sure to place the file name in quotes on the Save As dialog box, i.e. "hilite.js" otherwise Notepad will add .txt to the end of the name (giving a file name of hilite.js.txt). If using Notepad on Windows XP, this workaround is not necessary.
hilite.js should contain the following:
- EITHER
If you use a CSS (cascading style sheet) for your e-book pages, you will need to add the following to your .css file:
OR
If you do not use a CSS file for your e-book pages, you will need to add the following to the <HEAD> ....</HEAD> section of every page in your e-book (if you forget to include a page, the hits won't be highlighted on that page).
CHANGING COLOR:
In both cases above, the #FFFF00 indicates the color to highlight hits (in this case, yellow). You can use a different color, for example from this color chart if you prefer.
- Now you need to add the following to the <BODY>... </BODY> section of every page.
- If you want the hits to be highlighted on the About or Table Contents pages, you'll need design your own pages, and select them as "My Own Page" (in Edit System Pages in the compiler), and also include the alterations described above, in both of these pages.
- If you want the hits to be shown on the search results page itself, you'll need to customize the search results page, and include the alterations described above, in your search template page.
- To summarize how this works:
- hilite.js is a JavaScript file that scans the current page based on the most recent search, and highlights words matching the most recent search criteria. When it finds a matching word, it sets the CSS style of the word to aebsehit.
- The <STYLE>...</STYLE> changes (or modifications to your CSS file), cause any areas of style aebsehit to be colored yellow (or your chosen color).
- You must include both elements on all pages. If you omit either element from any of the pages, the search hits will not be highlighted on that particular page.
- The Help which comes with version 5.0x, itself uses this feature to highlight search hits. A screen shot of this (after searching for password and security) is shown below.
Notes - This script has been tested with Activ E-Book Compiler versions 5.00 (5.00 is the latest version - beta release - at the time of writing). It is possible that changes might be required for e-books made with subsequent versions.
- This script will not work with versions of Activ E-Book Compiler prior to 5.00.
|
|
