I Came, I Saw, I Learned...

Adobe RoboHelp 10: Add a Logo to an HTML5 Catalog Layout

by Willam Van Weelden

A few weeks ago I showed you how to adjust the search highlight color in Multiscreen HTML5. This week, let's look at how you add your logo to the Multiscreen HTML5 Catalog Layout.

Not all Screen Layouts support logos by default. Fortunately, it is easy to add your logo to the Catalog Layout. To begin, ensure that your logo image meets these requirements:

• No more than 80 pixels tall
• No more than 400 pixels wide

Ensure that the Catalog Layout is Available in the Project:

1. With a RoboHelp project open, go to the Project Set-up pod.
2. Open Screen Layouts. If the Desktop_Catalog layout is in the list, you are ready to add your logo. If not, continue with the next few steps.
   
3. Right-click Screen Layouts and choose New Screen Layout.
4. From the Gallery list at the left, select Desktop_Catalog.
   
   
5. Click the OK button.

Add Your Logo to the Catalog Layout

1. With a RoboHelp project open, go to the Project Set-up pod.
2. Open Screen Layouts > Desktop_Catalog > Topic (Default).
   
3. On the Topic page, click in the text box located at the top of the page.
   
   
4. Choose Insert > Image and insert your logo as a regular image.
   
   

You may not see the entire logo while working within the Screen Layout Editor. No worries. When you generate the layout, the logo will display correctly.


5. Save the Topic page.
6. Right-click the logo and choose Copy.
7. Open the Search Results page.
8. Click in the text box located at the top of the Search Results page.
   
   
9. Right-click in the text box and choose Paste.
10. Save the project, Generate and then view the results.

***

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

Adobe RoboHelp: Pining to Pin?

by Kevin Siegel  

When I use a program frequently, I tend to pin the program to my Taskbar for quick access. If you've never pinned an application to the Taskbar, it's a simple process. On Windows 7, click the Start button on the Taskbar and find the program you'd like to pin. Instead of starting the application, right-click the application's icon and choose Pin to Taskbar. From that point forward, you will be able to start the application by clicking its shortcut on the Taskbar. 

  

In the image below, you can see icons for applications that I use every day, and have pinned to my Taskbar. (For instance, at the far right you can see Adobe Captivate 6 and Adobe FrameMaker 11.)

Of course, I use Adobe RoboHelp every day too. And I was bummed out when I went to pin RoboHelp to my Taskbar and did not see the Pin to Taskbar menu item. What gives? Was there something within RoboHelp's code that prevented pinning? Was my Taskbar somehow inadequate? Perhaps there is a limit to the number of applications I am allowed to pin?

It turns out that the issue is quite simple. According to the folks at Adobe (who I contacted about this), applications containing the word "help" cannot be pinned to the Taskbar. Since RoboHelp is called, well... RoboHelp, that's the end of that.

Not so fast...

While applications with the word "Help" in the name cannot be pinned to the Taskbar, the folks at Adobe told me that it's simple enough to change RoboHelp's name on the computer (without fouling up anything at all).

Find RoboHelp's application icon by clicking Start (just as you would any other application). Once again, don't start the application. Instead, right-click the icon and chooseProperties. On the General tab, change the name to something similar to RoboHelp HTML, except don't use Help. I changed my RoboHelp icon to simply RoboHTML.

  

After clicking the OK button, I was able to right-click the RoboHTML icon and, eureka, Pin toTaskbar was an available menu item. I am happy to report that RoboHelp (I mean RoboHTML) is now in its rightful home, alongside Captivate and FrameMaker.

 

*** 

Looking to learn Adobe RoboHelp quickly? I offer a live, online class covering RoboHelp once each month. It's a two-day class, and provides an awesome jump-start to using this fantastic tool.

Adobe RoboHelp: Top 10 Mistakes to Avoid When Creating a Help System

Neil Perlin has written a well-rounded white paper covering the top mistakes Help authors make when creating a Help System.

Among the mistakes:

• Not developing mechanisms to support content consistency
• Not developing mechanisms to support format consistency
• Not revisiting project design in light of 'environmental' changes
• Not planning to test QA (Quality Assurance) and usability
• Not planning to create an index  

