How to Integrate Google Search in WebHelp Classic Output

You can integrate Google Search into your WebHelp output.

To allow your WebHelp system to use Google Search, follow these steps:

  1. Go to the Google Custom Search Engine page using your Google account.
  2. Press the Create a custom search engine button.
  3. Follow the on-screen instructions to create a search engine for your site. At the end of this process you should obtain a code snippet.
    A Google Search script looks like this:
    <script>   
     (function()  {     
      var cx =
        '000888210889775888983:8mn4x_mf-yg';     
      var gcse = document.createElement('script'); 
      gcse.type = 'text/javascript'; 
      gcse.async = true;     
      gcse.src = (document.location.protocol == 'https:' ?
        'https:' : 'http:') +         '//www.google.com/cse/cse.js?cx=' + cx;     
      var s = document.getElementsByTagName('script')[0]; 
      s.parentNode.insertBefore(gcse, s);   
     }
     )(); 
    </script>
  4. Save the script into a well-formed HTML file called googlecse.html.
  5. In Oxygen XML Author plugin, click the Configure Transformation Scenario(s) action from the toolbar.
  6. Select an existing WebHelp transformation scenario (depending on your needs, it may be with or without feedback, or the mobile variant) and click the Duplicate button to open the Edit Scenario dialog box.
  7. Switch to the Parameters tab and edit the webhelp.google.search.script parameter to reference the googlecse.html file that you created earlier.
  8. You can also use the webhelp.google.search.results parameter to choose where to display the search results.
    1. Create an HTML file with the following content: <div class="gcse-searchresults-only" data-queryParameterName="searchQuery" > (you must use the HTML5 version for the GCSE). It is recommended that you set the data-linkTarget attribute value to frm for frameless versions of the WebHelp system or to data-contentWin for frameset versions of WebHelp. The default value is _blank and if you do not specify a value the search results will be loaded in a new window. For more information about other supported attributes, see Google Custom Search: Supported Attributes.
    2. Set the value of the webhelp.google.search.results parameter to the file path of the file you just created. If this parameter is not specified, the following code is used: <gcse:searchresults-only linkTarget="frm"></gcse:searchresults-only>.
  9. Click Ok.
  10. Run the transformation scenario.