Create a topic link that includes nav frames in webhelp?

This forum is for all Flare issues related to the HTML5, WebHelp, WebHelp Plus, and Adobe Air Targets
Post Reply
techwriterkai
Propeller Head
Posts: 66
Joined: Wed Oct 12, 2011 5:27 am
Location: @techwriterkai
Contact:

Create a topic link that includes nav frames in webhelp?

Post by techwriterkai »

Hi, I'm looking for a way to create a link to any topic in a web help, mail this link to someone and when they click on it, Flare's web help (not HTML5) opens, shows the topic AND the accordion navigation items and the icon bar, too.

Essentially, I'm looking for the web help equivalent of this type of link in HTML5:
webhelp.madcapsoftware.com/flare9/Default.htm#Nav_Links/About_Navigation_Links.htm

When I replicate the syntax as .../index.htm#folder/topic.htm, I still get index.htm, but not the specific topic I want.

When I mail around a link to folder/topic.htm (without index.htm and #), I get the specific topic I want, but without accordion navigation items and without icon bar.

Any ideas?

Many thanks in advance, Kai.
Documentation: Helping users look good and suck less.
LTinker68
Master Propellus Maximus
Posts: 7247
Joined: Thu Feb 16, 2006 9:38 pm

Re: Create a topic link that includes nav frames in webhelp?

Post by LTinker68 »

Try Default_CSH.htm in the URL instead. Make sure when you uploaded the content to the server that you included the files Default_CSH.htm and Default_Left.htm. Those files are used for CSH calls in WebHelp output. If you renamed the output to index.htm, then the files would be index_CSH.htm and index_Left.htm.

For additional info, see http://webhelp.madcapsoftware.com/flare ... lopers.htm.
Image

Lisa
Eagles may soar, but weasels aren't sucked into jet engines.
Warning! Loose nut behind the keyboard.
NorthEast
Master Propellus Maximus
Posts: 6426
Joined: Mon Mar 05, 2007 8:33 am

Re: Create a topic link that includes nav frames in webhelp?

Post by NorthEast »

techwriterkai wrote:Essentially, I'm looking for the web help equivalent of this type of link in HTML5:
webhelp.madcapsoftware.com/flare9/Default.htm#Nav_Links/About_Navigation_Links.htm
An equivalent link for WebHelp would be:

http://webhelp.madcapsoftware.com/flare7/Default_CSH.htm#Nav_Links/About_Navigation_Links.htm

The link provided by Lisa explains how to use URLs for CSH calls.
techwriterkai
Propeller Head
Posts: 66
Joined: Wed Oct 12, 2011 5:27 am
Location: @techwriterkai
Contact:

Re: Create a topic link that includes nav frames in webhelp?

Post by techwriterkai »

Thank you very much for prompt help, Lisa & Dave!

It obviously works with MadCap's Flare 7 online help.

But it doesn't seem to work when you're running web help off an internal file server, with a path such as \\intserver\onlinehelp\dev\Default_CSH.htm#Windows/window-1.htm (it doesn't work with the last slash replaced by a backslash either). So I'm guessing the # parameter only works via HTTP protocol.

Thanks again, Kai.
Documentation: Helping users look good and suck less.
NorthEast
Master Propellus Maximus
Posts: 6426
Joined: Mon Mar 05, 2007 8:33 am

Re: Create a topic link that includes nav frames in webhelp?

Post by NorthEast »

techwriterkai wrote:But it doesn't seem to work when you're running web help off an internal file server, with a path such as \\intserver\onlinehelp\dev\Default_CSH.htm#Windows/window-1.htm (it doesn't work with the last slash replaced by a backslash either). So I'm guessing the # parameter only works via HTTP protocol.
It will work fine on local file systems and servers.

Your example path isn't the correct format for a file URL, it would need to be in the format:

Code: Select all

file://intserver/onlinehelp/dev/Default_CSH.htm#Windows/window-1.htm
Note you need to use file:// and forward slashes (/).
techwriterkai
Propeller Head
Posts: 66
Joined: Wed Oct 12, 2011 5:27 am
Location: @techwriterkai
Contact:

Re: Create a topic link that includes nav frames in webhelp?

Post by techwriterkai »

Thanks, Dave, excellent. Yes, I get the correct result with file:// and forward slashes.

We have some topics that are not in Content/ or child folders, but rather in a sibling to the Content/ folder. These we can reach by adding: ../

For example, we have a topic: ...dev/Tasks/Setup/GettingStarted.htm

The link with navigation is then: ...dev/Default_CSH.htm#../Tasks/Setup/GettingStarted.htm

Thanks again for your help! Cheers, Kai.
Documentation: Helping users look good and suck less.
Cardinal Richelieu
Propeller Head
Posts: 12
Joined: Wed Mar 19, 2008 8:39 am

Re: Create a topic link that includes nav frames in webhelp?

Post by Cardinal Richelieu »

Apologies for reviving an old thread, but I'm tearing my hair out about this. After much wailing and gnashing of teeth, I've managed to display the sub-topic alongside the default menu on the left (the reason I couldn't get it working was I was specifying the path to the Content folder when it actually does this automatically).

The problem with this is that the default menu, while visible, doesn't expand to show the location of the topic you are currently in, i.e. it remains stubbornly collapsed at the primary topic. Contrast this to:

http://webhelp.madcapsoftware.com/flare ... _Links.htm

Here the menu expands to show you exactly where the topic is located.

How do I do this with my own project? Is it something as simple as changing the URL, or do I need to change something in the project itself?

Thanks :)
techwriterkai
Propeller Head
Posts: 66
Joined: Wed Oct 12, 2011 5:27 am
Location: @techwriterkai
Contact:

Re: Create a topic link that includes nav frames in webhelp?

Post by techwriterkai »

Have you tried the option that syncs the TOC with the open topic? Should be easy to try out and maybe that's just it...?

See http://webhelp.madcapsoftware.com/flare ... Topics.htm

Cheers, Kai.
Documentation: Helping users look good and suck less.
Cardinal Richelieu
Propeller Head
Posts: 12
Joined: Wed Mar 19, 2008 8:39 am

Re: Create a topic link that includes nav frames in webhelp?

Post by Cardinal Richelieu »

That's perfect Kai. Solved all my problems (well, Flare related ones anyway). Apologies for being a doofus :)
techwriterkai
Propeller Head
Posts: 66
Joined: Wed Oct 12, 2011 5:27 am
Location: @techwriterkai
Contact:

Re: Create a topic link that includes nav frames in webhelp?

Post by techwriterkai »

You're welcome, Cardinal! No worries - it IS kind of a hidden option... :-)

Glad I could help! Cheers, Kai.
Documentation: Helping users look good and suck less.
Post Reply