Adobe RoboHelp 9: External Content Search

by Kevin Siegel Follow us on Twitter View our profile on LinkedIn

The two most commonly used features in a Help System are typically the Index and Search tabs. One of the limitations of the Search feature has always been the inability to hook specific URLs to Search terms. I'm happy to say that the External Content Search feature puts that issue to rest in the new RoboHelp 9.

Using External Content Search, you can display content from specific URLs based on terms that users are likely to search. For instance, a company called South River Technologies (SRT) has a Help system and they would like to set it up so that if a user searches for the word webdrive (one of SRTs products), they'll be presented with a link that will take them to a web page showing the word webdrive as it relates specifically to South River Technologies.

If you were SRTs Help author, here is how you could set up the External Content Search in RoboHelp 9.

Using your web browser, go to http://www.google.com and click the Advanced Search link. In the all these words field, type webdrive; in the this exact wording or phrase field, type south river technologies and from the Language drop-down menu, select English.

Google Search

Click the Advanced Search button and only web pages that contain the word webdrive and the wording south river technologies will be listed. Select and copy the URL in the address bar to the clipboard (you will be pasting it within RoboHelp shortly).

Add External Content Search

Using RoboHelp 9, choose View > Pods > Project Setup. Double-click External Content Search to open the External Content Search dialog box.

Click the Add button. Change the Title to webdrive. In the Search Terms field, type webdrive. In the URL field, delete the current entry and paste the URL that you copied from the Google Advanced Search. In the Description field, type Search the web for the term webdrive as it relates to SRT.

Add External Search to a RoboHelp project

On the Single Source Layouts pod, double-click your layout and select the Search group. Then select Enable External Content Search.

Enable External Search

Click the Save and Generate button and, when ready, click the View Result button. On the Search tab, type webdrive and press [Enter]. Click the lone result to display the Google Search results.

The thing that I really found cool about RoboHelp's External Content Search, especially using a Search engine results URL, like the one you copied from Google, is that the results will automatically update for your users when Google's search algorithms get updated (which is frequently).

 

***

 

Looking to learn RoboHelp, and fast? I'm teaching a live, online class that will give you the most essential RoboHelp skills… and in just two days.

Adobe RoboHelp 9: PDF Review

by Kevin Siegel Follow us on Twitter View our profile on LinkedIn

It's likely that at some point you'll be asked to share the content within your Help system with members of your team so that they can provide feedback. You could post your generated Help system on a web server somewhere, ask reviewers to use the Help system and then provide feedback. The problem is what to do with and how to manage the feedback you are likely to receive.

The new RoboHelp 9 includes a handy Create PDF for Review option that will allow you to create a PDF that reviewers can open with the free Adobe Reader. Your reviewers can use Adobe Reader to add comments. The PDF stores those comments and you can import them directly into RoboHelp. Once the comments have been imported, you can accept or reject the comments, just as if you were using the Track Changes feature you'll find in word processors like MS Word.

Here is how the PDF Review process works.

From within RoboHelp, choose Review > Create PDF for Review.

The Create PDF for Review dialog box opens. By default, every topic in the project is selected and will be sent for review. You can select as many items to include in the PDF as you like.

PDF for Review: Deciding which topics to include in the PDF

You can decide to save the PDF locally (and later post it to a server) or send it as an e-mail attachment.

Save the PDF locally

Your reviewers must have the Adobe Acrobat or Adobe Reader 9 or newer to add comments to the PDF. Shown below are the Text Edit options found in Acrobat 9.

Acrobat's Text Edit Tools

The Text Edit tools were used to cross out some text and replace one word with another in the image below.

 

Text Edits made to a PDF via Acrobat.

Back in RoboHelp, all that's left to do is choose Review > Import Comments from PDF. The Import Comment Summary dialog box will open. This dialog box summarizes the number and type of comments that were added to the PDF.

Comments imported

You will then use the Review Pane (Review > Show Review Pane) to accept or reject the comments. Sweet!

 

Accept or Reject comments

 

***

 

Looking to learn RoboHelp, and fast? I'm teaching a live, online class that will give you the most essential RoboHelp skills… and in just two days.

Adobe Releases Technical Communication Suite 3

Technical communicators can rejoice… the latest version of Technical Communication Suite was just released by Adobe. According to Adobe, version 3 of the suite is a "complete single-source authoring toolkit with multichannel, multidevice publishing capabilities."

Technical Communication Suite 3 includes FrameMaker 10, RoboHelp 9, Captivate 5, Photoshop CS5, and Acrobat X. To learn more about the suite, read the article written by Adobe's RJ Jacquez. To purchase the suite, contact Adobe's Thomas Deems at 206.675.7076.

Adobe RoboHelp 8: Creating Multiple Topics From One Word Document

by Kevin Siegel Follow us on Twitter View our profile on LinkedIn

One of the most common ways to add new content to a RoboHelp project is by importing a Word document via File > Import > Word Document. If the Word document contains a TOC, Headers, Footers or Index, they will import nicely into RoboHelp. However, during the import process, it's highly likely that you will end up with one, large topic in RoboHelp instead of several small ones. So how do you instruct RoboHelp to create several topics out of the one Word document? Read on…

 

