Adobe RoboHelp 8: Mini-TOC… Mighty Result

by Kevin A. Siegel

 
Mini TOCs allow you to display heading content directly within a topic. The content contained within the Mini TOCs will be made up of clickable hyperlinks, providing users not only a quick overview of longer topics, but easy navigation to the information. You can elect to use Mini TOCs with a Master Page, or insert Mini TOCs on the fly (possibly within only the longest topics in your project).
 
Add a Mini TOC Placeholder within a topic
  1. Using Adobe RoboHelp 8, open any of the longer topics in your project. Ensure that the topic has been formatted using Heading 1 and Heading 2 styles. If so, you will be able to use the contents of the Heading 2 styles in the Mini TOC.
  2. Click where you'd like the Mini TOC to appear and choose Insert > Placeholder > Mini TOC.

    The Mini TOC Options dialog box opens.

    Mini TOC dialog box.

  3. Click OK to accept the default settings.

    The Mini TOC appears in your topic.


Format the Mini TOC

  1. Double-click the Mini TOC.

    The Mini TOC Options dialog box appears again.

  2. From the Structure area, select Bulleted List.
  3. Ensure default is selected from the Bulleted List drop-down menu.
  4. From the Format area at the bottom of the dialog box, ensure Mini TOC is selected from the Apply formatting to drop-down menu.
  5. Change the Font and the Font Size to suite your taste.
  6. From the Format area, select Caption from the Apply formatting to drop-down menu.
  7. Change the Font and the Font Size to suite your taste.
  8. Change the Type Style to Bold.
  9. Click OK.

    The Mini TOC should look similar to the picture below.

    Mini TOC in the topic.


Test the Mini TOC

  1. Press [Ctrl] [w] to preview the topic.

    The Mini TOC, including its clickable links, appears within the topic. You can click any of the links to jump around the topic. You can also click the word Hide to collapse the Mini TOC.

    Mini TOC previewed

  2. Close the preview.

***
Looking for RoboHelp training? Check out our course… it will get you trained in just two days. Click here for details.

Adobe RoboHelp 8: Custom Search Terms

by Kevin A. Siegel

 
If you've spent any time using the Search feature in any Help system created with Adobe RoboHelp 8, you may have noticed that the Search results are ranked based on their relevance.

In the example below, I searched for the word procedures.

Search rankings

If a word being searched appears in the title of a topic, its rank will be higher than the word in the Index keyword list. In addition, a topic with the word appearing in a paragraph using a Heading 1 style would rank higher than the same word appearing in a paragraph using a Heading 2 style.

In the steps below, will learn how to add search terms to a topic when those terms do not actually appear in the topic. Using this technique, you'll be able to guide users to relevant topics using synonyms and antonyms.

Add Custom Search Terms to a Topic

  1. Using RoboHelp 8, right-click within any open topic and choose Topic Properties.
  2. On the General tab, type the term(s) you would like your customers to be able to type into the Search field.

    Adding a custom Search term

  3. Click OK.
  4. Generate the layout (if the layout is your primary layout, a fast way to generate is to press [ctrl] [m] on your keyboard). View the project after the project generates.
  5. On the Search tab, type the term(s) you added to the topic. The topic will be found even though the text you added to the Search field via the topic properties dialog box is not actually in the topic.

 

Note: If you want to exclude a topic from appearing on the Search tab, you can simply right-click and choose Topic Properties. On the General tab, select Exclude from Search.

Exclude from Search

***

Looking for RoboHelp training? I've got a two-day class that will get you trained in just two days. Click here for details.

Adobe RoboHelp 8: Help is in the AIR

by Kevin A. Siegel

Adobe AIR lets application developers create rich Internet applications that can run outside of a Web browser and will work identically across multiple operating systems. While Adobe AIR is a fairly new technology, many large companies such as eBay, Yahoo, AOL, and NASDAQ are already tapping into its vast power to deliver content right to the users' desktop-without the need for Internet Explorer, FireFox, Chrome or any other Web browser.

RoboHelp allows you to generate layouts for Microsoft HTML Help, WebHelp and FlashHelp. Given the ever-increasing popularity of Adobe AIR, RoboHelp developers will likely be required to deliver a generated project in the Adobe AIR format. And since Adobe created the AIR technology, it just makes sense that this format would be fully supported in RoboHelp.

