An Overview of RoboHelp 7
Who Am I? <ul><li>Neil Perlin - Hyper/Word Services. </li></ul><ul><ul><li>In tech. comm. since ‘79 at DEC. </li></ul></ul...
Purpose of This Workshop <ul><li>Look at what’s new in RoboHelp 7. </li></ul><ul><li>Look briefly at the larger Technical ...
Seminar Contents <ul><li>1 – Review of RoboHelp and TCS </li></ul><ul><li>2 – Create a RoboHelp Project </li></ul><ul><li>...
1 – Review of RoboHelp and TCS <ul><li>RoboHelp 7 </li></ul><ul><li>TCS </li></ul>
<ul><li>RoboHelp 7 </li></ul>
What Is RoboHelp? <ul><li>An  online content authoring tool – not a help authoring tool  used to create: </li></ul><ul><ul...
A Quick Tour <ul><li>RoboHelp essentially consists of: </li></ul><ul><ul><li>WYSIWYG and HTML editors. </li></ul></ul><ul>...
RoboHelp 7’s Main Screen
Compared To RoboHelp 6’s
What’s New In RoboHelp 7? <ul><li>“Pod-ized” and customizable workspace. </li></ul><ul><li>Allows multiple ToCs and indexe...
What’s New In RoboHelp 7? <ul><li>Updated RoboSource 3 VCS. </li></ul><ul><ul><li>Actually updated in RoboHelp 6… </li></u...
What’s Not In RoboHelp 7? <ul><li>Authoring in native XML. </li></ul><ul><ul><li>Not consistent with FrameMaker 8’s suppor...
<ul><li>TCS (Technical Communication Suite) </li></ul>
What Is TCS? <ul><li>Suite consisting of: </li></ul><ul><ul><li>RoboHelp 7 </li></ul></ul><ul><ul><li>FrameMaker 8 </li></...
RoboHelp and TCS Integration <ul><li>Some integration at the interface level: </li></ul><ul><ul><li>Can launch Captivate a...
2 – Create a RoboHelp Project <ul><li>Output Language and Format   </li></ul><ul><li>Start a New Project </li></ul><ul><li...
<ul><li>Start a New Project </li></ul>
Output Language and Format <ul><li>Language – HTML. </li></ul><ul><li>Format – WebHelp, a now-common format pioneered in R...
WebHelp Distribution Requirements <ul><li>Distribution </li></ul><ul><ul><li>All files in the project’s WebHelp subfolder....
New Project Dialog Box
New Project Dialog Box <ul><li>The format you select becomes the default. </li></ul><ul><li>But you can test-output the pr...
New Project Wizard Screen
New Project Wizard Screen <ul><li>Title… – The project title. </li></ul><ul><li>File name… – The name for all the  project...
Ex. 1: Start the Project
<ul><li>Create Content </li></ul>
Creating New Topics <ul><li>Topics contain the content, graphics, links, and formatting. </li></ul><ul><li>Each topic is a...
New Topic - General Tab
General Tab <ul><li>Topic Title – The title of the topic. </li></ul><ul><li>File name – The topic’s HTM file name. </li></...
Previewing Topics <ul><li>To preview a topic without compiling the entire project: </li></ul><ul><ul><li>Display the topic...
Ex. 2: Add Topics
<ul><li>Add a Table of Contents Tab </li></ul>
The Contents Tab in WebHelp <ul><li>No skin With a skin </li></ul>
Contents Tab Objects <ul><li>Headings – Shown by  and  . </li></ul><ul><ul><li>Can have an unlimited number of sub-heads a...
TOC Pod Mini-Toolbar <ul><li>Located at the top of the TOC pod. </li></ul><ul><ul><li>New TOC Book – Add a    head or subh...
New TOC Book - General Tab
General Tab <ul><li>…Title – Head on the Contents tab. </li></ul><ul><li>…Variables – Variable to use for the head. </li><...
New TOC Page - General Tab
General Tab <ul><li>…Title – Title to appear on the Contents tab. </li></ul><ul><li>…Variables – Variable to use for the t...
Ex. 3: Add a Contents Tab
<ul><li>Add an Index Tab </li></ul>
The Index Tab in WebHelp <ul><li>No skin With a skin </li></ul>
How to Add Index Keywords <ul><li>The New Topic dialog box’s Index tab. </li></ul><ul><ul><li>Which you tried when you add...
“Existing Text” Method <ul><li>The Index tab and pod methods take you out of the topic that you’re indexing. </li></ul><ul...
Ex. 4: Create the Index Tab
<ul><li>Create Links </li></ul>
Jumps (Hyperlinks) <ul><li>Take you from a starting topic to a target topic. </li></ul><ul><ul><li>The target topic usuall...
Ex. 5: Create Links
<ul><li>Inserting a Graphic </li></ul>
Image Dialog Box
Image Dialog Box Fields <ul><li>Image Name – The image file name. </li></ul><ul><li>Text Wrapping – To specify how the ima...
Ex. 6: Insert an Image
<ul><li>Generate the Output - WebHelp </li></ul>
Building the WebHelp <ul><li>There are two ways to build: </li></ul><ul><ul><li>If you already set the build options, clic...
WebHelp General Screen
WebHelp General Screen <ul><li>Select Output Folder/Start Page – Output folder and start page for the project. </li></ul><...
WebHelp General Screen <ul><li>Skin – A “faceplate” for the project. </li></ul><ul><ul><li>Default – Uses eHelp’s default ...
WebHelp General Screen <ul><li>Glossary – The glossary to use if you created more than one. </li></ul><ul><li>Default Topi...
WebHelp General Screen <ul><li>W3C Compliant… – Ensures clean code but may cause problems in older browsers. </li></ul><ul...
To Change the Default Format <ul><li>You can change a project’s default output format if necessary. </li></ul><ul><li>Righ...
Ex. 7: Build
3 – Adding the Movie <ul><li>The Pre-Created Movie </li></ul><ul><li>Connecting the Help and    the Movie </li></ul>
The Pre-Created Movie <ul><li>I’ve created a Captivate movie for use in this help system. </li></ul><ul><li>It  demonstrat...
Connecting the Help and Movie <ul><li>You can now link from a topic in the help file to the movie. </li></ul><ul><ul><li>N...
Ex. 8: Link the Help and Movie
Thank you...  Questions? Hyper/Word Services 978-657-5464 [email_address] www.hyperword.com
Hyper/Word Services Offers… <ul><li>Training • Consulting • Development </li></ul><ul><ul><li>Flare  •  RoboHelp  •  RoboI...
Upcoming SlideShare
Loading in …5
×

