Skip to main content
A
Anonymous
February 9, 2012
Question

opening Help to a mapped ID from a webpage - skin and all

  • February 9, 2012
  • 1 reply
  • 2530 views

I'm testing my way through a couple different options for doing this, courtesty of materials from Mr. W. VanWeelden and others. Here's the scenario:  I want to open specific topics within a webhelp project via links from webpages (all pages will be on the same server. I want not just the topic, but the skin the webhelp project uses ... so that users experience the same Help file interface they are used to, from linking to it via the application toolbar.

I have mapped topics and output the help file. It looks like two different methods work.

JAVASCRIPT

<a href="javascript:RH_ShowHelp(0, '../WebHelp/welcome_to_worldox_gx3.htm', HH_HELP_CONTEXT, 4)">javascript link to topic 4

</a>

DIRECT

<a href="../WebHelp/welcome_to_worldox_gx3.htm?#<id=4>">direct link to topic 4

</a>

OR

<a href="../WebHelp/welcome_to_worldox_gx3.htm?#<id=4>>newwnd=false">direct link to topic 4

</a>

However, both methods get me to the right topic, but without skin. I have tried the "topicurl" option instruction in the Direct method, as Mr. VanWeelden's notes indicate that will load the skin:

<a href="../WebHelp/welcome_to_worldox_gx3.htm?#<../WebHelp/favorite_matters.htm>">direct link to topic 4

</a>

Doesn't work ... not even seeing the main topic.

Is the problem one of syntax, or something more fundamental ... as in having to create a window in the project just for such links?  That would lead to two experiences of the same help file, which I don't want.  Thanks so much in advance for your suggestions.

Michael D.

    This topic has been closed for replies.

    1 reply

    Willam van Weelden
    Willam van Weelden
    Inspiring
    February 9, 2012

    Hi Michael,

    Mr. Van Weelden... I feel real old now

    For this, you want to use a window. Go to Project Set-up > Windows and create a new windows. (Make sure that WebHelp is set as your primary layout.) Select the Two pane layout. In your CSH call, include the window defintion you want to use.

    Say that your window is called 'WithPane'. The correct calls would be:

    • <a href="javascript:RH_ShowHelp(0, '../WebHelp/welcome_to_worldox_gx3.htm>WithPane', HH_HELP_CONTEXT, 4)">
    • <a href="../WebHelp/welcome_to_worldox_gx3.htm?#<id=4>>wnd=WithPane">
    • <a href="../WebHelp/welcome_to_worldox_gx3.htm?#<id=4>>wnd=WithPane>>newwnd=false"> Note: To be able to use an window and use newwnd=false, you need to modify your output file. See www.wvanweelden.eu/robohelp/context_sensitivity_in_webhelp/methods_for_calling_Webhelp/regular_start_file#newwnd_bugfix for how to fix your output to allow window definitions and opening the help in the same window.

    Alternatively, you can use the _csh startfile which will also display the skin. But this _csh startfile is only partially compatible with the new RoboHelp 9 Dynamic User Centric Content. So I'd advise you to only use this method if all else fails.

    Greet,

    Willam

    A
    Anonymous
    February 9, 2012

    Can I call you William??  Will??

    Thanks so much for your speedy reply.  I'm in the process of playing with windows now.  It sounds like this favored solution will enable a sort of parallel Help file experience - a different look and feel from the skinned version, but with access to the Navigation pane.  Am I understanding correctly?

    If that's true, it's workable, but not really ideal.  I'm surprised that it's so hard to link down into a webhelp project and still show the skin.  One alternative I'd consider is providing a button link to the main help file in the contextual help window, so that contextual help and the skinned help available from the application toolbar would be quite distinct. Not sure if that can be done.

    Question on _csh startfile method ... I am using Robohelp 8 now.  Does that make me a good candidate for using this?  does it replace the RH_ShowHelp call?

    Michael D.

    Willam van Weelden
    Willam van Weelden
    Inspiring
    February 9, 2012

    Haha, whatever you like. Most people say William even though the correct spelling is Willam without the extra i. If you're feeling very tired, I'll accept W as well

    The window simply controls how the help is displayed. By default it always opens the help in a popup and the window controls whether the skin is visible and the window controls the size and location of the help. You can create multiple windows for different uses. Just call the correct window name in the call. It's the same help, but you can control the way it is presented to the user.

    If that's true, it's workable, but not really ideal.  I'm surprised that it's so hard to link down into a webhelp project and still show the skin.  One alternative I'd consider is providing a button link to the main help file in the contextual help window, so that contextual help and the skinned help available from the application toolbar would be quite distinct. Not sure if that can be done.

    Yes this can be done. For instance, you create two window definitions: One that shows the pane and one that hides the pane. To call the complete help, you can call the start file or use the window definition that will show the pane (Two pane layout). For the context sensitive help call, you call the same project, but you use the window that hides the pane (Single pane layout). That's all it takes.

    Question on _csh startfile method ... I am using Robohelp 8 now.  Does that make me a good candidate for using this?  does it replace the RH_ShowHelp call?

    The _csh startfile completely replaces the RH_ShowHelp call. The 'problem' with RoboHelp is using DUCC. The _csh startfile is still present than, but only for each content category, not in the main folder. It will still work in RoboHelp 9, but you may need to amend your call. That said, the _csh startfile is a legacy method, so you never know when Adobe will drop it. So using an API is always advisible so you can quickly amend the API when the call changes without having to modify the links themselves.

    Personally, I don't like the default Adobe API because it's rather complex. For WebHelp (not WebHelp PRO!) I've created a simple custom API you can use for calling WebHelp. See: http://www.wvanweelden.eu/robohelp/webhelp_api/javascript

    Greet,

    willam

    Firefly Community Gallery
    Adobe Firefly

    Remix with Firefly Community Gallery

    Thousands of free creations to fall in love with and remix in Firefly.

    Explore now
    Terms & ConditionsAccessibility statement
    Using the community Terms of use Privacy Cookie preferences Do not sell or share my personal information ad choicesAdChoices