Here is how to generate an Adobe Air help system.

  1. On the Single Source Layouts pod, double-click the Adobe AIR layout icon (if the icon isn't there, click the Create Layout tool at the top of the Single Source Layouts pod and select Adobe AIR from the Output Type drop-down menu).

    Adobe Air Application Help

  2. Type a number in both the Version field and the Help ID field.

    Version field and the Help ID field

    The Version number will simply help you keep versions of the AIR Application straight should you make updates available. The Help ID is used for creating Context Sensitive Help. You should discuss the numbers you should be using with your application developer.

    Now you'll need to create a Digital Certificate.

  3. To the right of the Installer Settings area, click the Create button.

    The Create Self-Signed Digital Certificate dialog box appears.

  4. Type your company name into the Publisher Name area.
  5. Type a Password into both the Password and Confirm Password fields (write down the password you just typed).
  6. Type a name into the Save As field.
  7. Click the Browse button and open a folder on your hard drive.

    Digital Certificate dialog box

  8. Click OK.

    You are now back in the Adobe AIR settings dialog box.

  9. Type the same password into the Password field that you used a moment ago.
  10. Ensure Remember Password is selected.

    More digital certificate settings

  11. Click the Save button.
  12. Generate the Layout.
  13. Right-click the Layout and choose View.

    AirHelp Output

    Nice. The Help system appears in its own window–no need for a Web browser. 

***
 
Need to learn RoboHelp in a hurry. Come join Kevin's 2-day RoboHelp class. Click here for more information.

Adobe RoboHelp 8: When It Comes to Working With Word… This is Not Your Father’s Olds

by Kevin A. Siegel

Veteran RoboHelp users saw a welcome improvement to the way Microsoft Word documents are imported into the new RoboHelp 8. If you're new to RoboHelp, of course you have nothing to compare the import process with. Let me just say that the import process reminds me of the Oldsmobile car commercials that ran some years ago… the series where "young" hipsters were always speeding along somewhere.
 
In the commercial, the passenger always says to the driver, "What kind of car is this?" The driver says, "It's an Oldsmobile!" "Oldsmobile?" asks the stunned passenger." To which the driver responds, "I know, it's not your father's Oldsmobile!"
 
The new RoboHelp is just like the new Oldsmobile's in those commercials. You might start RoboHelp expecting the same-old features and user experience. And then you start the "car," and the sound of the engine is enough to get the heart pumping.
 
Ever since Adobe revamped the interface, RoboHelp has had a sleeker, more modern look. And now, with RoboHelp 8, there's some real sizzle to that steak. Over the next few weeks, I'll cover some of the main features of the Word import process. This week, I'd like to begin with a bang. For the first time in RoboHelp history, you have a choice when you import your Word content. You can elect to import your Word documents as you have always done (via a standard import), or you can elect to import via a link.
 
When you import your document into RoboHelp via the traditional method (File > Import > Word Document), you are presented with the Content Settings dialog box shown below.
 
First import screen for Word documents
 
If you click Next, you'll see the Import dialog box shown below. At this point you would "map" your Word styles to RoboHelp styles and control how your Word document is split into new topics (via Pagination).
 
Second import screen for Word documents
 
I'll be covering that process in the coming weeks. For now, suffice it to say that clicking the Finish button would import the Word content into your RoboHelp project. Since the content will be copied into RoboHelp, the original Word content is essentially valueless. If there are changes needed in the imported content, you would make those changes from within RoboHelp. If a colleague informs you that they have made significant changes to the Word document since you imported the content into RoboHelp, you would have to make those changes manually within the RoboHelp topics. Of course, at that point, any changes that you made would be lost. Ouch!
 
Which brings me to the alternative import process: linking the Word documents into the RoboHelp project instead of copying. Instead of choosing File > Import > Word document, you would choose File > Add > Word Document (or right-click the Project Files folder on the Project Manager pod and choose Link  > Word document).
 
This time, instead of seeing either of the two dialog boxes above, the Word document appears as a single item in the Project Files folder on the Project Manager pod. At this point, you would right-click the Word document icon and choose Properties to display the Word Document Settings dialog box (shown below).
 
Imported Word file on the Project Manger pod
 
As I mentioned above, I'll be going over these specific dialog boxes over the coming weeks… there's a lot to consider which, while daunting, is a wonderful improvement over any of the frail import options back in your father's day.
 
Unlike the standard import method, the content you linked into RoboHelp will always look back to the source Word document for changes. If changes occur (maybe a team member deleted or edited some important information), you'll see an alert on the Word icon in RoboHelp. All you'd need to do is right-click the icon and choose Update to get those changes in RoboHelp. Nice!
 
Linked Word options
 
I know I've left you with a bit of a cliffhanger by not covering the options in any of the dialog boxes above. Would it make you feel better to know that it was intentional (I do try to keep the articles in this newsletter short)? So as they used to say at the end of your father's favorite show, "See you next week, same Bat-time, same Bat-channel."

 
***
 
Need to learn Adobe RoboHelp 8 fast? Attend our 2-day online training class from the comfort of your home or office. All you'll need is Adobe RoboHelp 8 installed, a headset and a reliable Internet connection. Click here to learn more.

Adobe RoboHelp: Making Topics Conditional

 
I received an email recently where a RoboHelp author had removed a topic from the TOC, but was distressed to learn that users could still use the Search tab to find the topic. In addition, the topic appeared on the index tab.
 
As this developer discovered, simply omitting a topic from the TOC does not prevent it from appearing in the generated output. When the project is generated, users who happen to Search for a word or phrase that actually appears in the topic will stumble upon the topic. Not only that, if you run the Smart Index Wizard, the topic will likely be added to the index (you'd have to manually remove the keyword from the index prior to generating).
 
Short of deleting a topic from the project, what's a developer to do? Read on…
 
  1. On the Conditional Build Tags pod, create a new condition
  2. Right-click a topic and choose Properties
  3. On the Advanced tab, select the condition you created from the Top-level Tags area (or use one of the two default conditions, Print or Online)

    Advanced: Conditional Build Tags

  4. Show the Properties of a layout (on the Single Source Layouts pod)
  5. Click the Define button to the right of Conditional Build Expression drop-down menu
  6. Double-click the tag you selected in step 3 above to move it to the Exclude from output area

    Define a Conditional Build Expression

  7. Click OK
Notice that the expression you created now appears in the Conditional Build Expression drop-down menu. If you generate this layout now, the topic you attached to the Top-level tag will not appear anywhere in the layout (not the TOC, not on the Index and not via Search).
 
Conditional Build Expression drop-down menu 
 
***
 
Need to learn Adobe RoboHelp 8 fast? Attend our 2-day online training class from the comfort of your home or office. All you'll need is Adobe RoboHelp 8 installed, a headset and a reliable Internet connection. Click here to learn more.

Adobe RoboHelp 7: Reusing Conditional Build Tags

by Kevin A. Siegel

 
Conditional Build Tags allow you to generate myriad versions of your Help System for an unlimited number of user groups. However, one thing you might want to do is reuse Conditional Build Tags used in one project with another.
 
It seems like a simple process to reusing Conditional Build Tags would be to export the tags in one project to a Tags file and then simply import that file into any project needing the tags. The problem is that none of the versions of RoboHelp (including version 7 and the just-released version 8) include an export Conditional Build Tags feature. So what's a Help Author to do? Read on…
 
There are two ways to get the Conditional Build Tags used in a RoboHelp project. Both methods involve the rhbuildtag.apj file found in all RoboHelp projects (the file is only valuable if you have created your own conditions, or edited the two defaults that come with new projects).
  1. Open the rhbuildtag.apj file containing the Conditional Build Tags you want to use in NotePad
  2. Copy the tags containing the specific conditions you want to reuse to the clipboard
  3. Open the rhbuildtag.apj file in the other project and paste

The simpler route, if you don't mind losing any build tags in the other project, is to copy rhbuildtag.apj from one project and paste/replace the file in the project folder of the other project.

***
 
We are hard at work on our "Essentials of Adobe RoboHelp 8" book and will soon begin offering virtual training classes on RoboHelp 8. Stay tuned to this newsletter for announcements.
 
*** 
 
Not ready to upgrade and need to learn Adobe RoboHelp 7? Click here.
 
Many RoboHelp authors find it's a good idea to have basic HTML skills. Click here to learn about our basic HTML class.

Adobe RoboHelp 7: Importing Captivate eLearning (with Skins)

 
If
you've created eLearning lessons in Adobe Captivate and then tried to
import the lessons into a RoboHelp project, you've probably already
seen that it's a fairly straight-forward process:

  1. Open a RoboHelp topic
  2. Choose Insert > Adobe Captivate Demo
  3. Find and open the SWF you published using Captivate
If
you've followed this process in the past, you have probably run into a
problem: if your Captivate lesson contains a skin and was published as
HTML, there are more required files needed to be imported besides the
SWF. If you don't import the skin SWF and supporting JavaScript file,
your lesson won't play properly in RoboHelp.
 
So
how do you import the Captivate lesson and its published assets? Think
Baggage… import the Captivate lesson files into the Baggage Files
folder, and then link from the RoboHelp topic to the assets in the
Baggage Files folder. Here's how…

  1. On the Project Manager pod, right-click the Baggage Files folder and choose New > Baggage File
  2. Navigate to the folder containing the published Captivate assets
  3. Select and then open all of the assets

    The imported assets will appear in the Baggage Files folder

  4. Open a RoboHelp topic and create a link from the HTML file in the Baggage Files folder to target text in the RoboHelp topic
  5. Finally, generate and test the link

    Click here if you would like to see a demonstration of this process.

 
***
 
We
are hard at work on our "Essentials of Adobe RoboHelp 8" book and will
soon begin offering virtual training classes on RoboHelp 8. Stay tuned
to this newsletter for announcements.
 
*** 
 
Not ready to upgrade and need to learn Adobe RoboHelp 7? Click here.
 
Want to learn more about HTML? Many find it's a good idea for RoboHelp authors to have basic HTML skills. Click here to learn about our basic HTML class.

Adobe RoboHelp 8: Loads of Enhancements

 
Adobe announced the release of RoboHelp version 8 last week. In the coming week, I'll be spotlighting some the hot new features… and there are plenty of them. The following is direct from the Adobe site:
 
Here is what's new:
 
Publishing Features
 
Enhanced support for Adobe AIR: Adobe AIR technology provides a revolutionary new help application that provides many new ways for users to find information, add and share comments, in a system that is always up to date. It combines the best of the Web as well as the desktop, whether the user is online or not. Authors can generate this exciting new Adobe AIR help application and package it for easy deployment and management of automatic updates.
 
Powerful Search engine: Search results are ranked by relevance (with the initial text from the topic displayed for context), search highlighting, a synonym editor and a brand new Keyword Search that can be defined to help the user find what they are looking for. Also added is a way to define search Phrases as well as Substrings. In addition, text in Adobe PDFs and MS Office documents can now be searched.
 
Enhanced Printed Documentation options: More flexibility in mapping your online output styles to the printed version in Microsoft Word or Adobe PDF.
 
Breadcrumbs/Mini TOC: Breadcrumb navigation and/or a Mini TOC can be added with placeholders on a topic basis or with Master Pages. If preferred, breadcrumbs can be added globally with a single checkmark when generating output.
 
Improved Glossary: Edited Glossary definitions are now automatically updated in glossary hotspot links.
 
Merged Help implementation: Merged project enhancements provide a visually intuitive way to merge child projects which become part of a master TOC.
 
Twisties: Twisties provide both expanded and dropdown hotspots and can now have configurable images which provide a visual cue to the user.
 
More author-friendly enhancements
 
A new Styles and Formatting pod: Quickly apply, create or edit CSS styles.
 
World class Table, List and Autonumbering: Table designs (with many new prepared templates) can now be created or modified in the Styles editor using a graphical preview and exposed formatting tools. List support now includes enhanced handling of standard HTML Lists, MultiLevel lists and customizable autonumbering.
 
Easier import of MS Word and Adobe FrameMaker files: Define common Import and Conversion Settings for consistent use of CSS and Style Mapping across all projects.
 
Linking MS Word files: By linking to MS Word files you can keep your content updated to the original source MS Word document without re-importing each time.
 
Import DITA: Topic-based content into a RoboHelp HTML project. This allows the DITA author to take advantage of RoboHelp software's rich feature set of TOC, Index, Glossary and advanced publishing options.

 

Enhanced Unicode and Language Support: There is now Unicode and language support at the topic and paragraph level.

 

FLV format now supported: For compelling eLearning and video presentations.

 
IFrame support: Include an external HTML or PDF inside a topic.
 
Single Sourcing Features
 
Brand new CSS Editor: Provides a graphical way to define Table Styles, and complex List Styles.
 
Master Pages (formerly Templates): Help separate layout and styling from content. There are new placeholders for breadcrumbs, a "mini" Table of Contents, and the Body section of each topic.
 
Resource Manager: Allows you to manage and reuse assets (including Images, Topics, Stylesheets, Multimedia and Snippets) across multiple Robohelp projects.
 
Formatted User-defined Variables (UDV): Provide a robust way to make global changes to common blocks of content throughout many topics. A major new enhancement is the addition of formatting and the inclusion of such things as images and links which are easily created in a Design and HTML editor.
 
Productivity Features
 
Scripting: Automate with built-in scripts or create your own. The entire Adobe Extended Scripting Toolkit CS4 is included with Adobe RoboHelp 8, including many ready-made scripts to get you started.
 
Integration with other Adobe applications: Adobe Captivate 4, RoboScreenCapture and RoboSource Control are separate applications that are integrated into the Adobe RoboHelp 8 interface.
 
Custom To Do List: This popular RoboHelp favorite now allows you to edit the supplied tasks and add your own items depending on your own workflows.
 
Usability Features
 
Project Manager Enhancements: RoboHelp software's strength has been its ability to help the author keep track of the many assets in a given project. Now, you can drag and drop topics and folders to create the same hierarchy used in the TOC. There is a choice to customize the list of files shown or switch to the traditional view with its virtual folders.
 
UI Enhancements: Color-coding to show pods with focus, easy close of topics in Design Editor, more tooltips on Navigation buttons and more robust right-click Context Menu support are some of the user-friendly changes to the interface.
 
Custom File Type mapping dialog: In addition to choosing your preferred HTML editor, there is an enhanced dialog to associate file extensions with your choice of applications.
 
More functionality added to existing features: Snippets can now be added to Popups and Drop-down hotspots and DHTML effects in non-IE browsers. Because of improved HHActiveX support, Glossaries and Browse Sequences can be included in the HTML Help (.chm) format in Chinese, Japanese and Korean (CJK) multibyte languages.
 
***
 
We are hard at work on our "Essentials of Adobe RoboHelp 8" book and will soon begin offering virtual training classes on RoboHelp 8. Stay tuned to this newsletter for announcements.
 
*** 
 
Not ready to upgrade and need to learn Adobe RoboHelp 7? Click here.
 
Want to learn more about HTML? Many find it's a good idea for RoboHelp authors to have basic HTML skills. Click here to learn about our basic HTML class.

Adobe RoboHelp 7: What the WYSIWYG? Use HTML!

by Kevin A. Siegel

When working with RoboHelp topics, many new Help Authors (and even a few seasoned professionals) forget that every RoboHelp topic is actually a Web page created using the hypertext markup language (HTML). 

I can't really blame a RoboHelp author for forgetting this fact because many Help Authors are not familiar with HTML (or have limited HTML experience). Thanks to RoboHelp's What You See Is What You Get (WYSIWYG) window, you can type and edit a RoboHelp topic oblivious to the HTML code being spun behind the scenes as you work.

 

While it is not necessary to be a Web master to create killer Help Systems, if you have even minimal experience using HTML, you may find it helpful to work in the HTML window.

 
Why should you bother with the HTML window? Great question! The WYSIWYG window is wonderful. However, every once in a while you'll find yourself attempting to make a change to your topic (remove a hyperlink or text formatting) and the change you are trying to make simply will not work. What the heck? It's likely that there is conflicting HTML code in the code window (likely caused by poor HTML structure when the topic was originally created and imported into RoboHelp).
 
How on earth can you fix the problem when clicking a RoboHelp tool that is supposed to do the trick simply doesn't work? Another great question. Read on…
 
  1. Open a topic in RoboHelp
  2. Click the HTML button at the bottom of the topic

    HTML Button

  3. At this point, you can quickly edit the HTML code to make changes to how your content will look back in Design view (the WYSIWYG window). In the example below, the size of the headline (currently a heading level 2 will be changed to a larger headline, a heading level 1).

    HTML Code

    H2 changed, part 1

    H2 changed, part 2

It's as simple as that. Once you switch back to Design view, the headline will grow from a level 2 to a level 1. In the images below, you can see how the two headlines would render in Design view (the heading 2 is shown first):

H2

H1

Want to learn more about Adobe RoboHelp 7? Click here.
 
Want to learn more about HTML (I think it's a good idea for RoboHelp authors to have basic HTML skills)? Click here.