HTML Help Builder
Help file confusion
Gravatar is a globally recognized avatar based on your email address. Help file confusion
  yag
  All
  Apr 12, 2019 @ 02:49pm

Hey Rick,

I have my help file configured in wwHelp. I try Building the Output (to a folder or to a local web, to test) and I get strange results.

  • Keywords has the table of contents
  • Table of contents has the search topic headers
  • Frames shows index.htm on the right, and nothing on the left.

When I integrate it into our website, what do I point to? I'd love to show the frames - but I need the TOC to show up.

Gravatar is a globally recognized avatar based on your email address. re: Help file confusion
  Rick Strahl
  yag
  Apr 12, 2019 @ 04:42pm

The help file generated is a self-contained site so there should be nothing special to do.

However you cannot open index.html from the file system because it needs a Web server to run. So the way you can do this is run Help Builder and go to Tools -> Open Html Project in Browser which runs an internal Web Server.

There are other ways using the Help Builder Command line or any other local HTTP server (like NPM installed http-server).

More info in the docs:

Viewing Web Html Output locally

+++ Rick ---

Gravatar is a globally recognized avatar based on your email address. re: Help file confusion
  Rick Strahl
  yag
  Apr 14, 2019 @ 02:10am

On your WebSite you just copy all the HTML (plus images and templates) into a folder and it should just work if you navigate to:

https://yoursite.com/docs

or more explicitly:

https://yoursite.com/docs/index.html

I assume you were trying to check this out locally by running from disk which - as mentioned in the last message - doesn't work due to the script requirements. You need to run with a Web server. But on your site it should just work assuming you have all the resources copied over.

Easiest way to package is to create an output zip file, upload that and unzip, or if your site is configured for FTP directly upload via FTP. You can also update individual topics via FTP.

+++ Rick ---

Gravatar is a globally recognized avatar based on your email address. re: Help file confusion
  yag
  Rick Strahl
  Apr 14, 2019 @ 11:18am

Sorry - I wasn't clear. I am running it from a website (through Tools and also thru a local server). I don't get the "chrome" part (the treeview on the left) to allow for navigation. The way it's working now, I'll have to put a See Also: for every Topic in every Topic.

Gravatar is a globally recognized avatar based on your email address. re: Help file confusion
  Rick Strahl
  yag
  Apr 14, 2019 @ 12:48pm

Ping me on Skype later, or resend your help project (with templates and styling) and I can take a look.

I wonder if your templates are out of whack? And you did build the project right?

+++ Rick ---

Gravatar is a globally recognized avatar based on your email address. re: Help file confusion
  yag
  Rick Strahl
  Apr 14, 2019 @ 01:33pm

I did build the project. I'll shoot you the project to see if you can find anything. 😃

Thanks, Rick.

yag

© 1996-2019