Adding a Send Feedback link to Your Online Help / RoboHelp Project
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:
- 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.
- 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.
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.
I'd Rather Be Writing Newsletter
Get new posts delivered straight to your inbox.
About Tom Johnson
I'm a technical writer based in the California San Francisco Bay area. In this blog, I write about topics related to technical communication — Swagger, agile, trends, learning, plain language, quick reference guides, tech comm careers, academics, and more. I'm interested in simplifying complexity, API documentation, visual communication, information architecture and findability, and more. If you're a technical writer of any kind (progressional, transitioning, student), be sure to subscribe to email updates using the form above. You can learn more about me here. You can also contact me with questions.