An Overview of RoboHelp 7

6,981 views

Published on

Presented by Neil Perlin at Documentation and Training West, May 6-9, 2008 in Vancouver, BC.

With two releases of RoboHelp in 2007, Adobe is working to restore its place in the help authoring world after several uncertain years. If you’’re a RoboHelp X5 user who’s been waiting to see where RoboHelp was going, come to this workshop. Version 7 offers the most significant interface changes in years, and some significant new features. Plus you can use it with Captivate and Acrobat to build multi-modal help. This workshop offers a hands-on overview where you’’ll use RoboHelp 7 to create a simple help system and look at its integration with the rest of the Adobe Technical Communication Suite.

Published in: Business, Technology
0 Comments
2 Likes
Statistics
Notes
  • Be the first to comment

No Downloads
Views
Total views
6,981
On SlideShare
0
From Embeds
0
Number of Embeds
43
Actions
Shares
0
Downloads
150
Comments
0
Likes
2
Embeds 0
No embeds

No notes for slide
  • 1
  • An Overview of RoboHelp 7

    1. 1. An Overview of RoboHelp 7
    2. 2. Who Am I? <ul><li>Neil Perlin - Hyper/Word Services. </li></ul><ul><ul><li>In tech. comm. since ‘79 at DEC. </li></ul></ul><ul><ul><li>Hypertext since ’85, WinHelp since ‘90. </li></ul></ul><ul><ul><li>HTML since ‘91. </li></ul></ul><ul><ul><li>Using RoboHelp etc since ’91. </li></ul></ul><ul><ul><li>Training/consulting on RoboHelp etc since ’95. </li></ul></ul><ul><ul><li>Training/consulting on XML, single-sourcing, mobile, structured authoring since ‘98. </li></ul></ul><ul><ul><li>STC’s lead W3C rep – ’02 – ‘05. </li></ul></ul>
    3. 3. Purpose of This Workshop <ul><li>Look at what’s new in RoboHelp 7. </li></ul><ul><li>Look briefly at the larger Technical Communication Suite. </li></ul><ul><li>Show RoboHelp’s overall ease of use. </li></ul>
    4. 4. Seminar Contents <ul><li>1 – Review of RoboHelp and TCS </li></ul><ul><li>2 – Create a RoboHelp Project </li></ul><ul><li>3 – Link to a Captivate Movie </li></ul>
    5. 5. 1 – Review of RoboHelp and TCS <ul><li>RoboHelp 7 </li></ul><ul><li>TCS </li></ul>
    6. 6. <ul><li>RoboHelp 7 </li></ul>
    7. 7. What Is RoboHelp? <ul><li>An online content authoring tool – not a help authoring tool used to create: </li></ul><ul><ul><li>Online help, plus ... </li></ul></ul><ul><ul><li>Online documentation. </li></ul></ul><ul><ul><li>Online tutorials. </li></ul></ul><ul><ul><li>Online sales brochures. </li></ul></ul><ul><ul><li>Other online material. </li></ul></ul>
    8. 8. A Quick Tour <ul><li>RoboHelp essentially consists of: </li></ul><ul><ul><li>WYSIWYG and HTML editors. </li></ul></ul><ul><ul><li>Contents, index, glossary, and other editors. </li></ul></ul><ul><ul><li>A topic previewer. </li></ul></ul><ul><ul><li>Project management and reporting features. </li></ul></ul><ul><ul><li>An image map editor. </li></ul></ul><ul><ul><li>Output creation and conversion features. </li></ul></ul><ul><ul><ul><li>Easy to convert between HTML-based formats. </li></ul></ul></ul>
    9. 9. RoboHelp 7’s Main Screen
    10. 10. Compared To RoboHelp 6’s
    11. 11. What’s New In RoboHelp 7? <ul><li>“Pod-ized” and customizable workspace. </li></ul><ul><li>Allows multiple ToCs and indexes for single sourcing. </li></ul><ul><li>Snippets. </li></ul><ul><ul><li>And variables, if you’re coming from X5. </li></ul></ul><ul><ul><li>Note that snippets, variables, and build tags let you create a virtual, quasi-CMS. </li></ul></ul><ul><li>Cleaner code – RIP kadov. </li></ul><ul><li>FlashHelp Pro. </li></ul>
    12. 12. What’s New In RoboHelp 7? <ul><li>Updated RoboSource 3 VCS. </li></ul><ul><ul><li>Actually updated in RoboHelp 6… </li></ul></ul><ul><li>Support for: </li></ul><ul><ul><li>Unicode and double-byte characters. </li></ul></ul><ul><ul><li>Word 07. </li></ul></ul><ul><ul><li>Vista. </li></ul></ul><ul><ul><li>Framemaker 8 support. </li></ul></ul><ul><ul><ul><li>Imports FM and book, in addition to MIFs. </li></ul></ul></ul><ul><ul><li>MDI (Multiple Document Interface). </li></ul></ul>
    13. 13. What’s Not In RoboHelp 7? <ul><li>Authoring in native XML. </li></ul><ul><ul><li>Not consistent with FrameMaker 8’s support for XML and DITA. </li></ul></ul><ul><li>No multi-directional workflow. </li></ul><ul><ul><li>FrameMaker  RoboHelp but not RoboHelp  FrameMaker. </li></ul></ul><ul><li>No Web 2.0 features (depending on your definition of Web 2.0). </li></ul><ul><li>No workflow support. </li></ul>
    14. 14. <ul><li>TCS (Technical Communication Suite) </li></ul>
    15. 15. What Is TCS? <ul><li>Suite consisting of: </li></ul><ul><ul><li>RoboHelp 7 </li></ul></ul><ul><ul><li>FrameMaker 8 </li></ul></ul><ul><ul><li>Captivate 3 </li></ul></ul><ul><ul><li>Acrobat 3D 8 </li></ul></ul>
    16. 16. RoboHelp and TCS Integration <ul><li>Some integration at the interface level: </li></ul><ul><ul><li>Can launch Captivate and import Captivate movies. </li></ul></ul><ul><ul><li>Can import FrameMaker files in FM, book, MIF formats. </li></ul></ul><ul><ul><li>Cannot export to FrameMaker. </li></ul></ul>
    17. 17. 2 – Create a RoboHelp Project <ul><li>Output Language and Format </li></ul><ul><li>Start a New Project </li></ul><ul><li>Create Content </li></ul><ul><li>Add a Contents Tab </li></ul><ul><li>Add an Index Tab </li></ul><ul><li>Create Links </li></ul><ul><li>Add Graphics </li></ul><ul><li>Generate the Output </li></ul>
    18. 18. <ul><li>Start a New Project </li></ul>
    19. 19. Output Language and Format <ul><li>Language – HTML. </li></ul><ul><li>Format – WebHelp, a now-common format pioneered in RoboHelp. </li></ul><ul><ul><li>Pros: </li></ul></ul><ul><ul><ul><li>Platform and browser independent. </li></ul></ul></ul><ul><ul><ul><li>Runs locally, from network drives, or servers. </li></ul></ul></ul><ul><ul><ul><li>Easy to learn – “Everyone knows the web.” </li></ul></ul></ul><ul><ul><li>Cons: </li></ul></ul><ul><ul><ul><li>Proprietary codes. </li></ul></ul></ul><ul><ul><ul><li>IT may balk at having “100s or 1000s of HTMs!” </li></ul></ul></ul>
    20. 20. WebHelp Distribution Requirements <ul><li>Distribution </li></ul><ul><ul><li>All files in the project’s WebHelp subfolder. </li></ul></ul><ul><li>Configuration </li></ul><ul><ul><li>A modern browser, and that’s it. </li></ul></ul><ul><ul><li>Essentially a “zero footprint” installation. </li></ul></ul>
    21. 21. New Project Dialog Box
    22. 22. New Project Dialog Box <ul><li>The format you select becomes the default. </li></ul><ul><li>But you can test-output the project in any other format or change the default at any time. </li></ul><ul><li>WebHelp – WebHelp project. </li></ul><ul><li>WebHelp Pro – Adds server-based usage reports, virtual merge, natural-language search. </li></ul>
    23. 23. New Project Wizard Screen
    24. 24. New Project Wizard Screen <ul><li>Title… – The project title. </li></ul><ul><li>File name… – The name for all the project control files – HHP, HHC, etc. </li></ul><ul><li>Location… – The drive and folder that will contain the project’s files. </li></ul><ul><li>…first topic – The first topic in the project. </li></ul><ul><ul><li>Can be the first real topic or just a throwaway to get the project started. </li></ul></ul>
    25. 25. Ex. 1: Start the Project
    26. 26. <ul><li>Create Content </li></ul>
    27. 27. Creating New Topics <ul><li>Topics contain the content, graphics, links, and formatting. </li></ul><ul><li>Each topic is a separate HTML file. </li></ul><ul><li>You can: </li></ul><ul><ul><li>Create new topics in RoboHelp, using it like Framemaker or Word. </li></ul></ul><ul><ul><li>Import existing HTML, DOC, Framemaker MIF and FM, PDF, and XML material. </li></ul></ul>
    28. 28. New Topic - General Tab
    29. 29. General Tab <ul><li>Topic Title – The title of the topic. </li></ul><ul><li>File name – The topic’s HTM file name. </li></ul><ul><li>Template – The template for this topic. </li></ul><ul><ul><li>The default is the one previously used. </li></ul></ul><ul><ul><li>None – uses the settings from the default CSS. </li></ul></ul>
    30. 30. Previewing Topics <ul><li>To preview a topic without compiling the entire project: </li></ul><ul><ul><li>Display the topic in the topic pane and select View > Item or press Ctrl/W, or... </li></ul></ul><ul><ul><li>Right-click the topic on the Project Manager tab or Topic List tab and select View from the popup menu. </li></ul></ul>
    31. 31. Ex. 2: Add Topics
    32. 32. <ul><li>Add a Table of Contents Tab </li></ul>
    33. 33. The Contents Tab in WebHelp <ul><li>No skin With a skin </li></ul>
    34. 34. Contents Tab Objects <ul><li>Headings – Shown by and . </li></ul><ul><ul><li>Can have an unlimited number of sub-heads and/or topics. </li></ul></ul><ul><ul><li>RoboHelp refers to headings as “books”. </li></ul></ul><ul><li>Topics – Shown by . </li></ul><ul><ul><li>RoboHelp refers to topics as “pages”. </li></ul></ul><ul><ul><li>Note – You lose the tab effect if you use skins. </li></ul></ul>
    35. 35. TOC Pod Mini-Toolbar <ul><li>Located at the top of the TOC pod. </li></ul><ul><ul><li>New TOC Book – Add a head or subhead. </li></ul></ul><ul><ul><li>New TOC Page – Add a topic under a head. </li></ul></ul><ul><ul><li>New Merged Project – Merge modular projects. </li></ul></ul><ul><ul><li>Left/Right/Up/Down – Change a head’s or topic’s hierarchy level or sequence. </li></ul></ul>
    36. 36. New TOC Book - General Tab
    37. 37. General Tab <ul><li>…Title – Head on the Contents tab. </li></ul><ul><li>…Variables – Variable to use for the head. </li></ul><ul><li>…With Link – Links the head to a topic. </li></ul><ul><li>…Destination – The target for a book with a link. </li></ul><ul><li>New… – Create a target topic for this head. </li></ul><ul><li>Find… – Find a topic to which to link. </li></ul><ul><li>Link To – The link’s target address. </li></ul>
    38. 38. New TOC Page - General Tab
    39. 39. General Tab <ul><li>…Title – Title to appear on the Contents tab. </li></ul><ul><li>…Variables – Variable to use for the title. </li></ul><ul><li>…Destination – The target topic or anchor. </li></ul><ul><li>New… – Create a new topic. </li></ul><ul><li>Find… – Search for a topic to which to link. </li></ul><ul><li>Link To – The link’s target address. </li></ul>
    40. 40. Ex. 3: Add a Contents Tab
    41. 41. <ul><li>Add an Index Tab </li></ul>
    42. 42. The Index Tab in WebHelp <ul><li>No skin With a skin </li></ul>
    43. 43. How to Add Index Keywords <ul><li>The New Topic dialog box’s Index tab. </li></ul><ul><ul><li>Which you tried when you added the topics. </li></ul></ul><ul><li>The Index and Topic List pods together. </li></ul><ul><li>Existing text. </li></ul><ul><li>The Smart Index Wizard. </li></ul>
    44. 44. “Existing Text” Method <ul><li>The Index tab and pod methods take you out of the topic that you’re indexing. </li></ul><ul><li>The “existing text” method keeps you in the topic. </li></ul><ul><li>You can select text to use as an index entry and code it with just a few mouse clicks. </li></ul><ul><ul><li>Highlight the desired word(s), right-click, and select Add To > Index Keyword. </li></ul></ul>
    45. 45. Ex. 4: Create the Index Tab
    46. 46. <ul><li>Create Links </li></ul>
    47. 47. Jumps (Hyperlinks) <ul><li>Take you from a starting topic to a target topic. </li></ul><ul><ul><li>The target topic usually replaces the starting topic in the same window. </li></ul></ul><ul><ul><li>The target topic may open in another window. </li></ul></ul><ul><li>You can turn text or graphics into jumps. </li></ul><ul><li>You can add “bookmarks” to target topics and jump to them rather than to the top of the target topic. </li></ul>
    48. 48. Ex. 5: Create Links
    49. 49. <ul><li>Inserting a Graphic </li></ul>
    50. 50. Image Dialog Box
    51. 51. Image Dialog Box Fields <ul><li>Image Name – The image file name. </li></ul><ul><li>Text Wrapping – To specify how the image aligns with any surrounding text. </li></ul><ul><li>Screen Tip – To specify text to pop up if a user hovers the pointer over the image. </li></ul><ul><ul><li>The <IMG> tag’s ALT attribute. </li></ul></ul><ul><li>Size/Margins/Borders – To set the image’s height, width, margins, and borders. </li></ul>
    52. 52. Ex. 6: Insert an Image
    53. 53. <ul><li>Generate the Output - WebHelp </li></ul>
    54. 54. Building the WebHelp <ul><li>There are two ways to build: </li></ul><ul><ul><li>If you already set the build options, click Generate Primary Layout on the toolbar. </li></ul></ul><ul><ul><li>To set or change options: </li></ul></ul><ul><ul><ul><li>Select File > Generate Primary Layout or </li></ul></ul></ul><ul><ul><ul><li>Double-click WebHelp (Primary Layout) on the Single Source Layouts pod. </li></ul></ul></ul>
    55. 55. WebHelp General Screen
    56. 56. WebHelp General Screen <ul><li>Select Output Folder/Start Page – Output folder and start page for the project. </li></ul><ul><ul><li>… folder – WebHelp folder under !SSL!. </li></ul></ul><ul><ul><li>… start page – Launcher – <projname>.HTM. </li></ul></ul><ul><li>Use Lowercase… – Converts file names to lower case for use on Unix servers. </li></ul><ul><li>Conditional Build Expression – To create a build formula, if you used build tags. </li></ul>
    57. 57. WebHelp General Screen <ul><li>Skin – A “faceplate” for the project. </li></ul><ul><ul><li>Default – Uses eHelp’s default skin. </li></ul></ul><ul><ul><li>Traditional... – Does not use a skin. </li></ul></ul><ul><ul><li>Gallery – To select a skin from the set supplied with RoboHelp. </li></ul></ul><ul><li>Table of Contents – The TOC to use if you created more than one. </li></ul><ul><li>Index – The index to use if you created more than one. </li></ul>
    58. 58. WebHelp General Screen <ul><li>Glossary – The glossary to use if you created more than one. </li></ul><ul><li>Default Topic – The topic to display when the WebHelp starts – the home page. </li></ul><ul><li>Variables – To change a variable’s value for this output. </li></ul><ul><li>Section 508… – Enables Section 508 features. </li></ul>
    59. 59. WebHelp General Screen <ul><li>W3C Compliant… – Ensures clean code but may cause problems in older browsers. </li></ul><ul><li>Add Mark… – To run the help locally w/o getting the “blocked content” message. </li></ul><ul><ul><li>Use during development or for a local output. </li></ul></ul><ul><ul><li>But disables links to external files (DOC, XLS, PDF) and links in the preview window with no warning. </li></ul></ul>
    60. 60. To Change the Default Format <ul><li>You can change a project’s default output format if necessary. </li></ul><ul><li>Right-click the desired new format on the Single Source Layout pod and select Set As Primary Layout. </li></ul><ul><li>This means you’ll never paint yourself into a corner by picking the wrong format at the beginning of a project. </li></ul>
    61. 61. Ex. 7: Build
    62. 62. 3 – Adding the Movie <ul><li>The Pre-Created Movie </li></ul><ul><li>Connecting the Help and the Movie </li></ul>
    63. 63. The Pre-Created Movie <ul><li>I’ve created a Captivate movie for use in this help system. </li></ul><ul><li>It demonstrates how to change the base of a number using Windows’ calculator – the movie does most of the work as you watch. </li></ul><ul><li>Demo of the movie. </li></ul>
    64. 64. Connecting the Help and Movie <ul><li>You can now link from a topic in the help file to the movie. </li></ul><ul><ul><li>Note that you could also create links from the movie to topics in the help file. </li></ul></ul><ul><li>You’ll create a “Show Me” link that runs the demonstration. </li></ul>
    65. 65. Ex. 8: Link the Help and Movie
    66. 66. Thank you... Questions? Hyper/Word Services 978-657-5464 [email_address] www.hyperword.com
    67. 67. Hyper/Word Services Offers… <ul><li>Training • Consulting • Development </li></ul><ul><ul><li>Flare • RoboHelp • RoboInfo </li></ul></ul><ul><ul><li>Mimic • Captivate </li></ul></ul><ul><ul><li>XML </li></ul></ul><ul><ul><li>Single sourcing • Structured authoring </li></ul></ul>

    ×