Search results

Adding a Send Feedback link to Your Online Help / RoboHelp Project

by Tom Johnson on Dec 7, 2007
categories: technical-writing

I was reading an article in a previous STC Intercom magazine about how to add a Send Feedback link to your online help project, but the javascript didn't work. Here's an alternative method that does work.  This Send Feedback link grabs the page title and URL and includes it in the e-mail that the user sends.

The method below describes the integration using RoboHelp, but the principles apply to almost any online help editor.

To add a Send Feedback link in your RoboHelp project:

  1. Right-click the Templates folder and create a new template (or access an existing one). Then expand the footer section and put your cursor where you want the link inserted.
  2. In RoboHelp 7, go to Insert > HTML > Advanced > Scripts. Insert the following code:

document.write("<a href="mailto:[email protected]?subject=Application Name |  " + document.title + " | " +  location.href + ""> Send Feedback</a>") ;

This will put the page title and URL in the subject of the e-mail. However, I had some problems with character limits, so here's an alternative script that puts the URL in the body of the message.

document.write("<a href="mailto:[email protected]?subject=Application%20Name%20("+document.title+")%20%20File:%20"+location.href+"">Send Feedback</a>");

The link will now appear in every one of your topics that uses the template.

If you aren't using the Insert > HTML > Advanced > Scripts method to insert the code, then you need to include script tags around the statement.

<script type="text/javascript">document.write("<a href="mailto:[email protected]?subject=Sample%20Application%20("+document.title+")&body="+location.href+"%0A%0A"+"">Send Feedback</a>");</script>

<script type="text/javascript"> document.write("<a href="mailto:[email protected]?subject=Sample Application |  " + document.title + " | " +  location.href + ""> Send Feedback</a>") ;</script>

Note: In the above scripts, replace [email protected] and Sample Application with your own email and application name. Also note that if you copy the text, the characters may not copy as displayed.

How do you gather feedback from your users? I'm interested to hear if you have other scripts or techniques.

About Tom Johnson

Tom Johnson

I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.

If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.