1

We have been using PDF file as a part of help docs in our vb.net desktop application. In PDF, we would traverse to the certain chapter in the PDF doc.

Now we have decided to use MadCap Flare as documentation tool. We have a menu item in vb.net form for documentation. On click of the link, we want to open the specific chapter of the Flare documentation.

help-info.de
  • 6,695
  • 16
  • 39
  • 41
Kapil Neupane
  • 21
  • 2
  • Is your documentation generated by MadCap Flare like web-based help? (HTML based, URL, Internet or Intranet)? – help-info.de Oct 17 '17 at 09:04
  • Yes, document is generated by MadCap Flare – Kapil Neupane Oct 17 '17 at 09:22
  • Yes I know - but my question was web-based and HTML-based on a server? – help-info.de Oct 17 '17 at 09:23
  • Welcome to Stack Overflow! Please go through the [tour](http://stackoverflow.com/tour), the [help center](http://stackoverflow.com/help) and the [how to ask a good question](http://stackoverflow.com/help/how-to-ask) sections to see how this site works and to help you improve your current and future questions, which can help you get better answers. – help-info.de Oct 17 '17 at 09:30
  • It is HTML based ! – Kapil Neupane Oct 17 '17 at 09:40

1 Answers1

0

You know managing content with single-source XML authoring is possible when using MapCad Flare (I'm not using Flare!). You can publish content to an increasing number of formats including HTML5, WebHelp, PDF, Word, XHTML, Clean XHTML, EPUB, DITA and more by MapCad Flare.

So, you may continue using PDF and the way connecting your vb.net desktop application help.

Using HTML based topics maybe another solution for your needs by creating Help for a form, a dialog or control with HTML files (See also: Help for controls with VB .NET).

Properties to display help (HTML file - local)

Activate the hlpProvider component hlpHtmlLocal and set the HelpNameSpace property of hlpHtmlLocal to the file name you want to work with.

enter image description here

We open a local HTML file with the dialog using the little button to the right.

The next step is to set the HelpNavigator property of a control (e.g. button) to a value of the HelpNavigator enumeration (see table below). Here we use Topic.

enter image description here

When the application is running click the HelpButton to enable "What's this .." Help. The cursor changes. Now click the button or press F1 when the button has focus. This will open the single HTML file in your browser.

It seems you can't use anchor names to jump to a specific part of your HTML file.

Properties to display help (HTML file - Server http://..)

Activate the hlpProvider component and set the HelpNameSpace property of hlpHtmlServer to the file name you want to work with. Here we use a http:// address of a single HTML file. If you provide the file on your company server, you don't have to update the help file with the customer.

enter image description here

The next step is to set the HelpNavigator property of a control (e.g. button) to a value of the HelpNavigator enumaration (see table below). Here we use Topic. Then we set the HelpKeyword on hlpHtmlSever property to e.g. "anchor3". Don't add a leading "#". Leave it empty if you want to open a HTML file without anchors. The Help Handles cmdControl2.Click Dim sHelpFile As String Dim sStartupPath As String '--- Initialize context-sensitive help --- Keyword property provides the key information to retrieve the help associated with the control.

enter image description here

When the application is running click the HelpButton to enable "What's this .." Help. The cursor changes. Now click the button or press F1 when the button has focus. This will open the single HTML file over the Internet in your browser.

help-info.de
  • 6,695
  • 16
  • 39
  • 41