RoboHelp 2002 - overview


Published on

This PPT provides overview of RoboHelp wiht pros and cons of RoboHelp.

Published in: Self Improvement, Technology
1 Like
  • Be the first to comment

No Downloads
Total views
On SlideShare
From Embeds
Number of Embeds
Embeds 0
No embeds

No notes for slide

RoboHelp 2002 - overview

  1. 1. RoboHelp - Overview 01/23/12 <ul><ul><li></li></ul></ul>
  2. 2. Agenda <ul><li>What is Online Help? </li></ul><ul><li>What is a Help-authoring tool (HAT)? </li></ul><ul><li>Different Help-authoring tools available </li></ul><ul><li>Features available in Robohelp </li></ul><ul><li>Difference between Robohelp and Webworks Publisher </li></ul>01/23/12 <ul><ul><li></li></ul></ul>
  3. 3. Help-authoring tool <ul><li>Online Help: Documentation/Help in electronic format </li></ul><ul><li>A help-authoring tool or HAT is a software program to create online help manuals </li></ul><ul><li>Online Help file formats: </li></ul><ul><ul><li>Adobe Portable Document Format (PDF) </li></ul></ul><ul><ul><li>Hypertext Markup Language ( HTML ) </li></ul></ul><ul><ul><li>Microsoft WinHelp (.HLP) – based on Rich Text Format </li></ul></ul><ul><ul><li>Microsoft Compressed HTML Help (.CHM) </li></ul></ul><ul><ul><li>Mac OS X Help (.HELP) </li></ul></ul><ul><ul><li>Sun JavaHelp (.js) </li></ul></ul>01/23/12 <ul><ul><li></li></ul></ul>
  4. 4. 01/23/12 <ul><ul><li></li></ul></ul>Help-authoring tool <ul><li>The basic functions of help-authoring tools are: File Input/Create => Edit => Help Output </li></ul><ul><li>File Input Formats : HATs obtain their source text either by importing it from a file produced by another program, or by allowing the author to create the text within the tool using a text editor. File formats that can be imported include HTML , Microsoft Word , MIF ( FrameMaker Interchange Format) and compiled help formats such as Microsoft WinHelp and Microsoft Compressed HTML Help . The ability to import compiled help formats is useful when the source text for those files has been lost. </li></ul><ul><li>Help Output Formats : The output from a HAT can be either a specialised help file in a format such as WinHelp or Microsoft Compiled HTML (CHM), or a general-purpose document file such as Adobe PDF or HTML . </li></ul>
  5. 5. 01/23/12 <ul><ul><li></li></ul></ul>Help-authoring tool <ul><li>Some HATs provide extra functions like: </li></ul><ul><ul><li>Automatic or assisted index generation </li></ul></ul><ul><ul><li>Automatic table of contents </li></ul></ul><ul><ul><li>Spelling checker </li></ul></ul><ul><ul><li>Image editing </li></ul></ul><ul><ul><li>Image hotspot editing </li></ul></ul><ul><ul><li>Import and export of text in XML files, for exchange with computer-assisted translation programs </li></ul></ul>
  6. 6. Common Help-Authoring Tools(HAT) <ul><li>Some common help authoring tools include: </li></ul><ul><li>RoboHelp: An easy-to-use tool to create professional Help systems and documentation for desktop and web-based applications </li></ul><ul><li>AuthorIT : A collaborative authoring tool used for single-source content management. </li></ul><ul><li>Chm maker : An easy-to-use help authoring tool for creating help files in CHM format. </li></ul><ul><li>Doc-To-Help : An authoring tool that creates various online Help formats and printed manuals from Microsoft Word or HTML source documents. </li></ul><ul><li>Webworks Publisher in association with Adobe FrameMaker : The most common tool for large technical documents. </li></ul><ul><li>Epic Editor : An XML -based authoring tool. </li></ul>01/23/12 <ul><ul><li></li></ul></ul>
  7. 7. About RoboHelp <ul><li>RoboHelp is a Help authoring tool (HAT) created by the eHelp Corporation and now owned by Macromedia. </li></ul><ul><li>Used by technical writers to create help files in various formats, including: </li></ul><ul><ul><ul><li>FlashHelp </li></ul></ul></ul><ul><ul><ul><li>Microsoft WinHelp </li></ul></ul></ul><ul><ul><ul><li>Microsoft Compressed HTML Help </li></ul></ul></ul><ul><ul><ul><li>Sun JavaHelp </li></ul></ul></ul><ul><ul><ul><li>WebHelp </li></ul></ul></ul><ul><ul><ul><li>Oracle Help for Java </li></ul></ul></ul><ul><ul><ul><li>XML </li></ul></ul></ul><ul><ul><ul><li>Microsoft Word </li></ul></ul></ul><ul><ul><ul><li>PDF </li></ul></ul></ul>01/23/12 <ul><ul><li></li></ul></ul>
  8. 8. System Requirements <ul><li>RoboHelp Office - System Requirements : </li></ul><ul><ul><li>Pentium 300 MHz or faster </li></ul></ul><ul><ul><li>128 MB RAM (256 MB recommended) </li></ul></ul><ul><ul><li>32-bit operating system - Windows XP, ME, 2000, 98, or NT 4.0 </li></ul></ul><ul><ul><li>MS Word 2003, 2002, 2000, 97 for authoring in MS Word-based environment </li></ul></ul><ul><ul><li>Internet Explorer 5.0 or later </li></ul></ul><ul><ul><li>200 MB available disk space </li></ul></ul>01/23/12 <ul><ul><li></li></ul></ul>
  9. 9. Features in RoboHelp <ul><li>Help Topics </li></ul><ul><li>Easily create Help topics using WYSIWIG editor to individually explain the features in your application. </li></ul>01/23/12 <ul><ul><li></li></ul></ul>
  10. 10. Features in RoboHelp <ul><li>Graphics </li></ul><ul><li>Integrate graphics, such as screenshots of particular application features, into your Help topics. </li></ul>01/23/12 <ul><ul><li></li></ul></ul>
  11. 11. Features in RoboHelp <ul><li>Hyperlinks, Pop-Ups & Image Maps </li></ul><ul><li>Add links to text and graphics that go to other topics, roll-over messages, customized pop-up windows, or URLs. </li></ul>01/23/12 <ul><ul><li></li></ul></ul>
  12. 12. Features in RoboHelp <ul><li>Table of Contents & Index </li></ul><ul><li>Easily add comprehensive navigation features so end-users can quickly find the information they need. </li></ul>01/23/12 <ul><ul><li></li></ul></ul>
  13. 13. Features in RoboHelp <ul><li>Search Function </li></ul><ul><li>Include a powerful natural language search or full-text search. (Natural language requires RoboHelp Office Pro.) </li></ul>01/23/12 <ul><ul><li></li></ul></ul>
  14. 14. Features in RoboHelp <ul><li>Glossary </li></ul><ul><li>Define unfamiliar terms for your end-users without requiring them to leave the topic they are viewing . </li></ul>01/23/12 <ul><ul><li></li></ul></ul>
  15. 15. Features in RoboHelp <ul><li>Context-Sensitive Help Add context-sensitive Help links to your application that connect directly to specific Help topics. </li></ul><ul><li>Importing Content </li></ul><ul><ul><li>Import content from HTML, Microsoft Word, Adobe FrameMaker, PDF documents, XML, or existing Help projects . </li></ul></ul>01/23/12 <ul><ul><li></li></ul></ul>
  16. 16. Features in RoboHelp <ul><li>Automated Wizards </li></ul><ul><ul><li>Table of Contents Composer </li></ul></ul><ul><ul><li>Index Designer </li></ul></ul><ul><ul><li>Glossary Wizard </li></ul></ul><ul><ul><li>Browse Sequence Editor </li></ul></ul><ul><ul><li>Related Topic Wizard </li></ul></ul>01/23/12 <ul><ul><li></li></ul></ul>
  17. 17. Features in RoboHelp <ul><li>Single Sourcing </li></ul><ul><li>Generate multiple online formats from a single project, including </li></ul><ul><ul><li>FlashHelp </li></ul></ul><ul><ul><li>WebHelp </li></ul></ul><ul><ul><li>HTML Help </li></ul></ul><ul><ul><li>WinHelp </li></ul></ul><ul><ul><li>JavaHelp </li></ul></ul><ul><ul><li>Oracle Help for Java </li></ul></ul><ul><ul><li>HTML </li></ul></ul><ul><ul><li>XML </li></ul></ul>01/23/12 <ul><ul><li></li></ul></ul>
  18. 18. Difference b/w RoboHelp & Webworks Publisher <ul><li>Webworks Publisher generates files that are ready to be compiled in the Microsoft Help Compiler. Unlike RoboHelp, you do not modify the source files directly. </li></ul><ul><li>RoboHelp provides an easy-to-use interfaces, but the problem is that you have to export the information out of FrameMaker to RTF, and you lose a lot of formatting this way. </li></ul><ul><ul><li>Spend weeks in cleaning up the RTF output from RoboHelp before you can really develop the help. </li></ul></ul><ul><ul><li>If you use in your Online Help, look at direct conversion alternatives from FrameMaker to WinHelp to avoid redoing all your formatting. </li></ul></ul>01/23/12 <ul><ul><li></li></ul></ul>