Skip to main content
Known Participant
March 7, 2022
Question

Context-sensitive help links after upgrade

  • March 7, 2022
  • 15 replies
  • 240 views

I am [finally] going to start upgrading my RH 2019 Classic projects to RH 2020. I want to make sure I understand how context-sensitive help with the URL method will work in both Responsive HTML5 and Frameless layouts generated with RH 2020.

 

For our current Responsive HTLM5, the context-sensitive topics are linked in this format:  /path/topic.htm#t=topicfile.htm (where topicfile.htm is a level or two deep in subfolders)

 

As I understand it, if I want to produce Responsive HTML5 output using RH 2020, all those URLs will have to be edited to use this format: 
/path/index.htm#t=topicfile.htm (where index.htm replaces topic.htm).

 

And if in the future I want to go with a frameless layout, all those URLs will have to be edited again to use this format: 
/path/topicfile.htm (where the path includes all of the subfolders necessary to get to topicfile.htm)
As I understand it, no intervening reference like "index.htm#t=" is necessary with this layout; you can just link directly to the URL of each topic.

 

So in other words, if I want to duplicate the current Responsive HTLM5 experience in RH2020, and then I want to replace that with frameless output some time in the future, all those URLs will have to be updated twice. Is that correct? 

    This topic has been closed for replies.

    15 replies

    Peter Grainge
    Community Expert
    Community Expert
    March 8, 2022

    The link to a responsive topic without index.htm opens the topic without the TOC etc and with it you get the TOC as well. The difference depends on how you want to call your CSH topics, topic alone or the same topic with the TOC as well.

    ________________________________________________________

    My site www.grainge.org includes many free Authoring and RoboHelp resources that may be of help.

     

    Use the menu (bottom right) to mark the Best Answer or Highlight particularly useful replies. Found the answer elsewhere? Share it here.
    Known Participant
    March 8, 2022

    What I'm trying to determine, with this question and the other one I posted yesterday, is whether it's worth the effort to tweak the Indigo layout in RH 2020 so we can keep the help layout that our users are familiar with for a little while longer, or whether we should just go straight to a Frameless layout even if it means that we might have to skip the help updates for a release or two while we perfect the look and feel we want from the Frameless layout. (My company is giving me no choice but to move to RH 2020 no later than June.)

     

    My inclination is to say we should concentrate on Frameless, but I need to have solid reasons my boss will understand 🙂 If we need to do two rounds of edits to the context-sensitive references, plus make the visual tweaks I asked about in my other post, then that just might be enough to persuade him.

    Known Participant
    March 8, 2022

    Thank you both for your responses! 

    Amber, the issue is not the name of the start page; I'm working with a help site for a platform that's been around a long time and the path is probably set in stone where the developers are concerned. 🙂

    Peter, I did read that article on your website, and what I wrote above is what I understood it to be saying about the URL syntax for context-sensitive calls for Responsive and Frameless layouts in RH 2020. 

    What I'm trying to figure out is whether two rounds of edits to the URLs would be required if I chose to re-create Responsive HTML5 with RH 2020 and then later generate Frameless help. Based on Peter's article, I'm thinking the answer is yes, we would have to update the URLs twice on the platform side. (I think they keep these references in an XML file.)

    Peter Grainge
    Community Expert
    Community Expert
    March 8, 2022

    Does this help? RH2020 Calling Context Sensitive Help (grainge.org)

    ________________________________________________________

    My site www.grainge.org includes many free Authoring and RoboHelp resources that may be of help.

     

    Use the menu (bottom right) to mark the Best Answer or Highlight particularly useful replies. Found the answer elsewhere? Share it here.
    Community Expert
    March 8, 2022

    "index.htm" should be whatever file name you specify in the Start Page field of your output preset. 

     

    "index.htm" is recommended because webservers have special rules related to the file name "index.htm" by default, but you don't have to use that name. And for help sites linked to an application it generally isn't a problem, as long as your developers know what that file name is. And webserver administrators can configure the server to treat other file names like "index.htm" if necessary.

     

    Particularly for a project created in an older Classic version, it might be something else. Or if it was changed during the upgrade process, you should be able to specify the old file name in that field and not have to re-write your help calls initially.

     

    BUT.

     

    I was just playing around with the Indigo skin and it seems to work completely differently from every other skin that I've every looked at. 🙂 So if you're using that skin, you'll have to test. But you might not have to change either the Start Page, nor your help call until you change to Frameless output.