Page 1 Using ADOBE ROBOHELP HTML 9 ® ®...
Page 2 This user guide is licensed for use under the terms of the Creative Commons Attribution Non-Commercial 3.0 License. This License allows users to copy, distribute, and transmit the user guide for noncommercial purposes only so long as (1) proper attribution to Adobe is given as the owner of the user guide; and (2) any reuse or distribution of the user guide contains a notice that use of the user guide is governed by these terms.
Page 3: Table Of Contents
Contents Chapter 1: Getting started Activation and registration ................... . 1 Help and support .
Page 4 USING ROBOHELP HTML 9 Contents Chapter 5: Editing and formatting RoboHelp editors ....................133 Character formatting and fonts .
Page 5 ......................208 Adobe Captivate demos .
Page 6 USING ROBOHELP HTML 9 Contents Information types (for HTML Help) ................. . . 367 Scripts .
Page 7: Chapter 1: Getting Started
Its enhanced editing and layout capabilities enable you to create professional looking content. You can publish this content to multiple channels, including Adobe AIR for an integrated online and offline user experience. With the support for the ePub format, you can now take your content authored in RoboHelp, FrameMaker, or Microsoft®...
Page 8: Help And Support
Getting started Adobe Product Improvement Program After you have used your Adobe software a certain number of times, a dialog box appears, asking whether you want to participate in Adobe Product Improvement Program. If you choose to participate, data about your use of Adobe software is sent to Adobe. No personal information is recorded or sent.
Page 9 Adobe Labs fosters a collaborative software development process. In this environment, customers quickly become productive with new products and technologies. Adobe Labs is also a forum for early feedback. The Adobe development teams use this feedback to create software that meets the needs and expectations of the community.
Page 10: What's New In Robohelp 9
Some of the third-level TOC entries are missing when Follow the steps listed in ts_cpsid_90498_en-us publishing a project to RoboHelp Server. The Adobe RoboHelp 9 uninstaller exits with an error and does Manually uninstall (remove) Adobe RoboHelp 9. not uninstall Adobe RoboHelp 9. For more information, see ts_cpsid_88189_en-us What’s new in RoboHelp 9...
Page 11 USING ROBOHELP HTML 9 Getting started The User Defined Variables pod and the Snippets pod include Enhanced User Defined Variables and Snippets pods many usability enhancements in RoboHelp 9. Both pods are now search-enabled. You can now organize snippets in categories and expand and collapse each category.
Page 12 Integration with FrameMaker 10, Adobe Captivate 5, and Acrobat 10 products such as FrameMaker 10, Adobe Captivate 5, and Acrobat 10. Leverage the latest enhancements in these products, such as support for setting a text background color at both character and paragraph levels in FrameMaker.
Page 13 USING ROBOHELP HTML 9 Getting started • While importing or linking a document, you can modify the Modify character and paragraph source styles character and paragraph styles defined in the document. In the case of linked documents, style properties modified from within Microsoft Word or FrameMaker and modified from within RoboHelp can now co-exist.
Page 14 PDF review snippets, and send it for review (Reviewers only need the free Adobe Reader to add comments to the PDF). After the review ends, import the comments into the project and view and manage the feedback from Review Pane. For step- by-step instructions, see “PDF...
Page 15: Using Robohelp Html
Getting started Define SharePoint settings in layout properties Publish Adobe® AIR® and WebHelp projects as integrated Help systems with different Dynamic user-centric content content categories. Users select the content category that's relevant for them and navigate and search within the content category.
Page 16 Getting started The capability to merge the output of multiple projects is now extended to output generated using Merged AIR Help the Adobe AIR SSL. Both Adobe AIR output types—Adobe AIR Application and Browser based Help—support merging. See “Merging Help projects”...
Page 17 USING ROBOHELP HTML 9 Getting started information about how to enable or disable browse sequences and select them for content categories, see “Configure the Adobe AIR layout” on page 284 and “Set options for generating WebHelp” on page 292. Take advantage of enhanced style mapping options to generate better PDF Enhanced Printed Documentation output output and printed documentation.
Page 18 RoboHelp 9. The layouts are set up ready for you to generate them when you have read the topics in the About folder. Both projects include the About Adobe RoboHelp 9 topic, which outlines the new features of RoboHelp 9.
Page 19: What's New In Robohelp Server 9
USING ROBOHELP HTML 9 Getting started Names of open topics appear in the drop-down list • Deselect the Allow Editing Of Multiple Topics option in Tools > Options > General to open and Single-topic mode edit one topic at a time. The tabs in the Options dialog box are now displayed in a tree view in the left Uncluttered Tools >...
Page 20 USING ROBOHELP HTML 9 Getting started Moderation settings for Adobe AIR Help comments Using the Web Administrator, you can now specify the following moderation settings for comments on Adobe® AIR® Help output: • Allow Post Anonymous • Mark Comments As Pending...
Page 21 USING ROBOHELP HTML 9 Getting started • Deploy a context in the root context • Delete contexts • Set up an admin account for RoboHelp Server using LDAP authentication or database authentication • Configure LDAP settings • Configure search indexing settings The little things •...
Page 22: Chapter 2: Exploring The Workspace
Chapter 2: Exploring the workspace Workspace overview You create and manipulate your projects using various elements, such as pods, panes, bars, and windows. Any arrangement of these elements is called a workspace. The RoboHelp workspace includes pods, panes, and customizable toolbars and menus. Expanding menus track commands you frequently use and display them on a shortened version of each menu.
Page 23: Working With Pods
Create New Import a Help project, such as an HTML Help project, Word document, and all other available types. Import Access forums, developer centers, knowledgebase articles, and other online content. Resources Access information about Adobe products. News Announcements Last updated 12/14/2011...
Page 24: Contents
USING ROBOHELP HTML 9 Exploring the workspace Access the complete online Help. View Online Help Access a set of videos for a quick tour of RoboHelp features. Quick Tour Of RoboHelp Project Manager pod The Project Manager pod contains various folders where you create and delete project files, or edit their properties. It also has folders for various key project components, such as the table of contents, the index, and the glossary.
Page 25 USING ROBOHELP HTML 9 Exploring the workspace Snippets are stored in a Snippet library as separate files with the .hts extension. In the Snippets pod, you can organize them in categories, expanding or collapsing the categories for easy viewing. The category names appear in a sorted order in the Snippets pod and in the Insert dialog box.
Page 26: Environments
USING ROBOHELP HTML 9 Exploring the workspace Resource Manager pod Resource Manager stores all the common resources to use across projects and allows for quick access and management of common resource files. Specify the various shared folders that store resource files to use across projects. While a shared Shared Locations location can contain files of any type, Resource Manager displays only those that match defined file types (Add/Edit Categories).
Page 27: Menus And Toolbars
• Delete the RHS file from the location where it was stored. • Click Start > Run. In the Open box, type regedit and click OK. Locate the MRUENVFile[n] variable in HKEY_CURRENT_USER > Software > Adobe > RoboHelp > 9.00 > Common and delete the string assigned to the variable.
Page 28: Create Or Remove Keyboard Shortcuts
USING ROBOHELP HTML 9 Exploring the workspace • To edit a button image, right-click the button and select Edit Button Image. Use the Button Editor tools and modify the image. Check the preview and click OK. • To edit menus and toolbar items, click the Options tab. Set the following options as needed: Select this option to show all the available menus.
Page 29: Configure General Settings
USING ROBOHELP HTML 9 Exploring the workspace Remove or reset keyboard shortcuts Select View > Toolbars > Customize. Click the Keyboard tab. Do one of the following: • To remove a keyboard shortcut, select the category and command for the shortcut to remove. Select the shortcut in Key Assignments, and click Remove.
Page 30 USING ROBOHELP HTML 9 Exploring the workspace Enable, disable, or reset notifications By default, notifications are enabled. Some notifications include an option (Don’t Ask Me Again) to suppress their display. • To enable or disable all notifications, deselect or select Tools > Options > General > Do Not Show Notifications. •...
Page 31: Chapter 3: Projects
3. Import files. You can import HTML files, Microsoft Word files (.doc, .docx, .docm, .rtf), FrameMaker books and documents (.book, .bk, .fm, .frm, .mif), XML files (.xml), and Adobe PDF files (.pdf). 4. Develop the navigation. Based on the hierarchy, or organization scheme, of the content, create links among topics and to external content if necessary.
Page 32: Contents
USING ROBOHELP HTML 9 Projects Projects are collections of files. The project file (XPJ file) contains information about the content and properties of the project. Whenever you change the project, this file (and any other affected file) is updated automatically. Project files consist of the following: Project files contain topics with content and information about the location of topics, images, index, TOC, Content...
Page 33: Contents
USING ROBOHELP HTML 9 Projects Files in a project Main project file (XPJ) The project file (.xpj) is XML-based. You can open project files with the .mpj extension, the format for older versions of RoboHelp, but they convert to XPJ files. Folder files (FPJ) Each project folder has an FPJ file that lists the folder contents.
Page 34 You can organize the content as needed, format using CSS or Word template styles, and produce formatted and structured Word documents or PDF files. The Adobe AIR output type allows you to generate Help in Adobe AIR format. Generate your content in Adobe AIR the cross-platform Adobe AIR Help format that brings a host of enhancements, such as these: •...
Page 35: Create And Manage Projects
USING ROBOHELP HTML 9 Projects • Rich commenting and auto-updates • Browser-based Help, with both offline and online content. • Ability to add and access RSS feeds • Enhanced search End-user viewer requirements End-user system WebHelp/Pro FlashHelp/Pro Microsoft HTML JavaHelp* Oracle Help AIR Help Help...
Page 36 USING ROBOHELP HTML 9 Projects Create a Help system to outline guidelines for a department in a company. For example, Department Guidelines you can create Help for a human resources department, outlining guidelines on recruitment and selection, flexible working hours, and so on. Create a Help system with samples on how to write a disaster recovery plan.
Page 37 USING ROBOHELP HTML 9 Projects Select styles to map to the RoboHelp styles. For information about different conversion options for FrameMaker documents, see “Conversion basics” on page 70. For information about different conversion options for Word documents, see “Converting Word styles to RoboHelp styles”...
Page 38 The My RoboHelp Projects folder is the default working folder where RoboHelp stores all My RoboHelp Projects projects. This folder is placed in the My Documents folder when Adobe RoboHelp is installed. When you start Adobe RoboHelp, projects stored in the My RoboHelp Projects folder are automatically listed in the Starter pod under the Recent Projects list.
Page 39 USING ROBOHELP HTML 9 Projects More Help topics “Add a RoboHelp project to version control” on page 95 Pin a project to the list of recently opened projects By default, the list of recent projects that appears in the Starter pod and in the File menu displays up to the last ten projects opened.
Page 40 USING ROBOHELP HTML 9 Projects Set options on the Phrases pane Modify words in the Phrases file ProjectName.phr. This tab contains a phrase list the Smart Index Wizard includes in keyword searches. For example, make project settings one phrase, not two words. You can add, rename, and delete words.
Page 41 USING ROBOHELP HTML 9 Projects Rename a project When you rename a project, the main project file (.xpj) and all other project files are renamed. Note: The TOC, index, and glossary files are not renamed. When you rename a project, the project closes and reopens. Any changes made since last saving are saved. Note: You cannot rename projects under version control.
Page 42: Manage Files
USING ROBOHELP HTML 9 Projects • The TOC items don’t change dynamically as you change them in the Project Manager or in a topic. Drag folders • Drag a topic or a folder above or below another topic or folder. For linked documents, you can drag only above the linked documents.
Page 43 USING ROBOHELP HTML 9 Projects Edit the list of recently opened projects Recently opened projects are listed in the RoboHelp Starter pod. Select Tools > Options. Click the Recent Projects tab. • To change the number of files listed, specify a number in the Max Projects box. •...
Page 44 USING ROBOHELP HTML 9 Projects You can also browse to a program not listed in the program list. Add an HTML editor mapping Select Tools > Options. Click File Association tab. For HTML editors, click Add. Select from the recommended or other programs registered to edit or view .html or .htm files. Note: When you select a program, its name and location appear in the Name and Location box.
Page 45: Contents
You can drag an image from this folder into the Design Editor to add images to topics. You can also rename images in this folder by selecting the image and pressing F2. All sound and video files used in your project are saved in this folder. Adobe Captivate demos (SWF files) Multimedia are also stored here.
Page 46: Contents
USING ROBOHELP HTML 9 Projects Rename folders Use the Project Manager to rename folders. Select the Project Files folder in the Project Manager pod. Right-click the folder. Select Rename. Type the new name. Don’t include special characters, and avoid spaces, especially for WebHelp and FlashHelp. Press Enter.
Page 47: Contents
Video files (AVI and MOV formats). Double-click to identify topics that use them and view file information. Drag video files into topics in Design Editor to add them. Adobe Captivate files (SWF files). Double-click to identify topics that use them and view file information. Drag Adobe Captivate files into topics in Design Editor to add them.
Page 48: Authoring Content In Multiple Languages
USING ROBOHELP HTML 9 Projects You can map filename extensions to applications. For example, map GIF files to Adobe Photoshop®. When you right- click a GIF file from the Images folder and select Edit, the file opens in Photoshop. More Help topics “Define chapter...
Page 49 USING ROBOHELP HTML 9 Projects Languages Spell Check User Dictionary Thesaurus Auto correct Dutch (The Netherlands) Norwegian Bokmâl (Norway) Norwegian Nynorsk (Norway) Portuguese (Brazil) Swedish (Sweden) Croatian (Croatia) Portuguese (Portugal) French (Canada) Finnish (Finland) Catalan (Spain) Russian (Russia) Bulgarian (Bulgaria) Czech (Czech Republic) Polish (Poland) Romanian (Romania)
Page 50: Contents
USING ROBOHELP HTML 9 Projects Translation workflows You can create content for multiple languages in a single RoboHelp HTML project by translating the English content in the same project. You can then create tables of contents, indexes, glossaries, and conditional build tags in the project for the desired languages.
Page 51: Contents
USING ROBOHELP HTML 9 Projects Create a project with a different language Select File > New > Project. In the New tab, double-click Project Type. The New Project Wizard appears. Note: To create a JavaHelp or Oracle Help project, first create a Microsoft HTML Help project, and then add a new layout to that project.
Page 52 USING ROBOHELP HTML 9 Projects • If you do not include the RoboHHRE.LNG file, or omit some values, your project defaults to the English values shown in the example. • If you are using a skin, the default text is translated to the default language. If you customized the text in a skin, the skin text overrides customizations in the LNG file.
Page 53 USING ROBOHELP HTML 9 Projects Without Unicode, operating systems use a code-page-based environment, in which each language script has its own table of characters. Content based on the code page of one operating system seldom translates correctly on an operating system that uses another code page. For example, suppose you are running the English version of the Microsoft Windows®...
Page 54: Import Pdf Files
33 Import PDF files You can convert an Adobe PDF file (version 1.4 or later) into a single topic or multiple topics for a new or existing project. • You cannot import SWFs, PDF portfolios, and encrypted PDF files (files that require a password).
Page 55 • If the PDF contains 3D images, save the PDF in version 5 to import the images. • TOCs or index field codes convert to PDF. • Adobe Reader® or Adobe Acrobat® is not required to import PDF files. • Sometimes fonts in PDF files do not convert correctly when imported into HTML.
Page 56: Importing And Linking Microsoft Word Documents
USING ROBOHELP HTML 9 Projects Import PDF files into a project In the Project Manager pod, right-click Project Files. Select the file to import into. Select File > Import > PDF Document. Select one or more PDF files. Click Open. Select options in the Conversion Options dialog box.
Page 57: Contents
USING ROBOHELP HTML 9 Projects Export your conversion settings and reuse it when you link another Word document. See “Export conversion settings” on page 64. Linking versus importing Word documents You have two options for integrating content from Word documents into RoboHelp projects: linking and importing. The following table lists the differences between the two methods: Option Linking...
Page 58: Contents
USING ROBOHELP HTML 9 Projects You can convert inline styles to CSS styles in RoboHelp. However, converting inline Inline styles and style overrides styles to CSS styles can lead to numerous styles that share the same formatting. See “Converting Word styles to RoboHelp styles”...
Page 59: Contents
USING ROBOHELP HTML 9 Projects Link and import Word documents • Create a RoboHelp project by linking to or importing a Word document. You can import DOCX, DOC, DOCM, or RTF files. • Link or import Word documents into a RoboHelp project. •...
Page 60: Contents
USING ROBOHELP HTML 9 Projects Note: To import multiple documents with separate TOCs, select them in the order they should appear in the master TOC. In the Content Settings dialog box, set conversion options for the TOC, index, and glossary, and click Next. For information about various conversion options, see “Importing a Word TOC, index, and glossary”...
Page 61 You can also use a custom CSS for your project. You can later edit the styles either in RoboHelp or in an external CSS editing application, such as Adobe Dreamweaver®. You can define how the Word styles convert to RoboHelp styles at the project level.
Page 62 USING ROBOHELP HTML 9 Projects • Click Add next to the CSS For Style Mapping menu, and select the CSS file that you want to use. Use this option to specify a custom CSS for your project. When you select this option, RoboHelp copies the selected CSS file into the root folder of your project, and uses the selected CSS for style mapping.
Page 63 USING ROBOHELP HTML 9 Projects In the Conversion Settings dialog box, select the Character group. Select the Word character style from the left pane of the Conversion Settings dialog box. Select the RoboHelp character style from the pop-up menu. Optionally, you can do the following: •...
Page 64 USING ROBOHELP HTML 9 Projects In the Import tab, click Edit under Word Document. Select the Word table style from the left pane of the Conversion Settings dialog box. Select the RoboHelp table style from the pop-up menu. Optionally, to edit the table style in RoboHelp, click Edit Style.
Page 65: Contents
USING ROBOHELP HTML 9 Projects Set pagination for online Help topics When you import a Word document, you define how the contents of the Word file appear as topics in RoboHelp. For example, suppose your Word file contains ten topics. If each topic contains subtopics, definition lists, tasks, and tables, you can have each topic appear as a separate HTML file.
Page 66 USING ROBOHELP HTML 9 Projects Define the topic name pattern for generated topics When you set heading styles for pagination, the heading text is included by default in the filename of the topic file created in RoboHelp. For example, suppose you define Heading 2 for pagination. If the Word document has two Heading 2 topics, “Introduction”...
Page 67 USING ROBOHELP HTML 9 Projects Synchronizing linked Word documents with RoboHelp projects After you import or link Word documents to your RoboHelp project, you generate Help topics based on the project settings. When you import a Word document into a RoboHelp project, the topics are generated immediately and appear in the Project Manager pod.
Page 68 USING ROBOHELP HTML 9 Projects Update topics generated from linked Word documents RoboHelp does not update linked documents automatically when you link Word documents to a RoboHelp project. You define the conversion settings, including style mapping and pagination, and then generate the topics. Select options to update a linked document manually.
Page 69 USING ROBOHELP HTML 9 Projects Delete a generated topic When you delete a generated topic, you have two options. You can regenerate the deleted topic when you update the linked Word document or completely remove the deleted topic from your project. By default, RoboHelp regenerates the deleted topic when you update the Word document.
Page 70 USING ROBOHELP HTML 9 Projects Restore a link to a missing or renamed Word document If any of the linked Word documents are moved or renamed, RoboHelp displays a missing link icon for the linked document in the Project Manager pod. You can restore the link to a moved or renamed file and have all the topics already generated from the document retained in the project.
Page 71: Import Framemaker Documents
FrameMaker and RoboHelp together provide an end-to-end authoring and publishing workflow. This integration lets you exchange content and publish a variety of output formats such as PDF, online Help, and Help based on Adobe AIR. Note: If you are using Adobe Technical Communication Suite, you can link FrameMaker documents to your RoboHelp projects.
Page 72: Contents
USING ROBOHELP HTML 9 Projects Often FrameMaker chapter templates specify an even number of pages so that new chapters Page layout settings begin on a recto (right) page. For online Help, ignore these pagination considerations. RoboHelp ignores headers and footers during conversion, including legal text such as Headers and footers “Confidential”...
Page 73: Importing Framemaker Documents
USING ROBOHELP HTML 9 Projects Enclose graphics, callouts, and graphic or text frames you created with FrameMaker graphic tools into anchored frames. RoboHelp imports only those FrameMaker graphics that are enclosed in anchored frames. By default, when you import graphics and multimedia files into a FrameMaker document, these are placed in anchored frames. On the other hand, if your FrameMaker document contains graphics that are placed in graphic frames, you should place these into anchored frames before linking or importing the FrameMaker files into RoboHelp.
Page 74 USING ROBOHELP HTML 9 Projects If you are importing a FrameMaker document, you can select the components that you want to import from the Import Wizard that appears. You can select the TOC, index, and glossary, and specify the conversion settings. Note: Use the above procedure if you already have a project with some content, and wish to import FrameMaker content.
Page 75 USING ROBOHELP HTML 9 Projects Context-sensitive Help markers Converted if you select this option in the project conversion settings. Use Context Sensitive Help Makers in FrameMaker to specify text in FrameMaker document for generating Context Sensitive Help. See “Pagination Help” on page 75. Custom markers Converted.
Page 76: Contents
USING ROBOHELP HTML 9 Projects Structured FrameMaker components XML files in book Converted like FrameMaker documents. XHTML files in book Converted like FrameMaker documents. Content references Text or files inserted into FrameMaker documents as content references appear as part of the topics where they appear.
Page 77 USING ROBOHELP HTML 9 Projects Import FrameMaker index entries RoboHelp creates an index based on the index markers in the document you are importing. However, the index file generated in the FrameMaker book is not imported into the RoboHelp project. Select File >...
Page 78 By default, RoboHelp uses the RHStyleMapping.css file for the project. You can also use a custom CSS. You can later edit the styles either in RoboHelp or in an external CSS editing application such as Adobe® Dreamweaver®. Select File > Project Settings.
Page 79 USING ROBOHELP HTML 9 Projects In the Import tab of the Project Settings dialog box, do one of the following: • To retain the document-level settings in the upgraded project, select the Override Project Settings At Document Level option. This is the default behavior. •...
Page 80 USING ROBOHELP HTML 9 Projects Hierarchy of FrameMaker book reflected in the Project Manager pod when you link a FrameMaker book into RoboHelp Convert FrameMaker cross-reference formats to RoboHelp styles By default, all cross-reference styles in the source document are used in the generated topics without mapping. Define the mapping of these formats because FrameMaker documents can contain page and volume references in cross- references that are not relevant to Help formats.
Page 81: Contents
USING ROBOHELP HTML 9 Projects • Format conversion settings, image conversion settings, and other settings Export conversion settings Select File > Project Settings. On the Import tab, click Export. Specify a name for the RoboHelp Import Settings file (ISF file) and click Save. Import conversion settings to a project Select File >...
Page 82 USING ROBOHELP HTML 9 Projects Building block Converted topic name pattern default HTML topic generated has the filename consisting of the paragraph text. <$filename_no_ext>-<$paratext> HTML topic generated has the filename consisting of the filename of the FrameMaker document without the .fm extension and the topic title, separated by a hyphen. For example, the FrameMaker document named “Chapter.fm”...
Page 83 USING ROBOHELP HTML 9 Projects Apply FrameMaker conditional text build expressions You can apply the Show/Hide settings of the conditional text build expressions to the content in your FrameMaker documents imported into RoboHelp projects. RoboHelp imports the content after applying the Show/Hide settings to the FrameMaker content.
Page 84 USING ROBOHELP HTML 9 Projects Select the FrameMaker character format from the left pane of the Conversion Settings dialog box. Select the RoboHelp character style from the pop-up menu. Optionally, you can do the following: • To import the FrameMaker character format, select [Source] from the pop-up menu.; •...
Page 85 USING ROBOHELP HTML 9 Projects List-mapping scenarios RoboHelp allows you to convert list properties of FrameMaker paragraph formats in several ways. Consider the following scenarios: FrameMaker numbered list mapped to [Source] The FrameMaker paragraph format autonumber property converts to a list according the autonumber conversion settings you define for that FrameMaker paragraph format.
Page 86 USING ROBOHELP HTML 9 Projects • Map the FrameMaker paragraph style "FM_Para1" to RoboHelp paragraph style "RH_Para1". The generated paragraph in the RoboHelp topic inherits the properties of the list style "RH_List1". FrameMaker numbered list mapped to RoboHelp numbered list The converted paragraph style has the RoboHelp paragraph style and inherits the RoboHelp list style.
Page 87 USING ROBOHELP HTML 9 Projects Specify the dimensions for the images. Select one of the following: Preferred Dimensions • Scale images as a percentage of the existing size. The aspect ratio of the images is maintained. Scale • Specify the absolute image size as Height and Width, in points. Select Maintain Aspect Ratio to Width and Height ensure that the images are not skewed.
Page 88: Import A Dita Map File
RoboHelp does not generate errors. Therefore, the XHTML topics generated from the import of DITA map file do not contain the meta tag <meta name="generator" content="Adobe RoboHelp - www.adobe.com" /> Note: The XHTML file must have well-formed XML.
Page 89: Import Xml Files
USING ROBOHELP HTML 9 Projects Specify a DITA Val file to use for conditional processing of the DITA files. Use DITA Val For Conditional Processing The XHTML is generated based on the Val file. A DITA Val file contains filter, flagging, and revision information. The equivalent parameter for the Ant processing of the DITA Open Toolkit file is args.filter.
Page 90 USING ROBOHELP HTML 9 Projects Click OK. Note: If multiple imported topics have the same topic name, this error is due to the XSL file used during the import process. The XSL file used to transform the XML to HTML contains the <title> specified field. Edit the XSL file and reimport the XML file.
Page 91: Import Microsoft Html Help Projects
USING ROBOHELP HTML 9 Projects Import an existing handler. Import Note: Initially a handler is an HDF file with a subfolder of support files. To bring a handler file from the HDF Editor into this program, export the HDF file as a ZDF file. Use the HDF Editor for this task. Import Microsoft HTML Help projects When you import an HHP file, a new RoboHelp project file (XPJ) is created.
Page 92: Contents
USING ROBOHELP HTML 9 Projects External topics Convert external WinHelp topic links to HTML topic links in external CHM files. Links To External HTML Help Topic HTML topics include WinHelp Topic controls. Use this option when Retain Keep External WinHelp Topic Links linking HTML topics to WinHelp topics.
Page 93: Contents
USING ROBOHELP HTML 9 Projects WinHelp formatting import options Work with or without style sheets. Without style sheets, topics format using inline styles. For external style sheets, create new style sheets based on the formatting in WinHelp documents or select a style sheet already in use. Convert all formatting into HTML inline styles.
Page 94: Contents
USING ROBOHELP HTML 9 Projects Note: The project compiles a binary index when keywords are added to HTML topics. Topic keywords are automatically sorted in the index and cannot be cross-referenced. They can link only to local HTML topics. The destination topics can be displayed only in the default Help window.
Page 95 USING ROBOHELP HTML 9 Projects Can I use tabs in HTML topics? HTML does not support tabs and converts them to spaces. Use tables instead to position text in HTML. How can I add spaces to position text in HTML topics? You can edit topics in the RoboHelp HTML Editor and add non-breaking spaces to position text.
Page 96: Contents
Enter the name of the start page in Start Page Name. Adobe WebHelp) Distribute the project as compiled Microsoft HTML Help or cross- Do not enter information in Start Page Name. platform Help using Adobe WebHelp, JavaHelp, or Oracle Help output. Click Next. Set up Style options: Desired Result Actions Format HTML topics without attaching style sheets to them.
Page 97: Contents
USING ROBOHELP HTML 9 Projects These macros convert: Jump Context, JumpId, and PopupId. Other macros are not Macros, buttons, and shortcuts converted. Jump Context macros that send output to a window do not convert because links that send output to custom windows are not supported.
Page 98: Adding Projects To Version Control
USING ROBOHELP HTML 9 Projects Click the Import tab. Select WinHelp Project. Click OK. Click the browse button, and select the HPJ file to import. Click Next. Specify the output folder and filename. Under Choose Source Document(s), select the Word documents you want to import. Click Finish or click Next to step through the remaining steps in the wizard.
Page 99 You can also view files by opening them from version control without checking them out. To work with RoboHelp, your version control software must support the Microsoft SCC API. You can use Adobe RoboSource Control (installed with RoboHelp) or a third-party package. Either way, you perform version control tasks from within RoboHelp.
Page 100 USING ROBOHELP HTML 9 Projects Select View > Pods > Project Manager. Displays file icons. A red check mark indicates that a file Project Manager pod is checked out. Note: The RoboHelp user interface is optimized for RoboSource Control, Microsoft Team Foundation Server 2005, and Microsoft Visual SourceSafe.
Page 101 Add a RoboHelp project to version control When you add a RoboHelp project to version control, create a database connection when you first connect to RoboSource Control. RoboHelp uses this connection to access the database. See Adobe RoboSource Control Help for more information.
Page 102: Merging Help Projects
“Create a master project” on page 97. • Publish the child projects. See “Publish child projects” on page 98. Note: For master projects having the Adobe AIR Application output type, publish the child projects as browser-based Adobe AIR Help. Last updated 12/14/2011...
Page 103 USING ROBOHELP HTML 9 Projects Browser based Help output type selection • (Adobe AIR Application output type only) Regenerate the output of the master project. See “Configure the Adobe layout” on page 284. Note: WebHelp Pro and FlashHelp Pro projects are automatically published by RoboHelp Server.
Page 104: Contents
Contents tab in the HTML Help viewer. • If you generate a WebHelp/FlashHelp/Adobe AIR output using a skin, the skin from the master project overrides the skin of the child project in the merged project. If you access the projects individually outside the merged project, the project-specific skin is used.
Page 105: Contents
Projects Right-click the layout in the Single Source Layouts pod and select Generate. Note: In the case of master projects having the Adobe AIR Application output type, select the output type Browser Based Help for each child project. For master projects having the Adobe AIR Application output type, select the output type Browser Based Help for the child project.
Page 106 Publish the master project. View the merged project from the server. FAQs about merging projects This information applies to Adobe AIR, WebHelp, and Microsoft HTML Help projects. Master projects Which project works best as the master project? A blank project with no topics as a container for the child projects works best as the master project. If you need to include content in the master project, avoid creating cross-project links.
Page 107 USING ROBOHELP HTML 9 Projects Features Do I need to merge the index separately? No. The updated merging function of RoboHelp merges the index automatically. What happens if the merged projects have identical index keywords, glossary terms, or link controls? •...
Page 108: Reports
Adobe AIR projects How do I distribute merged Adobe AIR Application projects? An Adobe AIR Application project is a single .air file. To distribute this .air file, copy the file from the output location to the required shared location. How do I run merged browser-based Adobe AIR Help from a local folder? Add the output folder in the list of trusted folders defined in the RoboHelp.cfg file in the FlashPlayerTrust folder.
Page 109 USING ROBOHELP HTML 9 Projects Send reports You can share reports with others by sending the content as an e-mail message. Select Tools > Reports. Select the report type. The Reports dialog box appears. Use the options available to customize the report. (Not all reports are customizable.) Click Mail To.
Page 110 USING ROBOHELP HTML 9 Projects Contains a list of keywords. Each keyword lists the topics that use it. You can discover if Keywords And Topics keywords are not linked to any topics and identify topics to remove from keywords. Contains a list of topics. Each topic list the keywords associated with the topic. You can Topics And Keywords discover if topics are missing keywords, inconsistent phrasing, and identify keywords to remove from topics.
Page 111: Contents
USING ROBOHELP HTML 9 Projects The glossary report is shown for the glossary selected. Images report ❖ Select Tools > Reports > Images. The Image report appears. Grouped under each image is a list of all topics that use it. View An Alphabetized List Of Images Grouped under each topic is a list of all images they include.
Page 112: Contents
USING ROBOHELP HTML 9 Projects You can change your table of contents whenever you change topic titles or filenames. Topic Properties report Use this report (Tools > Reports> Topic Properties) to filter reports according to various properties. To customize the report, click Options, and select details to add: Folder and bookmark names and locations.
Page 113 USING ROBOHELP HTML 9 Projects Unused files report Use this report (Tools > Reports > Unused Files) to view unused files in one place. You can sort by filename or file type by selecting from the Sort By menu. You cannot remove these files from within your project. Make a list of the unused files and their paths and then use Windows Explorer to delete the files.
Page 114: Reference
USING ROBOHELP HTML 9 Projects Reference URL Properties dialog box Use this dialog box to link index keywords to URLs in your project. Enter the word or phrase that end users must enter in the index to access the URL. Keywords Delete Old Project dialog box Delete the old WebHelp Pro project from the RoboHelp Server before publishing the renamed project.
Page 115 USING ROBOHELP HTML 9 Projects Formats the left and right panes to synchronize as users navigate content. Auto Synchronize TOC Note: Project filenames cannot include spaces. You can automatically replace spaces with underscores after you create the project. Defines the navigation pane width in pixels. Width Note: Project filenames cannot include spaces.
Page 116: Chapter 4: Working With Topics
Chapter 4: Working with topics Create, save, and open topics Create a topic In the Project Manager pod, open the XHTML Files (Topics) folder. To store the topic in a specific custom folder, select the folder. Do either of the following: •...
Page 117 USING ROBOHELP HTML 9 Working with topics • In the toolbar, click Save. Enable or disable Save If you deselect Save Without Prompt, you are prompted to save topics. Select Tools > Options. Click the General tab. Under Options, select or deselect Save Without Prompt. Click OK.
Page 118: Author In Xhtml
Note: To view the XHTML source of a topic, open the topic in the Design Editor and select the HTML view. You can use third-party editors such as Notepad, Microsoft Word, or Adobe Dreamweaver to edit your files and retain these files in their existing format.
Page 119: Import And Copy Topics
USING ROBOHELP HTML 9 Working with topics The following features are not supported in XHTML: • Marquees in topics • Border color in framesets • Background sound in topic properties Use of these features results in invalid XHTML code. Remove these features to generate valid XHTML code. More Help topics “W3C compliance”...
Page 120: View Topics And Design Elements
Important: If the topics contain links to PDFs, make sure that Adobe® Acrobat® 10 is installed on your computer. Previewing any PDF in Acrobat 9 or earlier versions might not work correctly.
Page 121: Master Pages
USING ROBOHELP HTML 9 Working with topics Includes or excludes topics that use specified conditional build tags. Click OK to return to the preview window. To remove the condition from the preview, select None from the menu. View design elements ❖...
Page 122 USING ROBOHELP HTML 9 Working with topics You can use tables to create a precise layout where each placeholder is placed in a table cell. When you create a topic from a master page, the topic includes content from the master page. Body placeholder Copyright information is an example.
Page 123 USING ROBOHELP HTML 9 Working with topics More Help topics “Headers, footers, and page breaks” on page 147 Formatting master pages When you generate or preview a layout, border and shading properties of the master pages override border and shading properties of topics. If the properties do not conflict, they are applied independently. For example, if you set border properties for a master page, and background color for a topic, the final output topic has both applied to it.
Page 124 USING ROBOHELP HTML 9 Working with topics Notes: • If a body placeholder is deleted from the master page or does not appear, the resultant topic has its headers appear first (if at all), followed by the HTML content of the master page, the topic content, and the footer (if present). •...
Page 125: Manage Topics
USING ROBOHELP HTML 9 Working with topics Applying a master page or CSS at the time of generation Single-source layouts let you override the master page or the CSS when you generate output. For different output results, apply different master pages or a different CSS. Each single-source layout except the Printed Documentation layout provides an option to apply master pages or CSS.
Page 126: Contents
USING ROBOHELP HTML 9 Working with topics Update topic references If you rename a topic title, make sure that you update the following items as indicated. The path of the link is updated, but the link text that is visible to a user is not. If link text in any topics Text links includes the topic title, update each topic.
Page 127: Contents
USING ROBOHELP HTML 9 Working with topics Open the Smart Index wizard. Smart Index Open the General tab. Save the keyword in either the index file or in the current topic. Properties Changing master pages To change which master page is applied to a topic, select a master page from the Master Pages menu. The default is the last master page applied to the topic.
Page 128: Contents
USING ROBOHELP HTML 9 Working with topics Click to search for text in topic titles instead of in filenames. By Title Displays the topics that match the search criteria. Select a topic from this list to preview Topics Containing <item> it or modify its properties.
Page 129: Managing Resources
USING ROBOHELP HTML 9 Working with topics More Help topics “Reports” on page 102 Work with the Tag list The Tag list in Design view shows the hierarchical structure of the HTML page. The top of the hierarchy is on the left (always the document).
Page 130 USING ROBOHELP HTML 9 Working with topics Specify application-level Resource Manager settings In the Options dialog box, specify how you want to use shared resources in projects. Select either of the following options: Inserts a copy of a shared resource in the project. Resource Manager does not notify you or update the As Copy project if the original resource in the shared location is updated.
Page 131: Contents
USING ROBOHELP HTML 9 Working with topics Add a category Categories help you manage different types of resources. You can add and edit categories and associate various file types with each category. For example, you can add a category called Video and associate .flv, .swf, and .avi file types with it.
Page 132 USING ROBOHELP HTML 9 Working with topics Manage linked resources Linked resources are shared resources used in a project. When you use a shared resource in a project, RoboHelp adds a copy of the shared resource in the project. However, it maintains a link with the shared location to track whether the master copy is updated.
Page 133: Check Spelling And Find And Replace
USING ROBOHELP HTML 9 Working with topics Removes the links of the selected resources to the shared location. The resources remain in the Remove Links project as copied resources; any updates to the master copies in the shared location must be tracked manually. Replaces the current link with a link to another shared resource that has the same file extension.
Page 134 USING ROBOHELP HTML 9 Working with topics Note: Misspellings are not predefined; be sure to add them explicitly. This feature is Unicode-compliant. You can add words in any language, including Russian and Japanese, in the same project, a topic, or a paragraph. Specify a misspelling in the Replace box.
Page 135 USING ROBOHELP HTML 9 Working with topics Spelling check options for projects Display the topic currently being checked. Currently Checking Skip the current topic. Skip Display the word not found in the dictionary. Not In Dictionary Add the word to the dictionary. Show a list of words similar to the word not in the dictionary.
Page 136: Find And Replace
USING ROBOHELP HTML 9 Working with topics Close the dialog box. Close Find and replace Find and replace text in a topic Open a topic. Select Edit > Find or Edit > Replace. Type the text in the Find box. (Optional) Set options.
Page 137: W3C Compliance
USING ROBOHELP HTML 9 Working with topics Find and replace options ❖ Select Edit > Replace. Search for this word or phrase. Find What Use this word or phrase as the replacement text. Replace With Locate the first occurrence in the text. Find Next Replace selected text.
Page 138: Reference
USING ROBOHELP HTML 9 Working with topics Do one of the following: Project • Right-click Project Files in the Project Manager pod and select Validate W3C Compliance. • Select File > W3C Compliance > Validate All. RoboHelp validates all the HTML/XHTML topics and shows warnings or error messages for any non-compliance in the Output View pod and Error List pod.
Page 139: Chapter 5: Editing And Formatting
When you type the next letter "o," the keyword "RoboHelp" is highlighted. Click it to insert it in the HTML Editor. Text assigned to this keyword (for example, Adobe RoboHelp) appears in the HTML Editor. Note: If the characters you enter do not have a matching keyword, the pop-up window disappears.
Page 140 USING ROBOHELP HTML 9 Editing and formatting You can add keyword expansions in the HTML Editor. In the HTML Editor, right-click and select Edit Expansions. Click New. (Optional) Enter a new keyword in the Keyword box. Enter a caption for the keyword in the Caption box. Enter some text in the Text To Insert text area.
Page 141 USING ROBOHELP HTML 9 Editing and formatting Remove or rename an HTML editor Select Tools > Options. Click the Associations tab. Select an editor. Click Edit. • To rename the editor, click Edit and type a name in the Name box. •...
Page 142: Character Formatting And Fonts
USING ROBOHELP HTML 9 Editing and formatting Specify an editor for new topics Specify the default editor for new topics. In the Project Manager pod, right-click a topic. Select New > Topic With. Select an editor. Click OK. Click the General tab, and specify options. Select Tools >...
Page 143 USING ROBOHELP HTML 9 Editing and formatting Change character spacing Select Format > Font. Click the Spacing tab. Select Normal, Expand, or Compress. Set options: (For Expand or Compress) Specify the amount of space between characters. Specify a location for the text. Position Click OK.
Page 144: Format Paragraphs
USING ROBOHELP HTML 9 Editing and formatting Insert symbols and special characters Open a topic in the Design Editor. Select a location for the character. Select Insert > HTML > Symbol. Double-click the symbol. Insert a non-breaking space ❖ Place the insertion point where you want the non-breaking space. Press Ctrl+Alt+spacebar. Format paragraphs If you format a paragraph using the toolbar or the Format >...
Page 145 USING ROBOHELP HTML 9 Editing and formatting Marker position for a first-line indent Change margins Follow this procedure if you want to change a single topic. Otherwise, use a style sheet. Select View > Show > Ruler. In the Design Editor, insert your cursor where you want to change the margins or select the text to change. Drag the margin markers on the ruler.
Page 146: Borders, Backgrounds, Color, And Sound
USING ROBOHELP HTML 9 Editing and formatting Click OK. Notes: • Tables must be left- or right-aligned to use text wrapping, and they must be less than 100% in size. • If text wrapping is applied around an image, the image cannot be aligned. Adjust line spacing Select Format >...
Page 147 USING ROBOHELP HTML 9 Editing and formatting More Help topics “Add or edit borders or backgrounds in style sheets” on page 163 Remove borders or backgrounds Open a topic. Select the item with the border or shading. Do one or more of the following: •...
Page 148: Tables
USING ROBOHELP HTML 9 Editing and formatting • Select Snap To Safe to change the selected color to the closest web-safe color. Remove colors Note: Before you remove a color, reformat any text using it. Select Format > Colors. Select the color to remove. Click Delete.
Page 149: Insert Tables
USING ROBOHELP HTML 9 Editing and formatting Workflow for creating a table Insert a table using the toolbar or the Table menu. Then select the number of rows and columns in the table grid. “Insert tables” on page 143. Select a global style to apply on the table. You can also create your own table styles using the Format > Styles option. Note: If you do not select a table style, a default table style is applied to the table.
Page 150: Contents
USING ROBOHELP HTML 9 Editing and formatting To add a line below a table, click inside the lower-right cell of the table. When the cursor is blinking, press the Right or Down Arrow. Press Enter to begin a new line. Edit tables For a demonstration of table editing, see the Table manipulation section of the Easy ways to create and manage tables...
Page 151: Lists
USING ROBOHELP HTML 9 Editing and formatting In the Top, Bottom, Left, and Right boxes, enter a value. Click OK twice to apply changes. Note: The Margins option sets the spacing around the table. Merge or split table cells Select the cells to merge or split. Select Table >...
Page 152 USING ROBOHELP HTML 9 Editing and formatting From Available In, select an external or embedded style sheet. From the Styles list, select a style and click the Create New Style button Under Style Type, select Paragraph Style. Type a name for the new style. The name can contain letters and numbers only and cannot begin with a number. Under Style For Following Paragraph, select (No Change).
Page 153: Headers, Footers, And
USING ROBOHELP HTML 9 Editing and formatting Click the Numbered tab. Select a numbering format. Add a paragraph within a list Use this procedure to insert paragraphs between numbered or bulleted items in a list. Click at the end of the line to insert a paragraph over it. Press Shift + Enter.
Page 154: Text Boxes
USING ROBOHELP HTML 9 Editing and formatting Click outside the header or footer. Click the Save All button. Remove headers and footers Open the topic or master page containing the header or footer. Click the Header button or the Footer button. Right-click in the header or footer, and select Remove Header or Remove Footer.
Page 155: User-Defined Variables
USING ROBOHELP HTML 9 Editing and formatting Select View > Toolbars > Positioning. From the Z menu, select 1. Repeat for additional text boxes. Layered text boxes Change text box properties Right-click the text box. Select Text Box Properties or Positioned Text Box Properties. Change the properties.
Page 156 USING ROBOHELP HTML 9 Editing and formatting Variable names can contain only alphanumeric characters, underscores, and hyphens, and can't exceed 255 characters. A variable value can be blank. Click OK. The variable is inserted. Press Ctrl+F9, and then specify the variable name within the curly brackets that appear in the topic. Double-click the variable to specify its value in the Variable dialog box.
Page 157 USING ROBOHELP HTML 9 Editing and formatting Insert a user-defined variable You can drag a user-defined variable from the User Defined Variables pod to the desired location in a topic open in Design Editor. If the list of variables is long, specify the variable name or value to search the variable. You can also insert variables using the follow steps: Place the insertion point at the desired location in a topic.
Page 158: Single-Source With Snippets
USING ROBOHELP HTML 9 Editing and formatting In the Variable Name field, enter a name. In the Variable Value field, modify the value. Click OK. Single-source with snippets A snippet is an element that you can single-source and reuse in various locations. It can be a paragraph of text, a code listing, an object such as an image, or an entire topic unto itself.
Page 159: Contents
USING ROBOHELP HTML 9 Editing and formatting • From the Snippet pod, select a snippet and drag and drop it into the topic. • Select Insert > Snippet. Select a snippet from the list in the dialog box and click OK. Note: Right-click a snippet in the Resource Manager and select Add to Project to add the snippet to the project.
Page 160: Reference
USING ROBOHELP HTML 9 Editing and formatting Reference META tags default editor Click Yes to make RoboHelp Design Editor the default editor for topics without META tags. Click No to retain the current editor. The topic then opens in the selected editor. Last updated 12/14/2011...
Page 161: Chapter 6: Styles And Style Sheets
Chapter 6: Styles and style sheets Style types You can manage style sheets at the project level and apply styles at the topic level. Master pages provide the layout of a topic and help control the styling. These types of styles are available: A block of text and its formatting within an HTML file (topic) formatted directly in the Design Editor.
Page 162 USING ROBOHELP HTML 9 Styles and style sheets Define the number of times the sound clip plays when the topic is opened. Select Infinite to play Sound Loop Count the sound continuously while the topic is open. Click OK. Note: Use this same procedure to link a style sheet to a topic in Design Editor. More Help topics “Applying a master page or CSS at the time of generation”...
Page 163: Create Styles For Style Sheets
USING ROBOHELP HTML 9 Styles and style sheets Note: You can export topic-specific inline styles only. Create styles for style sheets Create a style in the Styles dialog box In the Project Manager pod, right-click the style sheet where you want to create the style, and click Edit. Click New and select a style type, for example, Paragraph style.
Page 164: Table Styles
C:\users\[user name]\AppData\Roaming\Adobe\RoboHTML\[version]\Templates\Tables. Note: If you delete the Tables folder from the suggested location, the global table styles are still visible in the Global Styles list. You can always recover the styles from C:\Program Files\Adobe\Adobe RoboHelp [version]\RoboHTML\Gallery\Tables. In addition to the predefined global styles, you can copy table styles from a project folder and paste at C:\Documents and Settings\[user name]\Application Data\Adobe\RoboHTML\[version]\Templates\Tables.
Page 165: List Styles
USING ROBOHELP HTML 9 Styles and style sheets Click Create New Style and select Table Style. Name the new table style and click OK. Apply formatting to the whole table, first or last column or row, or a group of rows or columns. From the Apply Formatting To list, select the columns or rows to format.
Page 166 Number or Table Number. In simple numbered lists, the paragraph style and numbering styles share the same font, font size, font weight, and font color. For a video introduction by John Daigle, see Easy ways to create lists and autonumbering on the Adobe RoboHelp video tutorials page.
Page 167: Apply Styles
Click the Edit Sequence box and type the sequence that you want. For example, January, February, and so on. After you enter January, click Add to add February, and so on. For more information about custom sequencing, see www.adobe.com/go/learn_rh_blog_multilist_en. Edit a sequencing prefix In the Styles dialog box, click New.
Page 168: Edit Styles In Css Files
USING ROBOHELP HTML 9 Styles and style sheets • Click inside the paragraph to format. For multiple paragraphs, select the paragraphs. In the Styles And Formatting pod, double-click a style. • Character styles apply to selected blocks of text and impact fonts and DHTML effects. •...
Page 169: Use Color And Images
USING ROBOHELP HTML 9 Styles and style sheets If Hide Inherited Styles is selected, deselect it to see available styles. From the Available In menu, select the style sheet name. For embedded styles, select the topic name. From the Style menu, select the style to remove. To delete custom formatting from a default style, select the style.
Page 170: Inline Styles
USING ROBOHELP HTML 9 Styles and style sheets Click the Border or Shading tab, define the borders or backgrounds, and click OK. Note: Any image file used for borders or backgrounds is added to the project Baggage Files folder and is included in the output you generate.
Page 171: Chapter 7: Tocs, Indexes, Glossaries
Chapter 7: TOCs, indexes, glossaries TOCs TOC basics About TOCs The table of contents is a hierarchy of the folders, topics, and any subfolders in Project Manager. RoboHelp creates books from custom folders and pages from the topics in these folders. Any topics not saved in custom folders appear as pages at the first level in the table of contents.
Page 172: Contents
USING ROBOHELP HTML 9 TOCs, indexes, glossaries From the pop-up menu, select the information to print. Print all book and page titles. Overview Print all book and page titles, the topic titles linked to each, and the folders in which the topics are located. Detailed Click Properties or Page Setup to specify print options.
Page 173: Contents
From the Available Variables menu, select a variable. Click Add. The variable is listed in the Page Title box. (Optional) In the Page Title box, add a prefix or suffix to the variable. For example, add the prefix “Adobe” to the variable “RoboHelp.”...
Page 174: Contents
USING ROBOHELP HTML 9 TOCs, indexes, glossaries Click OK. Version-control projects may have more options. Manage TOCs Manage TOCs with reports RoboHelp provides several reports to help you manage tables of contents and resolve errors. ❖ Select Tools > Reports > [report name]. You can save, print, copy, and mail reports.
Page 175: Contents
USING ROBOHELP HTML 9 TOCs, indexes, glossaries Identify and fix broken TOC links If books or pages have broken links, they appear in the Table Of Contents pod with a red X. Select Tools > Resolve Broken Links. Shows all references to the missing topic. The Open Book icon indicates broken References To Selected Topic TOC references.
Page 176: Indexes
USING ROBOHELP HTML 9 TOCs, indexes, glossaries From the Select Table Of Contents menu, select the table of contents to merge. Click OK. When you generate a layout, select the merged table of contents from the list in the Layout screen of the wizard. The selected table of contents appears in the output view of the Help.
Page 177 USING ROBOHELP HTML 9 TOCs, indexes, glossaries Additional details for HTML Help projects • You can merge topic keywords from multiple CHM files into a master project. • If you add index controls to topics, the index file (HHK) for the control displays only index file keywords. Additional details for WinHelp projects •...
Page 178 USING ROBOHELP HTML 9 TOCs, indexes, glossaries Notes: • When you add a keyword to an index, it is automatically added to the index (HHK) or topic (HTM) files. • Index file keywords use the key icon . Topic keywords use the page icon Print indexes Click the Index pod.
Page 179 USING ROBOHELP HTML 9 TOCs, indexes, glossaries Drag the topic into the upper pane of the Index Designer. The keyword name is based on the topic title. You can rename it. Add index keywords using topic properties In the Topic List or Project Manager pod, select a topic. Click the Properties button In the Topic Properties dialog box, select the Index tab.
Page 180 From the Available Variables menu, select a variable. Click Add. The variable is listed in the Index Keyword box. (Optional) In the Index Keyword box, add a prefix or suffix to the variable. For example, add the prefix “Adobe” to the variable “RoboHelp.”...
Page 181 USING ROBOHELP HTML 9 TOCs, indexes, glossaries Note: The Sort command is unavailable with a binary index. The sort function is enabled only when the primary layout is HTML Help and the Index is set to Index File with no Binary Index. In all other layouts, the index remains sorted but for HTML output, the sorting of the index can be changed.
Page 182 USING ROBOHELP HTML 9 TOCs, indexes, glossaries Manage indexes Manage indexes with reports RoboHelp provides reports to use in managing indexes, such as the Index and Unused Index Keywords reports. The Index report lets you choose options to define how the report displays information. You can display all the keywords, a list of keywords with their related topics, or a list of topics and their related keywords.
Page 183 USING ROBOHELP HTML 9 TOCs, indexes, glossaries Apply conditional build tags to an index In the Index pod, select a keyword. Click Format > Apply Conditional Build Tag > New/Multiple. Select tags or click Check All. Click OK. Automatic indexing with the Smart Index wizard Create an index automatically Use the Smart Index wizard to search the content of topics.
Page 184 USING ROBOHELP HTML 9 TOCs, indexes, glossaries To skip to the next topic, click Skip. Click Options to add verbs, synonyms, and existing index keywords. Note: The Sentences Containing box shows the suggested keyword in the context where it is found. The Info field indicates whether the selected keyword is new or existing.
Page 185 USING ROBOHELP HTML 9 TOCs, indexes, glossaries The list is stored as an STP file in the project folder. Version-control projects may have more options. More Help topics “Change project settings” on page 33 Specify custom phrases For greater control over the index keywords (words and phrases) suggested by the Smart Index wizard, create a custom phrase list.
Page 186: Tocs And Indexes In Microsoft Html Help
USING ROBOHELP HTML 9 TOCs, indexes, glossaries Multiple indexes Create multiple indexes You can create multiple indexes in the same project. New indexes are added to the Index folder. With multiple indexes, you can right-click any index and select Set As Default to set the index as default index. You can right-click an index and select Rename to rename the index as well.
Page 187: Contents
USING ROBOHELP HTML 9 TOCs, indexes, glossaries Under Image, Auto indicates that the book or page uses the standard icon. From the pop-up menu, select an icon. You can assign other icons to books and pages after you add the bitmap file (BMP) to your project. (Optional) Select Mark As New to display the standard icon with a red star.
Page 188: Contents
• To use custom book and page icons, select a BMP file from Custom Image File. Make sure that you include the image path, such as C:\Program Files\Adobe RoboHelp [version]\My.bmp. Note: For custom book and page icons, create an icon strip. See the MSDN Library on the Microsoft website.
Page 189: Contents
USING ROBOHELP HTML 9 TOCs, indexes, glossaries Customize an index (HTML Help) The index type for the HTML Help project determines the index properties: For index file keywords in non-binary indexes, you can customize the keyword fonts. Click the Index file keywords Index tab in the HTML Help viewer.
Page 190: Glossaries
USING ROBOHELP HTML 9 TOCs, indexes, glossaries You can use other index files in your project. Copy the HHK file and associated files (topics, images, multimedia) to select the HHK file with the index control. Link keywords and TOC items to custom windows and frames (HTML Help) Custom windows can display context-sensitive Help and links from index keywords, TOC books, and TOC pages.
Page 191 USING ROBOHELP HTML 9 TOCs, indexes, glossaries Import glossary terms and definitions Before importing a glossary file (GLO), print a detailed report of both glossaries. The reports can help you determine which terms exist in both glossaries and compare definitions. In the Project Manager pod, select a glossary in the Glossary folder.
Page 192 USING ROBOHELP HTML 9 TOCs, indexes, glossaries Change glossary definitions Note: If you change a definition that is used as an expanding glossary hotspot, update the project by running the Glossary Hotspot wizard. In the Glossary pod, select the term to change. Edit the definition text.
Page 193: Glossary Hotspots
USING ROBOHELP HTML 9 TOCs, indexes, glossaries Glossary hotspots About expanding glossary hotspots The Glossary Hotspot wizard finds glossary terms within topics and marks them in the topics. You can mark all terms to convert to expanding hotspot when you generate or preview output. Notes: •...
Page 194 USING ROBOHELP HTML 9 TOCs, indexes, glossaries Click Next. Repeat steps for each topic that the Glossary Hotspot wizard displays. Click Finish. Test expanding glossary hotspots In the Topic List pod, right-click the topic containing the hotspot. Click View. Click the glossary term in the topic. Click the term again to close the hotspot.
Page 195: Chapter 8: Linking And Navigation
Chapter 8: Linking and navigation Navigation basics Navigation options The following navigation options are available for use in Help projects. Open the link destination. Hypertext links Display an HTML topic in a pop-up window rather than in the default viewer. Pop-ups can be linked only to Pop-ups another HTML topic or to bookmarks.
Page 196: Contents
USING ROBOHELP HTML 9 Linking and navigation Set up information that appears in a dynamic window when users click the image in the main toolbar. Add About Box Example of About box Create browse sequences before enabling them. Browse Sequences Change the text displayed for the in-topic navigation bar elements.
Page 197: Create Text Links
USING ROBOHELP HTML 9 Linking and navigation (Optional) Select Use Topic Level Format to use the default format settings. (Optional) Click Format to change the default font settings. Click OK, and then click Finish. In the generated WebHelp, all the topic pages show a breadcrumb trail reflecting the TOC hierarchy. More Help topics “Insert a placeholder”...
Page 198: Link To A Pop-Up
USING ROBOHELP HTML 9 Linking and navigation More Help topics “Image maps” on page 211 Link to a pop-up You can create a link that displays an HTML topic in a pop-up rather than in the default browser or viewer. A pop-up supports HTML formatting, images, Dynamic HTML, link controls, and other HTML features of the destination topic.
Page 199: Link Images And Multimedia
USING ROBOHELP HTML 9 Linking and navigation After you save the topic, bookmark icons appear indented under topics listed in the Project Manager pod and next to topics in the Topics List pod. Create links to bookmarks Open the destination for the link. To create a link within a topic, create a bookmark in the topic. In the Design Editor, select the link location and then click the Insert Hyperlink button Under Select Destination (File Or URL), select the bookmark to link to.
Page 200: External Links
USING ROBOHELP HTML 9 Linking and navigation Add links from images and multimedia Topics can include multimedia as links, sound or video clips, local or external HTML topics, bookmarks, web or FTP sites, e-mail, or newsgroups. In the Design Editor, click the multimedia object or the image to link. Click the Insert Hyperlink button •...
Page 201: Link View
USING ROBOHELP HTML 9 Linking and navigation Link to e-mail addresses, FTP sites, newsgroups, and web addresses In the Design Editor, choose a location for the link or select text or an image to define a hotspot. Click the Insert Hyperlink button In Link To, click the triangle button and then do any of the following: •...
Page 202: Link Maintenance And Repair
USING ROBOHELP HTML 9 Linking and navigation Set options in the Link View pod Click the icons to see different types of links. • The current topic is in the center and has a blue border. • Inbound links appear on the left. •...
Page 203: Contents
USING ROBOHELP HTML 9 Linking and navigation Fix broken links ❖ Select Tools > Resolve Broken Links > References To Selected Topic. • To fix a link, first select a link. Then click Edit, and edit or remove the hyperlink. •...
Page 204: Link Controls
USING ROBOHELP HTML 9 Linking and navigation View and test hyperlinks View hyperlinks and identify browse sequences In the Design Editor, right-click and select Show Topic Links. Or, use the procedure that follows. Select View > Pods > Link View. The Link View pod appears. Drag topics from the Project Manager pod into the Link View pod.
Page 205 USING ROBOHELP HTML 9 Linking and navigation because you define the group of topics in one location (not in each topic). Make sure that you update the See Also control when you add or remove topics. Automatic updates occur in each topic containing the control. Controls that let you use index keywords for navigation within topics.
Page 206 USING ROBOHELP HTML 9 Linking and navigation Displays a control as a square gray button with black text. The text in the box displays on the button. You can Label edit the label. Displays a control as an image. The image filename appears in the box below this option. (You can't add a text Image label to an image or edit the label in RoboHelp.) To select an image, click the Browse button , and then select an...
Page 207 USING ROBOHELP HTML 9 Linking and navigation Find topics based on search criteria. Find Topic Set See Also Keywords in the See Also wizard The See Also wizard appears when you try to insert a See Also control in a topic (Insert > See Also). Display a list of all available See Also keywords.
Page 208: Text-Only Pop-Ups
USING ROBOHELP HTML 9 Linking and navigation Under See Also Keywords In Project, select a See Also keyword. Click Add. Repeat for all keywords you want to add. Click Next. Select display and font options. Click Finish. To test the control, generate the project. Change, reuse, or remove link controls ❖...
Page 209: Robohelp Search Basics
USING ROBOHELP HTML 9 Linking and navigation Click the View button Click the text-only pop-up. Test after generating Click the View Primary Layout icon . If you are prompted to generate, click Yes. Navigate to the topic containing the text-only pop-up. Click the text-only pop-up.
Page 210: External Content Search
USING ROBOHELP HTML 9 Linking and navigation RoboHelp search supports multiple languages at the project, topic, and paragraph level. For Multiple language search example, suppose you search for a German word in an English topic with an embedded German paragraph. If RoboHelp finds the German word, it displays the English topic with the German word highlighted.
Page 211: Browse Sequences
• Each type of Help displays browse sequences differently. In WebHelp layouts, you can enable or disable browse sequences at a project level. In both WebHelp and Adobe AIR layouts, you can select the browse sequences that you want to display. If the layout defines content categories, you can select browse sequences for each content category.
Page 212 USING ROBOHELP HTML 9 Linking and navigation Enter the number of levels from the TOC hierarchy that you want to include in the browse sequence, and click OK. Click OK. If the Enable Browse Sequence dialog box appears, click Yes. Create browse sequences manually Select Tools >...
Page 213 USING ROBOHELP HTML 9 Linking and navigation Click the Properties button Click the Advanced tab. Test browse sequences in a browser or view Verify that browse sequences are enabled. Click the Generate button to generate. Click View Result and click through the browse sequence. Identify the browse sequences a topic is assigned to Open a topic in the Design Editor.
Page 214: Chapter 9: Multimedia And Special Effects
Chapter 9: Multimedia and special effects Images Image basics Image file formats An 8-bit color format that can display 256 colors and is useful for images with a GIF (Graphic Interchange Format) limited range of color. GIF images support the transparent attribute. They are best for grayscale photographs, cartoons, small icons, buttons, bars, lines, and bullets.
Page 215 USING ROBOHELP HTML 9 Multimedia and special effects Copy an image In the Toolbox pod, double-click the Graphics Locator button Select an image from the Image Files list. Browse to a destination. Click Copy File. View an image To view an image, you associate the filename extension with an application: In the Project view, select the Images folder.
Page 216 USING ROBOHELP HTML 9 Multimedia and special effects Click OK. RoboScreenCapture opens and RoboHelp is minimized. Select Capture > Active Window or any desired capture. The new image appears in the blank area. Click Save Close RoboScreenCapture. The Image dialog box of RoboHelp for HTML appears. (Optional) Resize the image or place borders around it.
Page 217: Adobe Captivate Demos
192 Adobe Captivate demos Follow these procedures to launch Adobe Captivate to create demos and insert them in the project. After you insert an Adobe Captivate SWF, you can update the SWF by opening the source from within RoboHelp.
Page 218: Multimedia
Close Adobe Captivate. Note: When you preview an Adobe Captivate demo in RoboHelp, a prompt may ask you to update the file in the project. This prompt appears if you saved the Adobe Captivate demo outside RoboHelp to the default Adobe Captivate location.
Page 219: Dynamic Html And Special Effects
• Flash Files: *.swf • Flash Video Files: *.flv, *.f4v • Adobe Captivate Files: *.swf If you use the multimedia file in other topics, add it by dragging the file from the Multimedia folder. Note: Multimedia content might have dependencies such as Flash or video/audio players that you need to install before you can view or hear them.
Page 220 USING ROBOHELP HTML 9 Multimedia and special effects • Page-load, page-click, or trigger activation effects include Blur, Elastic, Fade In/Fade Out, Flip Horizontally/Vertically, Fly In/Out, Gray, Show/Hide, Spiral, and Rock 'n Roll. • Some effects can be combined. • For best results, use DHTML with Internet Explorer 5.0 and later. •...
Page 221 USING ROBOHELP HTML 9 Multimedia and special effects Update DHTML effects in a topic Update Dynamic HTML (DHTML) effects by resaving topics in either of these two situations: • You add or modify a style to include a Dynamic HTML effect. In this case, resave all topics attached to the style sheet so that they include code for creating the effect.
Page 222 USING ROBOHELP HTML 9 Multimedia and special effects Change formatting of DHTML hotspots Change the formatting in a single topic or change for all topics using a style sheet. For multiple style sheets, modify each style sheet attached to the topics that use hotspots. Select Format >...
Page 223: Marquees
USING ROBOHELP HTML 9 Multimedia and special effects Connect triggers to images Click the trigger image once to display the green cable drum icon Click the cable drum icon and drag to connect the image to the target image. A green line shows the connection between the trigger and target.
Page 224: Html Comments In Topics
USING ROBOHELP HTML 9 Multimedia and special effects HTML comments in topics Insert an HTML comment Open a topic in Design Editor. In Design view, insert the cursor and select Insert > HTML > Comments. In the Comment Editor, type your comment using the following format: ...
Page 225: Chapter 10: Conditional Text
Chapter 10: Conditional text Conditional text basics Conditional text lets you generate subsets of the content within a project for various purposes or audiences. You can create conditional build tags to exclude content from output, and then assign those tags to topics or elements within topics.
Page 226: Conditional Build Tags
USING ROBOHELP HTML 9 Conditional text Test the conditional tags by generating the output and viewing the results. Exclude combinations of tags you applied to topics, TOCs, or indexes. You can also preview topics, without generating, to experiment with conditional areas. More Help topics “Preview conditional text areas”...
Page 227 USING ROBOHELP HTML 9 Conditional text Apply conditional build tags to content Content that has a conditional build tag applied appears with diagonal hash marks in the color specified for the tag. If a project is generated using a conditional build tag expression, the topic doesn’t display the content to which the tag applies.
Page 228: Contents
USING ROBOHELP HTML 9 Conditional text Apply conditional build tags to a folder, index, or TOC Do one of the following: • To apply tags to a folder, select a folder in the Project Manager pod. • To apply tags to an index, click the Index folder in the Project Manager pod. Select a keyword or subkeyword. •...
Page 229: Conditional Build Tag Expressions
USING ROBOHELP HTML 9 Conditional text • To remove conditional build tags from topic content, open a topic in the Design Editor. Select topic content. • To remove conditional build tags from a TOC, click in the TOC pod. Select one or more books or pages. •...
Page 230 USING ROBOHELP HTML 9 Conditional text Advanced conditional build tag expressions If you define advanced conditional build tag expressions using Boolean operators, use these guidelines for customizing output. You can also let the program create them for you using the basic method. Desired Result Action All topics to which one tag has been applied...
Page 231: Chapter 11: Context-Sensitive Help
Chapter 11: Context-sensitive Help About context-sensitive Help A context-sensitive Help (CSH) topic provides information about the user interface of an application relative to the task a user performs. For example, CSH topics provide details about fields and controls in dialog boxes, descriptions of windows or screen objects, and explanations of messages.
Page 232: Author And Developer Roles In Creating Context-Sensitive Help
USING ROBOHELP HTML 9 Context-sensitive Help Author and developer roles in creating context- sensitive Help Author Developer Writes the Help topics that describe how to use application Builds the components (windows, dialogs, fields, controls) that make components such as windows, dialog boxes, fields, and controls. up the application.
Page 233 USING ROBOHELP HTML 9 Context-sensitive Help An Icon indicates the status of a map ID: • Blue icons indicate that map IDs match topics. • Yellow icons indicate that map IDs do not match any topics. • Locked icons (blue or yellow) indicate that the map ID is in a map file that is locked. It cannot be assigned or unassigned.
Page 234 USING ROBOHELP HTML 9 Context-sensitive Help Select the programming languages to save the map files to. Specify a location for the map file. Click OK. When you export a map file, the original file remains in your project. Lock or unlock a map file Locked map files are read-only files.
Page 235 USING ROBOHELP HTML 9 Context-sensitive Help Expand the Map Files folder. Double-click All Map IDs. In Map File, click the Down Arrow and select a map file to store the map ID. Click the Create/Edit Map ID button In Topic ID, type a word or phrase to identify the topic. In Map Number, type a number.
Page 236 USING ROBOHELP HTML 9 Context-sensitive Help Lists the project topics. To filter the list, click the triangle . Select All Folders, Top Level Folder, or a custom Topic folder. • Show all topic IDs assigned to the topic. Properties icon •...
Page 237 USING ROBOHELP HTML 9 Context-sensitive Help • By default, the application assigns the topic title or filename as the topic ID and assigns a map number. • Auto-generating map IDs is available when you select <Project Map File> or a custom map file. If you auto-map a map ID and do not select a map file, the map ID resides in the default map file (BSSCDefault.h).
Page 238: Dynamic Editing Of Context-Sensitive Topics
USING ROBOHELP HTML 9 Context-sensitive Help Dynamic editing of context-sensitive topics RoboHelp supports dynamic editing of the context-sensitive topic associated with an application dialog box. If no topic is associated with the dialog box, you can either dynamically map an existing topic with the dialog box or create a new topic and then map it with the dialog box.
Page 239: Contents
RH_ShowHelp files which you import into your development project. Languages supported are Visual Basic, C/C++, JavaScript, and Java. The files are in C:\Program Files\Adobe\Adobe RoboHelp [version]\CSH API. The files are: • CSH API\RoboHelp_CSH.vb (Visual Basic) • CSH API\RoboHelp_CSH.cpp (C/C++, dependent on the .h) •...
Page 240 USING ROBOHELP HTML 9 Context-sensitive Help Note: In the following examples, the API shares the same parameters regardless of output type. The only change made is the location of the Help file. Stores the full path to the start page and a dialog name in a string variable called WebHelp/FlashHelp StrPathAndWindow.
Page 241 USING ROBOHELP HTML 9 Context-sensitive Help Program Help for Visual C++ applications This information is for developers connecting context-sensitive Help topics to C++ applications. Open the project in the C++ IDE. Add RoboHelp_CSH.cpp and RoboHelp_CSH.h to the project. Link the wininet.lib and hhctrl.lib libraries to the application. Look for the hhctrl.lib library in the CSH API subfolder of the installation folder.
Page 242: Contents
USING ROBOHELP HTML 9 Context-sensitive Help Parameter Data type Description hParent HWND Handle to calling the dialog box HTML Help Only: Close the Help dialog box with the calling window. a_pszHelpFile const char * Help source For Webhelp/FlashHelp: "Path to project start page" For Webhelp Pro: "http://[ServerName]/roboapi.asp"...
Page 243 USING ROBOHELP HTML 9 Context-sensitive Help a_ pszHelpId const char * (Optional) ID of help content to be viewed in Viewer. It is specified in .helpcfg file. a_pszWindowName const char * (Optional) Customized output window name. ulMapNum unsigned long Context-sensitive map number a_pszMapId const char * (Optional) Context-sensitive map ID.
Page 244 USING ROBOHELP HTML 9 Context-sensitive Help Call a context-sensitive function for WebHelp Pro Call the function. The following example assumes the full path to the server and a window name are stored in a string variable called StrPathAndWindow. The project name is required if the Auto-Merge option is set to Off. The value of this string http://<servername>/robohelp/rest/search?project=<project-name>&quesn=<search-query>...
Page 245: Contents
USING ROBOHELP HTML 9 Context-sensitive Help • To use the RoboHelp API instead of the default MFC Help handler, override the WinHelp function in your mainframe class. By default, Visual Studio calls this class CMainFrame, and you can use the class wizard inside Visual Studio to create the function override.
Page 246 USING ROBOHELP HTML 9 Context-sensitive Help CWaitCursor wait; // Get the path to the Help system CWinApp* pApp = AfxGetApp(); ASSERT_VALID(pApp); // Set the path to server-based help CString csOnlineHelpPath = _T("http://RoboHelp Server:port/robohelp/server"); PrepareForHelp(); // must use top level parent (for the case where m_hWnd is in DLL) CWnd* pWnd = GetTopLevelParent();...
Page 247 USING ROBOHELP HTML 9 Context-sensitive Help public static boolean RH_ShowHelp(int hParent, String a_pszHelpFile, int uCommand, int dwData) Parameter Data Type Description hParent Reserved for future versions. Use 0. a_pszHelpFile String Help source For Webhelp/FlashHelp: "<Path to project start page>" For WebHelp Pro: "http://[ServerName]/roboapi.asp"...
Page 248 USING ROBOHELP HTML 9 Context-sensitive Help Program Help for web pages This information is for developers connecting context-sensitive Help topics to web pages. Talk to the Help author to determine the following: • Who provides the map numbers. • If the project has context-sensitive Help. •...
Page 249: Contents
USING ROBOHELP HTML 9 Context-sensitive Help Parameter Data Type Description hParent Reserved for future versions of API. Use "0." a_pszHelpFile Help source For WebHelp: "<Path to project start page>" (Can be local or on a server) For WebHelp Pro: "http://[server name]/roboapi.asp" *Optional: To specify a window, use ">WindowName"...
Page 250 You can use any .NET language, such as Visual Basic .NET or C# .NET, to create ASP .NET pages and AS P.NET XML web services files containing server-side logic. Make a Help call Use the context-sensitive Help code samples that Adobe provides. Last updated 12/14/2011...
Page 251: Contents
USING ROBOHELP HTML 9 Context-sensitive Help Make sure that context-sensitive Help function calls specify the online Help in the individual calls to RH_Showhelp When a remote Help call is made, the online version of the Help system appears. If connecting to the Internet is not possible, offline Help appears.
Page 252: Contents
USING ROBOHELP HTML 9 Context-sensitive Help Select OK. Double-click the Help button. Copy C# .NET context-sensitive Help example code and paste into the code. Add using RoboHelpAPI to the top of the document. To test, compile, and run the project, select the Help button. Call context-sensitive Help for WebHelp or FlashHelp from ASP .NET Include the RoboHelp_CSH.cs file in the project.
Page 253: Contents
USING ROBOHELP HTML 9 Context-sensitive Help Double-click the button. Copy the ASP.NET context-sensitive Help example code. Paste it into the code. In the code, add using RoboHelpAPI. To test, compile and run the project. Select the Help button. Call context-sensitive Help for WebHelp or FlashHelp from Visual Basic .NET Include the RoboHelp_CSH.vb file in the project.
Page 254 USING ROBOHELP HTML 9 Context-sensitive Help Double-click the button. Copy the Visual Basic .NET context-sensitive Help example code and paste it into the code. To test, compile and run the project. Select the Help button. Locate the RoboHelp Server with .NET samples Select Start >...
Page 255 USING ROBOHELP HTML 9 Context-sensitive Help Display content An ASP file is included for viewing content. The default hyperlink is http://<RoboHelp Server>/Roboapi.Asp. You can pass a parameter to the ASP file: • project=Project_Name • context=MapNumber • url=URL For example: • This URL displays default content from the server: http://<RoboHelp Server>/Roboapi.Asp •...
Page 256 USING ROBOHELP HTML 9 Context-sensitive Help Private Declare Function ShellExecute Lib _ "shell32.dll" Alias "ShellExecuteA" _ (ByVal hwnd As Long, _ ByVal lpOperation As String, _ ByVal lpFile As String, _ ByVal lpParameters As String, _ ByVal lpDirectory As String, _ ByVal nShowCmd As Long) As Long function requires an explicit filename or URL.
Page 257 USING ROBOHELP HTML 9 Context-sensitive Help BOOL ShowHelp(LPCTSTR szTopic, BOOL bIsLocal) TCHAR szDir[MAX_PATH] = ""; if (bIsLocal) // Get directory of application DWORD dw = GetModuleFileName(AfxGetInstanceHandle(), szDir, MAX_PATH); TCHAR* pchEnd = _tcsrchr(szDir, '\\') + 1; ASSERT_POINTER(pchEnd, TCHAR); *pchEnd = '\0'; // Append subfolder name _tcscat(szDir, _T("Help"));...
Page 258 Help” on page 255. Note: If you must use your HTML Help output as a backup to a WebHelp, WebHelp Pro, FlashHelp, or FlashHelp Pro system that is on a server, use Adobe's airplane Help. Context-sensitive HTML Help function call...
Page 259 USING ROBOHELP HTML 9 Context-sensitive Help A map number from the map file. Dwmapnumber Troubleshoot window-level Help Note: Microsoft HTML Help projects only. Problem Wrong Help topic opens. Error message Command: HH_HELP_CONTEXT Processing C:\Project Folder\HelpProject.chm Map Number: 2750 File: Folder_Name\Topic_Name.htm Cause Incorrect map ID.
Page 260 USING ROBOHELP HTML 9 Context-sensitive Help Problem Topic does not appear or wrong topic appears. Error message 1. Command: HH_HELP_CONTEXT Processing C:\Project Folder\Project_Name.chm Map Number: 1 File: Folder_Name\Topic_Name.htm 2. Command: HH_HELP_CONTEXT Processing C:\Project Folder\Project_Name.chm Result: Cannot find 180010 in C:\Project Folder\Project_Name.chm Cause Wrong map number used in the call.
Page 261 USING ROBOHELP HTML 9 Context-sensitive Help Example: public class ContextHelp private HelpSet hs; private HelpBroker hb; public boolean ShowHelp(String strTopic, String strHelpSet){ if (hb == null) { ClassLoader loader = getClass().getClassLoader(); URL url; try { url = HelpSet.findHelpSet(loader, strHelpSet); hs = new HelpSet(loader, url); catch (Exception e) { return false;...
Page 262: Contents
USING ROBOHELP HTML 9 Context-sensitive Help Sample context-sensitive Java application /********************************************************************************* * Oracle Help Context-Sensitive Help Sample Application * This application is intended to demonstrate a few methods for invoking * context-sensitive Help with Oracle Help. * USAGE: CSHSample <full path to helpset file> *********************************************************************************/ import oracle.help.Help;...
Page 263: Contents
USING ROBOHELP HTML 9 Context-sensitive Help System.err.println("CSHSample Error: " + e.getMessage()); System.exit(1); CSHSample sampApp = new CSHSample(bookObj); sampApp.setVisible(true); // Class Constructor public CSHSample(Book bookObj) super("CSH Sample Application"); setResizable(false); setSize(300, 200); // Create Help Objects try { helpObj = new Help(false, false); contextManager = new CSHManager(helpObj);...
Page 264: Contents
USING ROBOHELP HTML 9 Context-sensitive Help Label label = new Label("Country:", Label.LEFT); mainPanel.add(label); // Set context help for component. TopicID = LABEL // Pass the component with the associated TopicID to the CSHManager Object contextManager.addComponent(label, LABEL, true, true); // Add TextField TextField field = new TextField(15);...
Page 265: What's This? Help
USING ROBOHELP HTML 9 Context-sensitive Help Note: Oracle Help uses topic IDs (in a map file) to make context-sensitive Help calls. You can change the topic ID by editing the topic's META tag. What’s This? Help About the What's This? Help Composer tool The What's This? Help Composer tool installs with RoboHelp.
Page 266 USING ROBOHELP HTML 9 Context-sensitive Help Select an application. This is the name of the executable file (.exe), dynamic link library (.dll), or ActiveX control (.ocx). Click Browse. In Files Of Type, select the file format. Navigate to the folder that contains the application. Double-click the application file to select it. Click Next.
Page 267 USING ROBOHELP HTML 9 Context-sensitive Help • To open your project in What's This? Help Composer, double-click the Context.txt file. Open What's This? Help projects Open the project in RoboHelp. Select View > Pods > Project Set-up. Select Edit > What's This? Help Project. The project opens in What's This? Help Composer. Note: Only HTML Help systems that are intended for C or C++ applications are supported by What's This? Help Composer.
Page 268 USING ROBOHELP HTML 9 Context-sensitive Help Test a map number or a topic. HH_DISPLAY_TOPIC requires the relative path and filename in the HTML Command File field. Identifies the custom window for topic content. Use only if you have a custom window for Dialog (Optional) displaying window-level Help topics.
Page 269: Maintaining Text-Only Topics (Microsoft Html Help Projects)
USING ROBOHELP HTML 9 Context-sensitive Help Problem The wrong topic or no topic appears. Error message No message Command: HH_TP_HELP_WM_HELP?HH_TP_HELP_CONTEXT_MENU Processing: Project_Name.chm Control ID: 1174 Help ID: 1003 File: Folder_Name/FileName.TXT Cause A map number in the map file is missing its matching topic ID. A topic ID is matched to the wrong topic.
Page 270: Working With Text-Only Topics
USING ROBOHELP HTML 9 Context-sensitive Help Notes: • If you are creating text-only topics and window-level topics, avoid using the same map file for both. • Each time you update your context-sensitive Help, test all topics that have been changed or added. Working with text-only topics Create text-only topics When creating text-only topic files for Microsoft HTML Help, you create topics and write content in the same dialog...
Page 271 USING ROBOHELP HTML 9 Context-sensitive Help Double-click the topic file (.TXT). Select the topic from the Topic ID list. Edit the text in Topic Text. Click Add/Update. Version-control projects may have more options. You can edit map numbers in this dialog. Test text-only topics Testing text-only topics requires access to the application.
Page 272: Testing Context-Sensitive Help
USING ROBOHELP HTML 9 Context-sensitive Help Remove text-only topic files Remove text-only topic files (.txt) from Microsoft HTML Help projects when you no longer need them. Select View > Pods > Project Set-up. The Project Set-up pod appears. Open the Context-Sensitive Help and What's This? Help Files folders. Select the topic file (.txt).
Page 273 USING ROBOHELP HTML 9 Context-sensitive Help Note: Before you start using BugHunter, you must launch Html Help Workshop once. To launch Html Help Workshop, double-click the hhw.exe file in the Html Help Workshop install folder. Use BugHunter for the following tasks: •...
Page 274: Context-Sensitive Help Terms
USING ROBOHELP HTML 9 Context-sensitive Help View map numbers in hex format Select Tools > Options. Click the BugHunter tab. In Display options, select Map Numbers In Hex. Test in the application To test context-sensitive Help in the application, follow these guidelines: •...
Page 275: Reference
RH ShowHelp WebHelp Pro, WebHelp, and HTML Help. (WebHelp and WebHelp Pro projects) Adobe provides support files that allow developers to import Support files code and enter variables. Each supported language has a corresponding support file with functions to use for calling WebHelp Pro or WebHelp projects and displaying individual topics for context-sensitive Help.
Page 276: Chapter 12: Generating Help And Printed Documents
Chapter 12: Generating Help and printed documents Single sourcing basics About single-source layouts Single-source layouts act as templates for different versions of the project output. RoboHelp provides single-source layouts for each output type. Typically, when generating a different version of the project (such as an online tutorial), you use different settings for the output.
Page 277 • CSH map IDs • See Also keywords • Related Topics keywords The Exclude Unreferenced Topics From Output option is available in Adobe AIR, WebHelp, WebHelp Pro, FlashHelp, FlashHelp Pro, Microsoft HTML Help, XML Output, Oracle Help, and JavaHelp layouts. More Help topics “Generate...
Page 278: Work With Layout Types
WebHelp is an uncompiled output type that ensures that users can view web-based or desktop application Help in any browser and platform. It supports standard Help features and provides customizing capabilities. You can author content in another HTML editor, such as Adobe Dreamweaver, and still take advantage of the WebHelp navigational and organizational Help features.
Page 279: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents Text-to-speech utilities read the contents of the active window, available options, or text you type. These utilities and screen review aids translate onscreen text to speech or to a dynamic, refreshable, Braille display. This technology can provide keyboard assistance or shortcuts, captions for speech and sound, and visual warnings such as flashing toolbars.
Page 280: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents WebHelp Pro and FlashHelp Pro layouts About WebHelp Pro and FlashHelp Pro WebHelp Pro and FlashHelp Pro layouts deliver server-based output for web and applications. To publish this output to a server, RoboHelp Server must be installed. WebHelp Pro is an uncompiled output type that supports standard Help features.
Page 281: Contents
Flash Player 8 or later and a web browser to view the Help system. Nearly all browsers have Flash Player installed. Flash Player is free and can be downloaded from www.adobe.com/go/getflashplayer. FlashHelp supports the traditional tri-pane Help system layout (toolbar on top, navigation at left, content at right). It can also generate Help systems in a vertical orientation that minimizes the required screen area by stacking the navigation above the Help content.
Page 282: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents Project source files (generated at the top level of the project folder) Other project files (created when building and generating a project) Filename extension Description *.chm Compressed output for compiled HTML Help, used to view the Help system. (HTML Help only) CHM files added as subprojects to a master project must also be in the same folder as the master project.
Page 283: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents A collection of all files in the project in a single CHM file that occupies less disk space and is faster Compressed HTML to load. You can ship this compiled file with an application or distribute it to users as a stand-alone online document. Generating Microsoft HTML Help The RoboHelp Help compiler processes all source files into a distributable format, which can then be tested or distributed.
Page 284 USING ROBOHELP HTML 9 Generating Help and printed documents Extract CHM files You can extract source files from a compiled Microsoft HTML Help file (CHM). In the Toolbox pod, double-click HTML Help Studio. Select File > Open, and then select a CHM file. Click Open. Do either of the following: •...
Page 285 USING ROBOHELP HTML 9 Generating Help and printed documents JavaHelp layout About JavaHelp JavaHelp is a compressed output type that works with applications written in the Java programming language. JavaHelp and Java applications run on various platforms. RoboHelp provides support for the JavaHelp format and automatically creates all Java-based Help features and the HTML-based features such as HTML content and hypertext links.
Page 286: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents Appear inline. Expanding glossary hotspot definitions Fonts are automatically set to JavaHelp default fonts. Font size is unsupported. Fonts Only simple forms appear properly in the JavaHelp viewer. Forms Unsupported. Framesets Unsupported.
Page 287: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents Note: Version 3.2.2 is built using the Oracle internal Java GUI tool kit called EWT. Version 4.1.2 is built using Java Foundation Classes. The functionality, APIs, and supported file formats are the same in both versions. To build applications using JFC, or to build custom navigators for the Help project, use version 4.1.2 or later.
Page 288 USING ROBOHELP HTML 9 Generating Help and printed documents Assigned to top-level books or nodes in the TOC. Titles Merge Oracle Help projects ❖ Add a reference to an external HelpSet file (with the .hs extension) when you generate Oracle Help. Adding a reference to an external HS file adds all views, with other project files, to the existing project.
Page 289: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents Example of an Oracle Help full-text search Oracle Help limitations Not all limitations apply to every Oracle Help project. Supports all caps and small caps. Capitalization Appear inline. Expanding glossary hotspot definitions Limited font support.
Page 290 You use the Adobe AIR layout to generate Help as an Adobe AIR application, browser-based Help (with the theme and skin of an Adobe AIR application), or a packaged data file that can be viewed in an AIR Help viewer.
Page 291 You can install the AIR application locally or distribute it to your users. Users can update their installed Help system based on Adobe AIR whenever an update is available on the web. For more information about autoupdates, see the AutoUpdating section in the Adobe AIR Help article by Peter Grainge.
Page 292: Contents
You configure the settings for the Help application installer. ❖ In the General tab of the Adobe AIR dialog box, set the following under the Installer Settings group: A digital signature ensures that the Help system (or its updates) has not been altered or Digital Certificate corrupted since it was created.
Page 293 Set the Help viewer window and branding options Appearance settings define the appearance for the Help viewer window. ❖ In the Adobe AIR dialog box, select the Template group and set the following: Select a template from the pop-up menu. Template Select a skin from the pop-up menu.
Page 294 You configure how the Help application behaves when a user uses it. ❖ In the Adobe AIR dialog box, select the View group, and set the following: Select to enable highlighting of search results. Topics that match the search criteria Enable Highlight Search Results appear with the search term highlighted.
Page 295: Contents
Show Online Content applicable only if you select the output type as Adobe AIR Application or AIR Application And Browser Based Help. Note: If you select this option, make sure that you publish browser-based Help to the location pointed by the server URL.
Page 296: Contents
You can directly upload the generated browser-based Help to a server. Consult your system administrator for information about which server to use. Note: Server configuration is not applicable if your output type is Adobe AIR Application. Select Server in the Adobe AIR dialog box.
Page 297: Generate, View, And Publish Output
Create a self-signed digital certificate You can create a digital certificate to test or privately distribute the Adobe AIR Help application. However, if you distribute Help through your website, be sure to procure a digital certificate from a certificate authority (CA), such as Thawte or VeriSign.
Page 298 USING ROBOHELP HTML 9 Generating Help and printed documents You can use a combination of WebHelp and WebHelp Pro output or Adobe AIR Application and Browser Based Help output to deliver Airplane Help, which is a popular name for integrated offline/online Help. Read...
Page 299: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents In the Content Categories tab, create content categories to publish the output as a package of user-centric Help systems (for example, a package of Help systems for different user roles, geographies, products, or platforms). End users view the output as an integrated package of Help systems and have the flexibility to select the Help system they want to access from a drop-down list.
Page 300: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents Select this option to exclude any topic that exists in the project but is Exclude Unreferenced Topics From Output not the default topic in the layout or is not referenced from the selected TOC, index, or browse sequence, or any referenced topic.
Page 301 USING ROBOHELP HTML 9 Generating Help and printed documents • To add a button that users can click to synchronize the TOC, click the pop-up menu and select Manually. Note: If you use custom skins, provide a button icon in the WebHelp Skin Editor. Select to add breadcrumbs in the topic pages.
Page 302: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents Set options for generating FlashHelp In addition to the standard generate options, set the following FlashHelp options, as necessary: Set the following options, and then click Next. Specify the title you want to display in the title bar. Title Bar Specify an icon to associate with the Help system.
Page 303: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents Mark of the Web is a comment in the HTML markup for a web page. Internet Explorer 6 Add Mark Of The Web and later reference this comment to determine the security zone for the page on the user’s computer. Select this option to avoid having Internet Explorer block the output.
Page 304: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents Set the following options, and then click Save And Generate. Specify a server location for the output. To publish to a SharePoint site, click New and select SharePoint. Server Enter the UNC path of the folder on the SharePoint site (If the folder is mapped as a network drive, click Browse to select the drive).
Page 305: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents Specify the output language for the layout if the language is different from the language of the project. Language RoboHelp uses this language setting for the UI strings and language-related UI elements in the preview and generated output.
Page 306: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents (FlashHelp Pro) If selected, the generated output path is copied to the local-trusted Auto-Manage Flash Security sandbox of Flash Player. Because of security changes in Flash 7 and later, place SWF files in the trusted security sandbox of Flash Player.
Page 307: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents Select this option to exclude any topic that exists in the project but is Exclude Unreferenced Topics From Output not the default topic in the layout or is not referenced from the selected TOC, index, or browse sequence, or any referenced topic.
Page 308: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents Select this option to apply formatting at the project level: Apply To All Topics • The selected master page overrides the settings of all the individual topics with or without a master Master Page page applied to them in the project.
Page 309: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents Click Select to select a topic to display when Help opens. Default Topic Specify options for the navigation bar. In-Topic Navigation Bar Select a table of contents to display in the output. Table Of Contents Select an index to display in the output.
Page 310: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents • Delete the selected SubHelpSet file. Remove Click to browse to the Java JDK install folder. Click Network to locate and map the Locate Java SDK Install Folder folder on a network drive. You can define the viewer class for a given MIME type by specifying the following information.
Page 311: Contents
Click Generate. Generate output in the ePub format The ePub format helps you to distribute content to mobile devices, eBook readers, and tablets. Adobe Digital Editions, Calibre, and the ePub Reader plug-in with Mozilla Firefox are some ePub readers. Adobe Digital Editions reader software is free and can be downloaded from the Digital Editions product site.
Page 312 USING ROBOHELP HTML 9 Generating Help and printed documents Note: The ePub output does not support indexes and glossaries. Select or define the conditional build expression. Click Save. The sample projects available in your installation (accessible from the Starter pod) contain layouts that are configured for ePub output.
Page 313: Contents
View WebHelp, WebHelp Pro and FlashHelp Pro output To preview a WebHelp Pro or FlashHelp Pro project locally without publishing to the Adobe RoboHelp Server, open it in a web browser. You can’t preview the index, table of contents, links, and browse sequences locally.
Page 314 Search button and Windows properties. The project opens in the default browser. Important: If the topics contain links to PDFs, make sure that Adobe® Acrobat® 10 is installed on your computer. Previewing any PDF in Acrobat 9 or earlier versions might not work correctly.
Page 315: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents Create and locate a Help content configuration file The AIR Help viewer must be associated with the Help content file to display content in the selected format. Create an XML file with a .helpcfg extension to associate the RHA file with the AIR Help viewer. Save the file at the same location as the installed AIR file.
Page 316 Command-line generation publishes layouts without opening RoboHelp, or automatically in a scheduled batch. Command-line and batch generation and publishing can occur simultaneously. Note: To access the command prompt from within RoboHelp, click Start > Programs > Adobe RoboHelp [version]> Tools > RoboHelp Command Prompt.
Page 317 USING ROBOHELP HTML 9 Generating Help and printed documents Open the application from the command prompt At the command prompt, enter the command in the following format: rhcl myproject\myproject.xpj Access the output files in the default output folder. Generate layouts from the command prompt •...
Page 318: Distribute The Project Output
In the Adobe AIR dialog box, select the View group and select Enable Auto Update, if it is not enabled already. Specify the location of the updated Help content configuration file (XML file) that is hosted on a shared location or web server.
Page 319: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents Note: Add the output to version control to provide accessibility to others. Distribute WebHelp For Help systems published to a central location, only the information relevant to the current inquiry is downloaded to user browsers.
Page 320: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents File Description whgdef.htm Glossary definitions whgdhtml.htm Manages glossary terms and definitions whghost.js Supports glossary whhost.js Lists and loads files in index and glossary whibody.htm Index lower pane whidhtml.htm Index frameset whiform.htm Index upper pane whihost.js Supports index...
Page 321: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents File Description whthost.js Supports TOC whtopic.js Supports in-topic navigation bar whutils.js Supports common functions whver.js Determines browser version Output files in the Whgdata subfolder Files in !SSL!\Webhelp\Whgdata are used with Pure HTML WebHelp. File Description whexpbar.gif...
Page 322 USING ROBOHELP HTML 9 Generating Help and printed documents File Description whftdata0.htm Full-text search data - HTML support whftdata.js Full-text search data - JavaScript supporting WHFDATA0.HTM whftdata0.xml Full-text search data - XML support whFull-text search.htm Full-text search index data - HTML support whFull-text search.js Full-text search index data - JavaScript supporting whFull-text search.htm whFull-text search.xml...
Page 323: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents File Description WHIDATA0.XML Index data WHIDX.XML Index of index data WHTDATA0.XML TOC data WHTOC.XML TOC index of TOC Distribute FlashHelp Users need a browser and Flash Player 8.0 or later to view FlashHelp. If the Help system is stored locally, the. By default, all FlashHelp output files are placed in a project subfolder (!SSL!/FlashHelp).
Page 324: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents File Description WF_*.HTM FlashHelp run time FLA files SKIN_*.SWF Skin files WFRES.XML Localization file (generated from LNG file) that contains all strings loaded into FlashHelp at run time WHPROJ.XML Project file used by the DHTML version of FlashHelp to load navigation data whmozemu.js Functions supported in Netscape Navigator WF_MASTER.JS...
Page 325 Windows that users have. • Microsoft HTML Help Support Files Built-in components. • HHActiveX.DLL is an Adobe ActiveX control that provides support for online glossaries and browse sequences. Install and register the HHActiveX.DLL file on user systems. Copy this file from C:\Program Files\Adobe\Adobe RoboHelp [version]\RoboHTML into the same folder as the CHM.
Page 326 Users copy the ActiveX control files into a custom folder, placing the path for the alternate folder before the .ocx or .dll extension, and then register the files. Note: The Adobe licensing agreement lets you redistribute Microsoft HTML Help and Internet Explorer files with the HTML Help output.
Page 327 Contains JavaScript functions for advanced functionality NewProject.htm Project start page NewProject.log Output file that lists all necessary files More Help topics “View output” on page 307 Distribute Adobe AIR output Distribution of Adobe AIR output depends on the output type you select. Last updated 12/14/2011...
Page 328: Contents
Add the path to the local folder in which the browser-based Help files are stored. Moderator password and configuration file path When you distribute Adobe AIR output, make sure that you share the moderator password and configuration file path that you specified while generating the output.
Page 329: Printed Documents
About modifying the status of new comments Authors set the status of new comments to Pending or Accepted at the time of generating Adobe AIR output. Users can access the file present in the network location for storing and syncing comments and change settings.xml...
Page 330: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents Organize and customize content Design a printed document based on only part of the project or the entire project. Determine where topics go in the document by arranging the pages and books during generation. Base printed document structure on the project TOC or select topics from custom folders in the Project Manager.
Page 331: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents Feature Conversion notes Images Specify whether you want to place or embed images. Placed images are included in an images folder in the output folder. Embed images if you want to place them within the document. Images can be included in headings, and then they also appear in the printed TOC.
Page 332: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents Note: You can also create a TOC from the Project Manager. Right-click a topic in the TOC pod, and choose Auto- Create TOC. Topics from the Project Manager are automatically promoted or demoted in heading style depending on their placement in the printed document structure.
Page 333 USING ROBOHELP HTML 9 Generating Help and printed documents Accessory pages • An accessory page, such as an acknowledgment, appendix, foreword, or copyright, retains its original formatting. • The filename is Chapter_{##}_{Document name}. • When you add the file, you can copy it to the project folder. A copy is also generated in the output folder. •...
Page 334 USING ROBOHELP HTML 9 Generating Help and printed documents Select TOC, index, and glossary to display in the generated Help. Content Select a variable set for the printed document. Variable Set Specify detailed TOC, glossary, and text options. Advanced Note: If you apply inline formatting to a heading, the inline style does not appear in the document unless you select the Styles in TOC field.
Page 335: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents • Select Finish to generate. When the PrintDoc.dot macro message displays, click Disable Macros to continue. When the PrintDoc.dot macro message displays, click Disable Macros to continue. Notes: • All Microsoft Word documents must be closed. •...
Page 336 USING ROBOHELP HTML 9 Generating Help and printed documents • RoboHelp Style Mapping.dot template • A Word default template Add new styles to the template Analyze project styles to see how they map to Word. Create new styles as necessary. Consider the following: After conversion, drop-down and expanding text appears as inline text, for example.
Page 337 USING ROBOHELP HTML 9 Generating Help and printed documents • Books that link to pages are treated like topics. RoboHelp makes these heading adjustments when it creates the printed document TOC. Paragraph styles can be mapped only to paragraph styles in Word. They apply to font attributes, line Paragraph styles spacing, numbering, and borders and shading.
Page 338 USING ROBOHELP HTML 9 Generating Help and printed documents In the Select Template File dialog box, open a template. Choose copy to the project Use Microsoft Word Templates folder or overwrite an existing template. Click Yes to enable quick access to the template. To share the template with other authors and maintain it in one location, click No.
Page 339 Generate a PDF with setup options In the Single Source Layouts pod, double-click the printed documentation layout. In the Output Format area, select Generate Adobe PDF. Click PDF Settings. Set options. Select options on each screen to set up the chapter layout, the section layout, and the styles. Click Next to progress through the screens.
Page 340: Skins
About skins Use skins to change the appearance of Adobe AIR, WebHelp, and FlashHelp systems. Skins apply to the left side of a window and the toolbar across the top of the output. Customize the Help system by changing colors, buttons, fonts, and icons, and by adding backgrounds and logos.
Page 341 Import skins When you import Adobe AIR AHS files, WebHelp SKN files, or FlashHelp FHS files, all associated files are added to the skins subfolder. You can also import a compressed AHZ (for Adobe AIR), ZKN (for WebHelp), or FHZ (for FlashHelp) file.
Page 342 In the toolbar, click the View button Compile skins Each template for the Adobe AIR layout has an associated style sheet called exStyle.css. You can locate this file in [Project folder]\!SkinSubFolder!\[skin name] and directly modify the styles in a text editor.
Page 343 Note: You can save a customized palette in the gallery. Specify a name for the customized palette in the Selected Palette box and click Save. You can also remove customized palettes by deleting the XML file from %Application Data%\Adobe\RoboHTML\[version]\AIRSkinEditor\ColorThemes. Modify font properties Font properties include font type and font color.
Page 344: Contents
USING ROBOHELP HTML 9 Generating Help and printed documents On the Action tab, define a link or a script for the button: • Link the button to a URL. Type the path or click the Browse button to browse to it. Linked files are Link copied to the skins folder (ProjectName\!SkinSubFolder!\YourSkin).
Page 345 You can customize FlashHelp skins by replacing elements in an existing skin with elements from another skin. If you’re a skilled Flash developer, you also can create a skin with Adobe Flash or the RoboHelp Skin Development Kit. The SDK includes instructions for using the kit and tips and tricks.
Page 346 USING ROBOHELP HTML 9 Generating Help and printed documents Right-click the SWF file and select Copy. Open the skin subfolder containing the SWF files to replace. Paste and replace the files. In RoboHelp, when you generate the project, select the newly modified skin in the FlashHelp Properties dialog box. When project generation has finished, click View Result to test the skin.
Page 347: Windows
USING ROBOHELP HTML 9 Generating Help and printed documents Windows RoboHelp supports WebHelp and FlashHelp windows for use with the context-sensitive Help API. Create or edit windows Note: This procedure applies to WebHelp, WebHelp Pro, FlashHelp, FlashHelp Pro, and HTML Help. Specify the primary layout.
Page 348 USING ROBOHELP HTML 9 Generating Help and printed documents Button Description Opens and closes the navigation pane. Hide/Show Opens the previous topic. Back Opens the next topic in a pre-viewed sequence. Forward Stops a web page form displaying. Stop Updates the topic content. Refresh Shows the default web page.
Page 349 USING ROBOHELP HTML 9 Generating Help and printed documents • Select the tab to display when the HTML Help project opens. Default Tab • Select a default location for the window tabs. Tab Position Set properties for the onscreen appearance and behavior of the panes. Tri-pane Options •...
Page 350 USING ROBOHELP HTML 9 Generating Help and printed documents Minimizes application when window is open. Window style ID is WS_MINIMIZE. Minimize Maximizes application when window is open. Window style ID is WS_MAXIMIZE. Maximize Displays border around window. Window style ID is WS_BORDER. Border Displays window in a dialog frame.
Page 351 USING ROBOHELP HTML 9 Generating Help and printed documents Add a jump button On the Windows Properties dialog box, select Button 1. Click Advanced Properties. On the Destinations tab, in the Button 1 label, enter label text for the icon displayed in the window (optional). In Custom Button 1 URL, enter the link website address.
Page 352 USING ROBOHELP HTML 9 Generating Help and printed documents Desired result Action Enable browse sequences (If you create browse sequences in the Select Browse Sequences. project, select this feature so functionality is available in the browser.) Specify the location for the in-topic navigation bar. Select Top Right, Bottom Left, or Bottom Right as the location.
Page 353: Chapter 13: Review And Collaboration
Chapter 13: Review and collaboration At different stages of content development and even after delivery, you need input from various stakeholders, such as other authors, SMEs, editors, and end users. RoboHelp enables effective collaboration among all these roles by providing multiple ways of gathering, tracking, and addressing feedback. Review in Design Editor Insert your review comments directly in a project.
Page 354: Pdf Review
The Create PDF For Review option in the Review menu lets you create a PDF that reviewers can review with the free Adobe Reader. The PDF stores a tagged structure of the RoboHelp project, enabling you to import comments back in the RoboHelp project.
Page 355 USING ROBOHELP HTML 9 Review and collaboration Embed SWFs in review PDF To ensure that the PDF for review includes the SWFs inserted in the project, do the following: Select Tools > Options > General. Select Embed SWF In Review PDF. Note: When you create a PDF for review without selecting this option, the PDF contains placeholders where SWFs are inserted in the project.
Page 356: Manage Comments And Changes
USING ROBOHELP HTML 9 Review and collaboration Import of comments added to placeholders, snippets, and headers and footers For mini TOCs, breadcrumbs, snippets, and headers and footers in master pages, RoboHelp places comments above or below these elements. It does not insert the comments in the location where they were added in the PDF. Insertions and deletions are also imported as sticky notes.
Page 357 USING ROBOHELP HTML 9 Review and collaboration Displays all comments and changes in Review Pane as well as in Design Editor. Show All Enables you to select one of the three views: All Types, Review Comments, and Track Changes. All Show By Type Types displays both comments and changes in Review Pane.
Page 358: Review And Collaboration In Air Help
Topic rating If you are delivering Help as an Adobe AIR application, you can enable topic rating to gather user feedback. Users can rate any topic on a scale of 0-5 stars. The AIR Help application saves the topic rating for each user in a shared network drive location (same as the location for syncing comments) or on a RoboHelp server and loads the ratings at the time of viewing a topic.
Page 359 USING ROBOHELP HTML 9 Review and collaboration For information about how to specify a shared network location, see “Configure collaboration” on page 289. Store comments on a RoboHelp server If you want to allow commenting by users outside a corporate network, store comments on a RoboHelp server. The server authenticates users before allowing them to read or add comments.
Page 360 Review and collaboration Add comments Users can add comments if commenting is enabled when generating the Adobe AIR output. Comments are stored locally until you click Send To Server or Send and Receive option. Click Show/Hide Comments Pod to display the Comments pod.
Page 361: Chapter 14: Advanced Program Features
Chapter 14: Advanced program features ActiveX controls About ActiveX controls ActiveX controls are Microsoft Windows-based applications that you can plug into projects. They are small, pre- compiled, modular, and reusable. Web developers use ActiveX controls to extend the functionality of their HTML pages.
Page 362 Add ActiveX controls For the controls to work, distribute and register Custom ActiveX.ocx files on the user systems. (The RoboHelp license allows you to distribute these controls.) By default, the controls are at C:\Program Files\Adobe\Adobe RoboHelp [version]\Redist. Insert the cursor in the topic where you want to place the control.
Page 363: Applets
USING ROBOHELP HTML 9 Advanced program features Select Calendar Control [version]. The control appears in the Design editor, as shown in the following example: Double-click it and change the available settings in the ActiveX Control tab. To change the font color for weekday headings, click Add in the ActiveX Control tab. Select Dayfontcolor, enter a color value, and click OK.
Page 364: Forms
USING ROBOHELP HTML 9 Advanced program features Forms Workflow to create forms Note: Forms created in the Design Editor must have a corresponding Common Gateway Interface (CGI) script on the server. Add the form and set form properties. Add specific form elements. Link to a script that acts on the data that the user enters.
Page 365 USING ROBOHELP HTML 9 Advanced program features Enables users to select any combination of alternatives. Check boxes can represent a group of non- Check Box exclusive choices. Lets users insert a plain button on the form, designate the caption, and perform customized actions defined by Button the author.
Page 366 USING ROBOHELP HTML 9 Advanced program features Select a format for the field from the Format list. (Optional) Click New. A line with the default formatting is added at the end of the Format list. Type a name for the new format in the Current Format box.
Page 367: Frames
USING ROBOHELP HTML 9 Advanced program features Add radio buttons Select a location in the form to insert a radio button. Select Insert > HTML > Form > Radio Button. Double-click the radio button and specify the properties: Select Radio Button. Control Type Type the name to associate with the radio button.
Page 368 USING ROBOHELP HTML 9 Advanced program features Notes: • Printing is restricted to one frame at a time, although you can print the entire project from the viewer or browser. • Target hypertext links to specific frames. • Hypertext-linked external topics or URLs sometimes display incorrectly. •...
Page 369: Contents
USING ROBOHELP HTML 9 Advanced program features After the cursor has changed, drag the frame divider left or right to make one frame larger and the other frame smaller. Remove framesets If you accidentally delete a frameset, you can import it back into the project if it has not been removed from the hard disk. Select View >...
Page 370: Html Help Controls
USING ROBOHELP HTML 9 Advanced program features HTML Help controls Reuse HTML Help controls HTML Help controls are portable. You can copy the controls into topics and change them to suit their locations. In the Design Editor, open the topic that contains the control to reuse. Right-click the control and select Copy.
Page 371: Contents
USING ROBOHELP HTML 9 Advanced program features If the project does not support a tri-pane design, you can add an index control to a topic to make the index file available. The index appears when users open the topic with the index control. If the topic is in a subfolder, copy the index file (.HHK) to the subfolder before you add the control.
Page 372 USING ROBOHELP HTML 9 Advanced program features Inserts a custom image (BMP or ICO) that performs the action. Image Inserts a control that is not visible in the topic. Hidden Click Next to set up shortcut functionality. Specifies the program to run from the control. Navigate to the drive/folder where the EXE file is Program To Run located and double-click it.
Page 373: Information Types (For Html Help)
USING ROBOHELP HTML 9 Advanced program features Change HTML Help controls Note: Applies to Microsoft HTML Help projects only. In the Design Editor, open the topic with the control. Double-click the control. Right-click a control and select Design-Time Control Properties to change properties. Remove HTML Help controls In the Design Editor, open the topic that contains the control to remove.
Page 374 USING ROBOHELP HTML 9 Advanced program features In the Category field, enter a name. Classify the category: Users can select any combination of information types in a category. Inclusive Users can only select one information type in a category. Exclusive Users do not see these topics in the TOC.
Page 375: Scripts
USING ROBOHELP HTML 9 Advanced program features Edit information types (HTML Help) Change categories for information types (HTML Help) Select Edit > Information Types. From the list of categories, select one. Click in the Category box and edit the text. To change its classification from Inclusive to Exclusive or Hidden, click the option.
Page 376: About Extendscript Toolkit Support
Use this script to convert an anchor link href target across all the files in a RoboHelp project. For Link Converter example, define a link to convert www.adobe.com to www.adobe.com/support/ across all the Help files in a project. See the script file for more information.
Page 377: Creating Scripts
Adobe RoboHelp video tutorials page. For information about the methods covered in the Data Object Model, see Adobe RoboHelp Scripting Guide. Manage script folders Create a folder for storing specific scripts. For example, you can store scripts that record data in Create a script folder one folder and scripts that display output in another folder.
Page 378: Twisties
To Target Application to run RoboHelp. The icon is green to indicate that RoboHelp HTML is running. Note: If you don’t select Adobe RoboHelp in the ExtendScript Toolkit, and you try running a script, an error occurs. Twisties Use twisties to enhance glossary terms, drop-down text, and expanding text with images for open and close. Users will see different images when they open or close glossary, drop-down, or expanding text.
Page 379 Chapter 15: Default keyboard shortcuts Adobe RoboHelp HTML provides shortcuts to help you quickly work in documents without using the mouse. Use these shortcuts in Design Editor. Additional keyboard shortcuts appear next to the command names in menus. Note: To use certain shortcuts, you must select text first. Those cases are marked with an asterisk (*).
Page 380 USING ROBOHELP HTML 9 Default keyboard shortcuts Task Keyboard shortcut Open Project Settings dialog CTRL+SHIFT+/ Open Topic Properties dialog ALT+ENTER Display Conditional Build Tag dialog* CTRL+N Text formatting in Design Editor Bold CTRL+B Italicize CTRL+I Underline CTRL+U Format – Paragraph menu CTRL+SHIFT+D Format –...

This manual is also suitable for:

Robohelp html 9

Adobe 65030089 - Robohelp - PC Using Manual

Chapter 1: Getting Started

Chapter 2: Exploring the Workspace

Chapter 3: Projects

Chapter 4: Working with Topics

Chapter 5: Editing and Formatting

Chapter 6: Styles and Style Sheets

Chapter 7: Tocs, Indexes, Glossaries

Chapter 8: Linking and Navigation

Chapter 9: Multimedia and Special Effects

Chapter 10: Conditional Text

Chapter 11: Context-Sensitive Help

Chapter 12: Generating Help and Printed Documents

Chapter 13: Review and Collaboration

Chapter 14: Advanced Program Features

Quick Links

Related Manuals for Adobe 65030089 - Robohelp - PC

Summary of Contents for Adobe 65030089 - Robohelp - PC