During the import process you will be working within an Import dialog box. The dialog box gives you access to options that control how the Word document will be formatted as it is imported into RoboHelp. All you need to do is click the Edit button you will see to the right of Word Document: Edit conversion settings for Word documents.

 

RoboHelp Edit button

 

After clicking the Edit button, your Word document will be scanned and the Conversion Settings dialog box will appear. This is where you can control which paragraphs in the Word document will be paginated into new topics.

 

From the Word Document Settings area, select the style or styles that you used in the Word document to be used as new topics. For instance, Heading 1 is typically used in Word to designate main sections in the document. In that case, you would select Heading 1 from the list of Word styles.

 

Next, select Pagination from the list of options in the middle of the dialog box. 

 

RoboHelp Pagination

 

By selecting Pagination for specific Word styles, RoboHelp will create a new topic every time it sees that Heading 1 was used in the Word document.

 

After that, all you'd need to do is click the OK button and then the Finish button and the Word document will be imported into RoboHelp. Once the import process is complete, you will find your new topics on RoboHelp's Topic List pod.

 

***

Looking to learn Adobe RoboHelp? I offer a live, two-day online class once a month.

Adobe FrameMaker 10 and RoboHelp 9 Sneak Peeks

RJ Jacquez of Adobe has posted videos of the next versions of FrameMaker (10) and RoboHelp (9).

According to Jacquez, "With version 9, we are taking RoboHelp and RoboHelp Server to the next level by helping our customers incorporate important Industry trends taking place today into their TechComm workflow. Trends like User-generated content, Community-based User Assistance, Rich Internet Applications, Content Personalization, Rich Media, Mobile publishing, the Cloud and others." Here is a link to the RoboHelp video.

As for FrameMaker 10, Jacquez said "Our customers are telling us that their end-users expect more from them, more interactive and richer experiences that are socially-enabled, too." Here is a link to the FrameMaker video.

Adobe RoboHelp: Word 2010 Support

The following was recently announced by Ankur Jain, Product Manager, RoboHelp on the Technical Communication blog:

"Many of you must be wondering about Adobe's plans to support Microsoft Word 2010 in RoboHelp. Some of you have submitted requests for RoboHelp to support Word 2010, and many others have asked me about it in various forums. I'm pleased to announce that the next major release of RoboHelp will support Microsoft Word 2010 for all the workflows including import/linking and printed documentation output (.docx and .doc). Please note that we haven't made any announcements about updating RoboHelp 8 for Microsoft Word 2010."

***

 

Looking to learn RoboHelp quickly? We've got a class coming up in just a few weeks.

Adobe RoboHelp Question of the Week: Can I Export/Import SSLs?

I have duplicated and set up a Single Source Layout. Can I export the layout so that I can use it in other projects?

Answer (provided by Kevin Siegel):

There is no direct way to do it within RoboHelp. However, you can do it "behind the scenes." If you don't have experience editing code, I would advise against the following technique since it's pretty easy to trash the file.

First, copy the SSL support file from within your project folder and paste it into the new project's folder. The SSL file is called name.ssl (for instance, mycool.ssl).

From within the new project folder, open rhlayout.apj file using Notepad.

Add this line of code to the file:

<layout>
<name>name of the ssl here</name>
<type>6</type>
<id>1000</id>
</layout>

Reopen the RoboHelp project and your new SSL will appear on the SSL pod.

Adobe RoboHelp 8: Scripts Make Quick Work Out of Redundant Tasks

by Kevin Siegel Follow us on Twitter View our profile on LinkedIn

If you have ever used Microsoft Word to record or write a macro using Visual Basic, you already appreciate how much time macros can save you by automating repetitive tasks.

While RoboHelp does not support macros, scripts (which are coded instructions) provide the same functionality. RoboHelp ships with a few helpful scripts and if you are an application developer, you can create your own scripts from within RoboHelp or import them.

Run a Word Count Script

     

  1. Open a RoboHelp project
  2. Open the Script Explorer by choosing View > Pods > Script Explorer

    The Script Explorer pod appears at the far right of the window by default.

    Script Explorer pod

  3. Click the plus sign to the left of the Sample Scripts folder to expand the folder
  4. On the Script Explorer pod, right-click the Word Count.jsx script and choose Run

    The word count is quickly completed and the total Word Count appears at the bottom of the Output View pod.

    Word count complete

Edit a Script

Okay, so the word count script you just learned about is nice and all, but hardly anything to write home about. Get your pen and paper out… this next script rocks.

