HTML Help Builder
5.32 detailed search feature
Gravatar is a globally recognized avatar based on your email address. 5.32 detailed search feature
  Richard Kaye
  All
  Jan 13, 2021 @ 06:00am

Hi Rick,

Just installed 5.32 and compiled my help project. When I reviewed it I'm not seeing the updated search option. I did run the update template process but maybe I messed up something when I merged my custom changes. (Those are basically front-end stuff like using my logo and changing the feedback links.) Any thoughts on how I can determine what's missing?

TIA

Gravatar is a globally recognized avatar based on your email address. re: 5.32 detailed search feature
  Rick Strahl
  Richard Kaye
  Jan 13, 2021 @ 12:24pm

You need to:

  • Update Templates
  • Make sure you use one of the stock templates
  • Build your Project
  • Re-Deploy

Note this only works with the stock templates which get updated when you Update Templates - custom templates you would have to manually update.

+++ Rick ---

Gravatar is a globally recognized avatar based on your email address. re: 5.32 detailed search feature
  Richard Kaye
  Richard Kaye
  Jan 13, 2021 @ 02:14pm

I do use the stock layout template which I modify directly to make the minor changes mentioned. I then merged the bits I needed from the backup that WWHB creates into the updated layout template. I noticed some new script includes in the updated template, and I did not merge or overwrite any code in that section. I then ran the Build HTML Output process, zipped the files and pushed to my dev and staging environments as usual. Took a deep breath. Cleared my cache... 😃

Gravatar is a globally recognized avatar based on your email address. re: 5.32 detailed search feature
  Richard Kaye
  Richard Kaye
  Jan 13, 2021 @ 02:25pm

OK. Maybe something went sideways when I did my first build after the update. I just built it again and I'm seeing the new search dropdown. Nothing to see here. Move along... 😉

Gravatar is a globally recognized avatar based on your email address. re: 5.32 detailed search feature
  Richard Kaye
  Richard Kaye
  Jan 13, 2021 @ 02:34pm

Well the front end is there but it doesn't seem to do what I expect when I switch to detailed mode. I'm going to go review your release notes to verify what I should be seeing.

Simple search seems right:

But Detailed search is showing no results?

Gravatar is a globally recognized avatar based on your email address. re: 5.32 detailed search feature
  Rick Strahl
  Richard Kaye
  Jan 14, 2021 @ 01:44pm

Detailed search searches content for words. So in most cases you're going to get more results than a file name search...

The results will be weighted by number of occurrences, document placement etc.

Go check out the Web Connection docs and play around with it there, you should be able to get a feel for how the two approaches work.

But all that said - your search results shouldn't look like that. The list should be a flat list now that only shows the actual topic matched, not the tree:

Make sure you do a full page refresh...

+++ Rick ---

+++ Rick ---

Gravatar is a globally recognized avatar based on your email address. re: 5.32 detailed search feature
  Richard Kaye
  Rick Strahl
  Jan 14, 2021 @ 01:51pm

Your screenshot shows the result for detailed in a list. Mine is still showing a treeview? Also, I'm pretty sure the word I searched for wasn't in all the topics shown.

Gravatar is a globally recognized avatar based on your email address. re: 5.32 detailed search feature
  Rick Strahl
  Richard Kaye
  Jan 14, 2021 @ 02:25pm

Yes it shouldn't be a tree view. If it's a tree it's not working right - that's the old code. Check for errors in the DevTools and as I said make sure you have the latest wwhelp.js and it's refreshed fully. It's possible the HTML is refreshed but the old code is running? (Ctrl-Shift-R)

+++ Rick ---

Gravatar is a globally recognized avatar based on your email address. re: 5.32 detailed search feature
  Richard Kaye
  Rick Strahl
  Jan 14, 2021 @ 02:33pm

Thanks! That's the kind of tip I needed. (I'm a desktop guy...)

From the console:

So I seem to be missing a js file. Don't know if that's me screwing up something or the build and zip needs a tweak?

Gravatar is a globally recognized avatar based on your email address. re: 5.32 detailed search feature
  Richard Kaye
  Rick Strahl
  Jan 14, 2021 @ 02:55pm

I searched my local disk for that file and it doesn't seem to be here.

Gravatar is a globally recognized avatar based on your email address. re: 5.32 detailed search feature
  Rick Strahl
  Richard Kaye
  Jan 14, 2021 @ 03:06pm

Yes you need to rebuild the project, so that this file get generated. That's the search index and you need to make sure that this gets published (if you're not using the built-in publish feature which will automaitcally push it up).

+++ Rick ---

Gravatar is a globally recognized avatar based on your email address. re: 5.32 detailed search feature
  Richard Kaye
  Rick Strahl
  Jan 14, 2021 @ 03:35pm

I'm not running an FTP service on the servers where the help is deployed so I build HTML for web only, pick my topics and then click finish. I then use the Zip files for web option. Finally, I unpack the zip file to the various servers where I have the help deployed (my local dev system, a staging server in AWS, my production server in AWS).

I just tried the local web preview from the build output form and it works as it should. Further spelunking in the file system where the project is located (not my local machine) reveals the missing js file. However, it does not appear to be included in the zip file. I will manually copy when I rebuild but it would be lovely if it could be included in the zip.

Thanks!

Gravatar is a globally recognized avatar based on your email address. re: 5.32 detailed search feature
  Rick Strahl
  Richard Kaye
  Jan 14, 2021 @ 07:03pm

Yeah that's a bug. The file should be included in the file copy and zip package.

Would you mind adding an issue over on the Help Builder Github site?

+++ Rick ---

Gravatar is a globally recognized avatar based on your email address. re: 5.32 detailed search feature
  Richard Kaye
  Rick Strahl
  Jan 15, 2021 @ 05:10am

Thanks for the gentle reminder to follow the process... Done.

© 1996-2021