Read more

Adobe RoboHelp: Importing & Linking Word Documents

RoboHelp allows you to integrate content created by different authors in Microsoft Word and Adobe FrameMaker. You can create projects by linking or importing Word and FrameMaker documents and then publish in different formats, including printed documentation. You can also use Word and FrameMaker documents as source files in an existing RoboHelp project. 

This article is a quick summary of the import and linking process.

Adobe RoboHelp: Apply a CSS Project-Wide in a Snap

by Kevin Siegel  

If you want to ensure that the appearance of your topics is consistent project-wide, one of the first things you should think about doing is creating a Cascading Style Sheet (CSS) and then assigning the CSS to all the topics in your project.

To assign the CSS to a single topic, open the topic. On the Formatting toolbar, click the Assign Style Sheet or Create New command. Select an existing CSS from the drop-down menu (or create a new one on the fly) and you are done.

Using the technique above will get the job done. However, you can only use this technique to assign a style sheet to one topic at a time. A typical RoboHelp project is likely to have hundreds (if not thousands) of topics.

To assign style sheets to multiple topics, use the Topic Listpod to select as many topics as you want (you can select all of the topics by clicking once on any topic and then pressing [Ctrl] [a] on your keyboard). With the topics selected, chooseEdit > Properties to open the Topic Properties dialog box.

On the Appearance tab, select the CSS you'd like to use from the list of Style Sheets at the left (in the Style Sheet area) and click the OK button.

Since multiple topics were selected before you opened the Topic Properties dialog box, all of the selected topics will now be using the same CSS.

***

Need to learn RoboHelp? We have a 2-day class starting January 30.

Adobe RoboHelp: Import Word Documents and Keep the Shapes

by Kevin Siegel  

You can do a lot of fancy stuff in Word. In fact, if you're really comfortable using the program, you can create a book that looks every bit as good as those produced by desktop publishers using programs such as QuarkXPress, Adobe InDesign or Adobe FrameMaker. (Okay, okay... I'm not going to venture any deeper into the muck... Word can create some pretty complex stuff, but it's not for me... I prefer to use FrameMaker.)

Many people who use RoboHelp also use Word as the main authoring tool for the content that will be imported into RoboHelp. Unfortunately, during the import process there's potential trouble around every corner. For instance, the more complex the Word layout, the higher the risk that something will go wrong when that layout is imported into RoboHelp.

Let's take Word's ability to wrap text around an item and the Shapes feature as examples. You can use the Shapes feature to quickly draw a line or a callout to a screen capture inserted into a Word document. The shapes may look just fine in Word. However, once imported into a RoboHelp project the resulting collection of screen capture, line and callout will rarely look very good. This is especially true if you use any of Word'sWrap Text features other than Inline with Text. (One would use Word's Wrap feature on an object to control exactly where that object appears in the Word layout.) For example, in the image below Word's Wrap Text was set to Tight. There's a callout to the right and a squiggly line. 

The image below shows the content after it has been imported into a new RoboHelp topic. Notice that the Shapes did make it into RoboHelp... but the integrity of the layout has been lost.

 

If you need to use the text wrap and Shapes feature in Word, I have a simple trick that will allow you to maintain much of the layout in RoboHelp.

1. Select the screen capture and shapes in the Word document. (Shift-click works nicely for this purpose.)
2. Cut the selected items to the clipboard (Ctrl-x).
3. On the Home tab of Word's Ribbon, click the bottom of the Paste command and choose Paste Special.
   
    
   
   The Paste Special dialog box opens.  
   
    
4. Select Picture (JPEG) from the As list and click the OKbutton.
   
   

The independent shapes have been converted into a single image. Once imported into RoboHelp, the Shapes will appear as they did in Word... and they'll Generate just fine too.

 

***

Need to learn RoboHelp? We have a 2-day class starting soon.

Adobe RoboHelp: Security Update Announced

An important vulnerability has been identified in RoboHelp and RoboHelp Server. A specially crafted URL could be used to create a cross-site scripting attack on RoboHelp installations. The solution is now available.

 

