Skip to main content
A
Anonymous
December 6, 2012
Question

Converting a SUManual in XML to context sensitive help for the online app

  • December 6, 2012
  • 1 reply
  • 574 views

Hi, Is it possible to take a Software User Manual, XML version, file and use it as the source for context sensitive help on the actual online application? I imagine there will need to be some XSLT transformation along the way to render the HTML WebHelp Popup. When I import the XML file into Robohelp it just comes in as XML text with the tags. Do I have to transform to HTML before Robohelp can do anything with in terms of CSH popup? If anyone could point in the right direction, that would be helpful. Thanks - Carlostorm

    This topic has been closed for replies.

    1 reply

    Captiv8r
    Captiv8r
    Legend
    December 8, 2012

    Hi there

    RoboHelp works with files in XHTML format or HTML format. So yes, I'm thinking you will need to change them in some way so the result is XHMTL or HTML files before RoboHelp will understand and use them.

    (I have no clue what an XSLT transformation is, is that like time travel?)

    Cheers... Rick

    Willam van Weelden
    Willam van Weelden
    Inspiring
    December 8, 2012

    HI,

    @Rick: XSLT is a transformation language to tranform an XML document into another text based file such as XML or HTML.

    A RoboHelp Project is a collection of XML and HTML files to make a coherent whole. I don’t know what a SUManual is, but there are several ways to go to make it into context sensitive help.

    1. Directly generate a CSH help from the XML source, but this will required creating a skeleton system for context sensitivity, table of contents, etc.

    2. Roundtripping to RoboHelp:

    a. Using a script/application to set the barebones project.

    b. Using XSLT to transform your XML into topics.

    c. Using XSLT/script/application to create the Table of Contents, Index and Context Sensitive data.

    d. Using a script to create the help system and publish it to the location you require.

    Such a system will require some work to set up. But when it is set up, you should be able to convert your XML documents into a help system in minutes.

    The forum may not be the best place to discuss your options in depth. You can contact me via contact wvanweelden eu if you’d like to discuss your options in more detail.

    Greet,

    Willam

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