Skip to main content
Participant
December 13, 2022
Question

Hover over text ...

  • December 13, 2022
  • 3 replies
  • 361 views

Hello.  I am demoing out RoboHelp for an API documentation project I am working on.  One of the key features needed is to be able to hover the mouse pointer over a word (e.g., an endpoint) and pop up the relevant short article (e.g., valid values, required, etc.).  From what I am reading, this is do-able with the latest release of RoboHelp, but material I am finding on Adobe's site does not match up with this release.

 

Is this possible?  How do I access it and best practices?  Thank you. 🙂 

    This topic has been closed for replies.

    3 replies

    Community Expert
    December 15, 2022

    The :before method described in the post that Peter links to will replicate the text-only popup functionality using modern css, rather than the legacy javascript method that used to be available in Classic. That feature never linked to a different topic; it was just plain text wrapped in a javascript function (it may also have relied on Microsoft HTML Help (chm) dlls and if so wouldn't work outside Windows).

     

    If you want functionality like Wikipedia, you'll need to look for a javascript library that provides that functionality and include those files in the project. You'd use a master page to ensure the correct script/css etc references get in to every topic.

     

    On a side note, Knowledge Base output is designed to publish to very specific cloud knowledge base software, so is actually a super-cut-back output to work around limitations in those systems. I believe it generally strips out anything related to javascript and embeds styling rather than linking to a stylesheet, as the systems aren't usually designed to support rich user guide content.

    Peter Grainge
    Community Expert
    Community Expert
    December 14, 2022

    Does this help? How to create hover text using HTML and CSS - Nathan Sebhastian

    ________________________________________________________

    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
    December 14, 2022

    I don't think there's a built in hover popup but you can do a click to popup. You just hyperlink to the required topic and choose either auto-sizing popup or custom sized popup. The user then clicks on the link and a popup window displays the information.

     

    However, RH2022 is html and css standards compliant, so it should be possible to implement a solution using javscript, css and html. If there's an existing javascript library you should be able to integrate it - e.g. I added DataTables to a Classic project, and it should be easier to add in RH2022 due to the better standards compliance.

     

    Also, if you can tell me where you're reading about the hover functionality I can take a look and perhaps provide some advice.

    Participant
    December 14, 2022

    Thank you so much for the reply and details.  For all intents and purposes, what I am after is if the user hovers over a link, it displays part of the article and allows them to click said if they want to read more.  Sort of like on MediaWik;  pic attached.  The goal being if they just want a quick look at, say, endpoint values they can see it quickly or they can click the actual content and get the whole page.

     

    I believe this functionality exists in RoboHelp as a text pop-ups, but I can't seem to find how to do that in the trial version I am demoing out.

     

    Thanks again. 🙂

     

     

    Jeff_Coatsworth
    Community Expert
    Community Expert
    December 14, 2022

    That help link you point to is for an old Classic version of RH - that's not the RH2022 help you're looking at. The technique will have changed in the New UI redesign of RH2022, but that's what @Amebr is talking about - you make your pop-up point to the topic with the dimensions specified.