Linking between merged WebHelp topics

This forum is for all Flare issues not related to any of the other categories.
Post Reply
todd.richardson
Sr. Propeller Head
Posts: 187
Joined: Thu Aug 07, 2008 6:43 am
Location: Massachusetts

Linking between merged WebHelp topics

Post by todd.richardson »

Hello,

I generate a master WebHelp system that is merged with a separate "child" WebHelp system at build time - the source for which is placed in a "Subsystems" folder in the master output directory. The master contains a TOC entry topic with links to topics in the child. To this point, I have not been able to create links between the two successfully. I'm using this method:

In the Insert Hyperlink dialog:
Link to: External File, ../../ChildProject/Content/27a73f64-2d81-52a6-dae3-99cd1235e671.htm (don't ask why the topic name is a long string of characters - long story)

Here is a path comparison for your reference (master output directory):
Master - WebHelp/
Child - WebHelp/Subsystems/ChildProject/

Any idea how this can be done? What am I missing?

Thanks.
Todd Richardson
Engineering Team Lead – Customer Experience | IntervalZero

Windows 10, Flare 2020
jacortes
Propeller Head
Posts: 45
Joined: Thu Oct 16, 2008 1:11 pm

Re: Linking between merged WebHelp topics

Post by jacortes »

Todd,
The master contains a TOC entry topic with links to topics in the child
Are you trying to link to a single topic in the child WebHelp system from the Parent TOC? I could be wrong, but I don't think this is possible. I think you can only link to an entire WebHelp system from a parent TOC. (Love to hear the solution if I'm wrong! :) )

But, in general, if you are trying to create a link from a parent topic to a child topic in a Merged WebHelp system you should:
1. Compile the child output first.
2. Compile the parent output next.
3. Go to the Output folder in the parent WebHelp.
4. Locate the topic that will contain the link. (Depending on how you organize your source topics in your Content folder, you may have to drill to find it. For example, if in your Content folder you have an Overview folder with the topic that will contain the link, your Output folder will also have an Overview folder.)
5. Once you can see the topic that will contain the link to the child topic, drill back up to the directory that allows you to see the Subsystems folder. (However many directories you have drilled up will determine how many "../" you need in your link path. (So, if you only have an Overview folder between the topic that will contain the link and the Subsystems folder, that's one "../". If the topic that will contain the link is in the same directory as the Subsystems folder, you shouldn't need any "../".)
6. Beginning with "Subsystems", type the rest of the path to the child topic you want to link to.
7. Once you have your link in place, you can recompile the parent output.

Hope that helps some.
wbrisett
Sr. Propeller Head
Posts: 216
Joined: Mon Oct 05, 2009 3:29 pm
Location: Austin, TX

Re: Linking between merged WebHelp topics

Post by wbrisett »

I use mini-TOCs in chapters. I have to build some "chapters" as separate projects due to memory and size. In order to link to the subsystem items, I have to manually add those after the build. It's not pretty, but once you figure out the path, it's not too bad. However, if you have a lot of items, this method wouldn't be ideal.

Wayne
crdmerge
Sr. Propeller Head
Posts: 248
Joined: Tue Dec 16, 2008 5:37 am

Re: Linking between merged WebHelp topics

Post by crdmerge »

First, we shorten all the paths by eliminating the "/Content" folder (WebHelp Target > Advanced > Do not use "Content" folder in output)

From Master to child:
<a href="Subsystems/child_project/target_topic.htm">Link Text</a>

From child to child:
<a href="../other_child_project/target_topic.htm">Link Text</a>

Anf, finally, from child to Master (yes, you might need to):
<a href="../../target_topic.htm">Link Text</a>


Good luck,
Leon
todd.richardson
Sr. Propeller Head
Posts: 187
Joined: Thu Aug 07, 2008 6:43 am
Location: Massachusetts

Re: Linking between merged WebHelp topics

Post by todd.richardson »

Thanks for the assistance. I followed the instructions jacortes provided, and was able to resolve the issue. It turns out I had miscounted the levels between the topic I was linking from and the Subsystems folder - so I had one less "../" in the path than I needed. All set.
Todd Richardson
Engineering Team Lead – Customer Experience | IntervalZero

Windows 10, Flare 2020
gsm1
Propeller Head
Posts: 24
Joined: Wed Oct 05, 2016 4:46 pm

Re: Linking between merged WebHelp topics

Post by gsm1 »

My challenge was to create a link from a child project to a master project (aka parent project) topic for HTML5 output.

I had previously figured out how to create child to child links. Nothing I found in the Forum provided clear (enough) directions for creating the child to master link.

I was confused by advice to avoid inclusion of the content folder ( WebHelp Target > Advanced > Do not use "Content" folder in output.)
Perhaps this was not meant apply to HTML5 output. I don't know. In any case, it is not accurate for HMTL5 output.

Also, various contributions I had read implied that a linkage path should not extend past "Subfolders." For purposes of creating a link from a child to a master project topic, this too is inaccurate.

For this situation, the correct solution was <a href=../../../content/filename.htm">link name</a>

The path from the topic with the link was: My Projects > Project A > Output > MyName > HTML5 > Subsystems > ChildProject1 > content.

Since HTML5 held the master project > content file, I needed three steps (../../../) to reach the master project. I also needed to reference the content folder, as shown.

Testing has shown that this is valid solution.

I hope this will prove helpful to others. It took me a number of hours to figure this out on my own.
Post Reply