Skip to main content
S
Sandie336840483i6i
Participant
November 17, 2023
Question

Integrating RoboHelp Documentation with Microsoft Azure for Dynamic Navigation

  • November 17, 2023
  • 2 replies
  • 169 views

Hello everyone,

I am working on an Adobe RoboHelp project that serves as the documentation for a software application. Our plan is to deploy this documentation on Microsoft Azure to make it available online.

Our goal is to enable dynamic navigation from the software to the specific documentation. For this, we have utilized RoboHelp's mapping feature to map all the pages of the documentation. We intend to provide the mapping file to the software so that when a user requests information on a specific topic, they are directed to the appropriate online documentation page.

My question is: Is it possible to set this up in such a way that the software can use the mapping file and the base URL of the documentation to generate the complete URL for the specific documentation page? If so, what might this URL look like? Which part of the mapping file would be used in the URL to ensure precise navigation?

Any help or examples of similar implementations would be greatly appreciated.

Thank you very much for your support and advice.

    This topic has been closed for replies.

    2 replies

    A
    Community Expert
    AmebrCommunity Expert
    Community Expert
    November 19, 2023

    Peter's page mentions the CSH API only in the context of CHM files, but the api works perfectly well with web outputs. The developers at my old work modified the javascript example so the base URL didn't have to be specified in the link - it was included in the underlying javascript or passed as a variable or something. I'm sure your devs can figure that out - just give them the appropriate files and work with them on an output to get it set up.

     

    The old help included much more detail to help developers who are unfamiliar with CSH. This is from RH2017 but the concepts still apply and I don't think the API has significantly changed since this was written. https://help.adobe.com/en_US/robohelp/2017/robohtml/index.html#t=book%2Frob_createhelp_ch%2FInformation_for_developers-.htm&rhsearch=context&rhsyns=%20

     

    You can find several different examples for different languages in the RH installation directory.

     

    (Do note, I haven't specifically tried with Frameless, only Responsive output, but if it doesn't work I would personally class that as a bug and holler at Adobe 🙂  )

    Peter Grainge
    Community Expert
    Peter GraingeCommunity Expert
    Community Expert
    November 17, 2023

    Help can be called in two ways, URLs and MapIDs. See https://www.grainge.org/pages/authoring/rh_tour/rh2022/outputs/calling_csh_help.htm

     

    URLs are just that, your developers link a page to the topic using the URL MapIDs are created using the mapping feature and your developers put the ID into their software.

    ________________________________________________________

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

     

     

     

    Use menu (bottom right) to mark as Best Answer or to Highlight particularly useful replies. Found the answer elsewhere? Share it here.
    Terms & ConditionsAccessibility statement
    Using the community Terms of use Privacy Cookie preferences Do not sell or share my personal information ad choicesAdChoices