Adobe RoboHelp 8: Search, Taken Out of Context

by Kevin Siegel

One huge enhancement found in Adobe RoboHelp 8 over older versions of the program is the improved Search features you get out of the box. First of all, RoboHelp now ranks the Search terms in order of importance. Nice. Secondly, the Topic's title and first few sentences of each found topic now appear on the Search tab.

While I'm happy about the Search rankings, I've had more than one customer tell me that the topic content that appears along with the topic makes the Search panel too cluttered. No matter, you can easily disable the feature.

1. On the Single Source Layouts pod, show the Properties of the layout.
   
   
2. Click the Next button to move to the second screen.
   
   
3. From the Search Options area, deselect Show Context in Search Result.
   
   
   
   
4. Generate and view the layout; then use the Search feature.
   
   You'll notice that the topic is still found, but only the Topic Title appears.
   
   

***

Looking for training on Adobe RoboHelp 8? I teach a live, online RoboHelp class once each month. Click here to learn more.

***

Follow me on Twitter: www.twitter.com/kevin_siegel

Adobe RoboHelp: Synchronize the TOC Automatically

by Kevin Siegel

One of the three most common features of any help system is the Table of Contents (the Index and Search features are the others). However, even while most Help Authors take the time to create a detailed and seemingly helpful TOC, most Help System customers will not look to the TOC first when they are trying to get help. Instead, customers they will typically look to Search the Help System or use the Index.

Why don't Help customers look to the TOC first when looking for Help? As helpful as the TOC might seem to a Help author, the TOC is typically laid out in a logical order that's only logical to the person who created the TOC.

If customers saw the topic they were looking for on the TOC, there's a good chance they would click the topic on the TOC and open the topic. The problem is that a typical TOC might be made up of books inside of books inside of books. There is simply very little chance that the topic in question is open for the customer to click.

RoboHelp's Synchronize Table of Contents feature will automatically show where a topic is located on the TOC while customers use the Index or Search feature to get help.

On the Single Source Layouts pod, show the Properties of either  FlashHelp or WebHelp. Click the Next button and select Synchronize Table of Contents and then select Automatically from the drop-down menu at the right.




Generate and view your project. Use either Search or the Index to find a topic that is on the TOC. The topic will be highlighted on the Table of Contents. Believe it or not, the more your customers see the topic on the TOC, the more likely it will be that they will use the TOC to find and open the topic in the future.

***

Need to learn Adobe RoboHelp 8... and fast? I'm teaching a live, online RoboHelp class at the end of this week (April 29-30). Click here to sign up or learn more.

***

Follow me on twitter: http://twitter.com/kevin_siegel.

Adobe RoboHelp: Why Type It When RoboHelp Will Do it For You?

by Kevin Siegel

 

How many times have you found yourself adding the same information to your RoboHelp topics over and over again. Maybe it's the name of your CEO. Maybe it's your corporation's "mother paragraph" (the paragraph that tells customers what your company is all about).

 

Believe it or not, RoboHelp has the ability to replace a few characters you might type on your keyboard (such as the letters zzz) with a phrase, sentence... even multiple sentences). All you need to do is put RoboHelp's AutoCorrect feature on the job.

1. Open any of your project topics.
   
   
2. Choose Tools > Spelling Options and select the AutoCorrect tab.
   
   
3. In the Replace field, type some text (such as the letters zzz).
   
   
4. In the With field, type the text you would like to appear should you type the letters in the Replace field (in the example below, I typed three sentences into the With field.
   
   
   
   
5. Click the Add button.
   
   
6. Click the OK button.
   
   
7. Open any topic, press your [spacebar] and then type the letters you typed into the Replace field (such as zzz).
   
   
8. Press [spacebar] one final time and BAM! The letters have been replaced by whatever you typed in the Replace field.

***

Need to learn Adobe RoboHelp 8? And fast? I'm teaching an online RoboHelp class at the end of this month (April 29-30). Click here to sign up or learn more.

***

Follow me on twitter: http://twitter.com/kevin_siegel.