How many times have you found a web address in your project that wasn't correct? And how many times has that Web address needed to be corrected in multiple locations? This next script will let you fix URLs project-wide.

     

  1. On the Script Explorer pod, right-click the Link Converter.jsx script and choose Edit

    The Extend Script Toolkit opens.

  2. On line 10 of the script, replace http://www.oldurl.com with the address you want the script to find and correct
  3. Replace http://www.newurl.com with the correct address

    URL changed

  4. Save and close the script (choose File > Save and then choose File > Exit)
  5. On the Script Explorer pod, right-click the Link Converter.jsx script and choose Run

    Any files using the incorrect Web address are opened and corrected. You will be prompted to save each file that has been edited.

***

Need to learn RoboHelp… and fast? Join my live, two-day RoboHelp class later this month.

***

Follow me on Twitter

Adobe RoboHelp 8: One Publish, Multiple Servers

by Kevin Siegel Follow us on Twitter View our profile on LinkedIn

I received an email from a RoboHelp developer who was faced with a daunting task. He needed to post a copy of his generated RoboHelp project to three servers within his corporation. His RoboHelp project was large and consisted of thousands of topics, tens of thousands of images and other assets.

The process of copying and pasting the contents of his generated layout (he was generating WebHelp) wasn't a difficult chore, but it was time-consuming. After generating his Help System, he went into the SSL (Single Source Layouts) folder within the project folder, copied the generated Help System files and pasted them onto the first server. After the process was complete, and assuming there were no read/write errors, he went to the next drive and pasted, and so on and so on.

The Help System consisted of such a large number of files, it took a long time for the copying process to conclude. And due to server limitations, he couldn't simply paste the files onto all three servers at one time and walk away. In essence, he had to babysit the publishing process.

Compounding the problem was the fact that when he made even simple changes to any of the topics within the Help System and re-generated, he had to go through the copy/paste routine all over again.

The developer was hoping for a better solution, one that would give him his life back. And I was happy to introduce him to multi-server publishing.

You can easily create multiple servers within RoboHelp and publish your projects to those servers, one after the other. You can accomplish this publishing feat with a minimum of clicks, and without having to babysit the process. What could be better? Actually, plenty. If, down the road, you make changes to any of your topics, regenerate and then republish, only the updated content will be added to the servers.

Here's how you can publish one project to multiple servers:

  1. Show the Properties of either WebHelp or FlashHelp.
  2. Click the Next button until you end up on the last screen (the Publish dialog box).
  3. Click the New button to open the New Destination dialog box.
  4. If you are planning to drop your Help System files on a drive within your own network, select File System as the Connection Protocol.
  5. Give the server any name you like.
  6. Type or browse for a folder on your server where you will be publishing your project and then click the OK button.

    RoboHelp's New Destination dialog box

  7. Click the New button again and create as many destination
    servers as you need.

    RoboHelp: Multiple Servers

  8. When finished, click the Save button.
  9. Generate your layout and, when the Results screen appears, click the Publish button.

    Publish button

    And Bam! Your Help System files will be published to all of your servers (anywhere in the world), one after the other. And if you want to get totally knocked off your feet, go ahead and make a change to any of your topics. Then generate and re-publish. You'll see that only the files that have changed (and a few support files) are re-published.

***

Need to learn RoboHelp… and fast? Join my live, two-day RoboHelp class later this week.

***

Follow me on Twitter

Adobe RoboHelp 8: Meet the Tag List

by Kevin Siegel Follow us on Twitter View our profile on LinkedIn

During a recent RoboHelp class, I was teaching the group about numbered and bulleted lists. It was time to select the list and alter it in some way. The exact alteration we were going for isn't important here. What mattered was that to make the alteration to the list, the entire list needed to be selected.

So what's the best way to select a list? Certainly you can do it the old-fashioned way and drag up or down the list to select it. But what if the list is long? A simple slip of the mouse and you'll find that you've selected either too much or too little of the list.

And what if you're working with a table and you need to select the entire table (consisting of dozens of rows) and you want to move the table to a different location in your topic? Once again, highlighting the table by dragging over the rows will work, but is hardly efficient.

RoboHelp features a wonderful, but hidden, feature that will make the process of selecting areas within your topic a snap: the Tag List.

To display the Tag List (which is not visible by default), choose View > Show Tag List. The Tag List appears above each topic's main headline (between the headline and the Design and HTML buttons).

With the Tag List open, it's a simple matter of clicking the List tag to select all of the items in a numbered or bulleted list. Or click the Table tags to select the entire table or the table components such as a row or cell.

RoboHelp's Tag List (selecting a List)

Looking for a quick way to remove inline formatting (the kind of formatting that you get when you manually make topic text bold or italic without using a style)? It's a snap with the Tag List. For instance, I manually formatted a word in a topic as bold, italic and underlined. Later, feeling regret, I decided to remove the formatting. I could have manually selected the text and reapplied the bold, italic and underlined styles to remove the formatting. However, it was quicker to use the Tag List by right-clicking the span tag on the Tag List and selecting Remove Attributes.

RoboHelp's Tag List: Remove Attributes

Spend some time with the Tag List and I'll guarantee you'll find yourself working just a bit more efficiently in RoboHelp than ever before.

***

Need to learn RoboHelp… and fast? Join my live, two-day RoboHelp class later this month.

***

Follow me on Twitter