Adobe 65030089 User Guide
Adobe 65030089 - Robohelp - PC Manual
 |
UPC - 883919170626
View all Adobe 65030089 manuals
Add to My Manuals
Save this manual to your list of manuals |
Adobe 65030089 manual content summary:
- Adobe 65030089 | User Guide - Page 1
Using ADOBE® ROBOHELP® HTML 9 - Adobe 65030089 | User Guide - Page 2
user guide is governed by these terms. The best way to provide notice is to include the following link. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc/3.0/us/ Adobe, the Adobe logo, Adobe AIR, Adobe Captivate, Acrobat, AIR, Dreamweaver, FlashHelp, FrameMaker, Reader - Adobe 65030089 | User Guide - Page 3
Contents Chapter 1: Getting started Activation and registration 1 Help and support ...2 What's new in RoboHelp 9 4 What's new in Create and manage projects 29 Authoring content in multiple languages 42 Import PDF files ...48 Importing and linking Microsoft Word documents 50 Import FrameMaker - Adobe 65030089 | User Guide - Page 4
USING ROBOHELP HTML 9 iv Contents Chapter 5: Editing and formatting RoboHelp editors ...133 Character formatting and fonts 136 Format paragraphs 138 Borders, backgrounds, color, and sound 140 Tables ...142 Lists ...145 Headers, footers, and page breaks 147 Text boxes ...148 User-defined - Adobe 65030089 | User Guide - Page 5
Adobe Captivate demos 211 Multimedia ...212 Dynamic HTML and special effects 213 Marquees ...217 HTML comments in topics 218 Iframes ...218 Chapter 10 Review in Design Editor 347 PDF review ...348 Manage comments and changes 350 Review and collaboration in AIR Help 352 Chapter 14: Advanced - Adobe 65030089 | User Guide - Page 6
USING ROBOHELP HTML 9 vi Contents Information types (for HTML Help 367 Scripts ...369 About ExtendScript Toolkit support 370 Twisties ...372 Chapter 15: Default keyboard shortcuts Last updated 12/14/2011 - Adobe 65030089 | User Guide - Page 7
activation, visit the Adobe website at www.adobe.com/go/activation. Register Register your product to receive complimentary installation support, notifications of updates, and other services. Note: Register only once for RoboHelp 9. ❖ To register, follow the onscreen instructions in the Registration - Adobe 65030089 | User Guide - Page 8
) • Activation and registration • Troubleshooting • Customer support Help and support Community Help Community Help is an integrated environment on Adobe.com that gives you access to community-generated content moderated by Adobe and industry experts. Comments from users help guide you to an answer - Adobe 65030089 | User Guide - Page 9
external RoboHelp users on various userrequested topics. RoboHelp Help and Support page Visit the Adobe Support website at www.adobe.com/support/robohelp to learn about free and paid technical support options. Previous RoboHelp Help Download the documentation of older versions of RoboHelp from www - Adobe 65030089 | User Guide - Page 10
Troubleshooting tips Before you call Customer Support, try the tips collated on www.adobe.com/go/learn_robohelp_forum_tips_en to troubleshoot RoboHelp problems. Problem Adobe RoboHelp 9 uninstaller exits with an error and does Manually uninstall (remove) Adobe RoboHelp 9. not uninstall Adobe - Adobe 65030089 | User Guide - Page 11
" on page 232. Note: The application needs to implement context-sensitive Help using the RoboHelp 9 CSH API. Currently, only C++ APIs on Windows are supported. Include external content in search Specify URLs for content available outside the Help system (for example, in blogs) and map them to terms - Adobe 65030089 | User Guide - Page 12
307. Support for latest devices, products, and browsers Stay up-to-date with support for the latest platforms, browsers, and devices (eBook readers, 10, Adobe Captivate 5, and Acrobat 10 RoboHelp 9 supports the latest version of Adobe products such as FrameMaker 10, Adobe Captivate 5, and Acrobat 10 - Adobe 65030089 | User Guide - Page 13
similar to a FrameMaker .fm file. RoboHelp 9 also supports Ditaval, which means that you can now create output Acrobat Distiller to convert FrameMaker Math equations, text frames, and freehand curves to images. Select the Use PDF For step-by-step instructions, see "Review in Design Editor" on page - Adobe 65030089 | User Guide - Page 14
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 stepby-step instructions, see "PDF SharePoint RoboHelp 9 supports publishing WebHelp, FlashHelp, and Browser based Help (Adobe AIR SSL) output - Adobe 65030089 | User Guide - Page 15
works as a time-saver where you handle queries in real time. For information about how to create content categories, see "Configure the Adobe AIR layout" on page 284 and "Set options for generating WebHelp" on page 292. A B A. Content category definition in SSL B. Content category selection in - Adobe 65030089 | User Guide - Page 16
USING ROBOHELP HTML 9 10 Getting started Merged AIR Help The capability to merge the output of multiple projects is now extended to output generated using the Adobe AIR SSL. Both Adobe AIR output types-Adobe AIR Application and Browser based Help-support merging. See "Merging Help projects" on - Adobe 65030089 | User Guide - Page 17
browse sequences and select them for content categories, see "Configure the Adobe AIR layout" on page 284 and "Set options for generating WebHelp" output Take advantage of enhanced style mapping options to generate better PDF output and printed documentation. In addition to mapping character and - Adobe 65030089 | User Guide - Page 18
. • Enable or disable topic rating Allow or disallow users to rate topics. For more information, see "Configure the Adobe AIR layout" on page 284 and "Distribute Adobe AIR output" on page 321. Customization through settings.xml Users can override the moderation setting defined in the SSL by - Adobe 65030089 | User Guide - Page 19
Server 9 User interface enhancements RoboHelp Server 9 features a fresh, aesthetically appealing user interface. Enhanced platform support • Support for Microsoft Access 2010 • Support for Apache Tomcat 7.x. Tomcat 7.x is currently in the beta stage. Technical enhancements • RoboHelp Server logs - Adobe 65030089 | User Guide - Page 20
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 Search-related enhancements RoboHelp Server 9 features many search-related enhancements: Project stop list for - Adobe 65030089 | User Guide - Page 21
USING ROBOHELP HTML 9 15 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 • The Web - Adobe 65030089 | User Guide - Page 22
16 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 - Adobe 65030089 | User Guide - Page 23
Help project, Word document, and all other available types. Resources Access forums, developer centers, knowledgebase articles, and other online content. News Announcements Access information about Adobe products. Last updated 12/14/2011 - Adobe 65030089 | User Guide - Page 24
USING ROBOHELP HTML 9 18 Exploring the workspace View Online Help Access the complete online Help. Quick Tour Of RoboHelp Access a set of videos for a quick tour of RoboHelp features. Project Manager pod The Project Manager pod contains various folders where you create and delete project files, - Adobe 65030089 | User Guide - Page 25
USING ROBOHELP HTML 9 19 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 - Adobe 65030089 | User Guide - Page 26
USING ROBOHELP HTML 9 20 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. Shared Locations Specify the various shared folders that store resource files to use - Adobe 65030089 | User Guide - Page 27
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. Menus and toolbars Customize menus 1 Right-click a toolbar and choose - Adobe 65030089 | User Guide - Page 28
USING ROBOHELP HTML 9 22 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 - Adobe 65030089 | User Guide - Page 29
USING ROBOHELP HTML 9 23 Exploring the workspace Remove or reset keyboard shortcuts 1 Select View > Toolbars > Customize. 2 Click the Keyboard tab. 3 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 - Adobe 65030089 | User Guide - Page 30
USING ROBOHELP HTML 9 24 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 > - Adobe 65030089 | User Guide - Page 31
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 - Adobe 65030089 | User Guide - Page 32
USING ROBOHELP HTML 9 26 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 - Adobe 65030089 | User Guide - Page 33
USING ROBOHELP HTML 9 27 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 - Adobe 65030089 | User Guide - Page 34
or Word template styles, and produce formatted and structured Word documents or PDF files. Adobe AIR The Adobe AIR output type allows you to generate Help in Adobe AIR format. Generate your content in the cross-platform Adobe AIR Help format that brings a host of enhancements, such as these: • Easy - Adobe 65030089 | User Guide - Page 35
JavaHelp* Help Web browser with Built-in viewer Flash Player 8.0 or 9.0 JavaHelp viewer Web browser with Not available Flash Player 8.0 or 9.0 JavaHelp viewer Oracle Help AIR Help Oracle Help viewer AIR Help Runtime Not available AIR Help Runtime * Requires JavaHelp viewer, Sun Java 2 JDK - Adobe 65030089 | User Guide - Page 36
, and so on. Disaster Recovery Plan Create a Help system with samples on how to write a disaster recovery plan. Online Manual Create an online manual for a company product or software application. Policies And Procedures Create a handbook or a document listing policies and procedures specific to - Adobe 65030089 | User Guide - Page 37
RoboHelp styles" on page 55. 9 Click OK. Note: If you click Cancel in the wizard, no files are imported and the empty project remains open. 10 Click Finish. Create a project using a DITA map file Important: For expert users only. Before you import a DITA map file, Java JDK and the DITA Open - Adobe 65030089 | User Guide - Page 38
is the default working folder where RoboHelp stores all 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 - Adobe 65030089 | User Guide - Page 39
USING ROBOHELP HTML 9 33 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. - Adobe 65030089 | User Guide - Page 40
new word. Press Enter. Set options on the LNG File pane Change text elements in the user interface for WebHelp, WebHelp Pro, FlashHelp, FlashHelp Pro, AIR Help, printed documentation, or HTML Help output. See the complete list of available changes you can make in the LNG file tab. When you edit - Adobe 65030089 | User Guide - Page 41
USING ROBOHELP HTML 9 35 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 - Adobe 65030089 | User Guide - Page 42
USING ROBOHELP HTML 9 36 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. • You cannot drag - Adobe 65030089 | User Guide - Page 43
the following: • Bitmaps and icons used with HTML Help controls • Image files used in style sheets, topic backgrounds, and scripts • The JavaScript file that supports Dynamic HTML effects, such as pop-ups and drop-down hotspots 4 Click Yes. Note: You can create a link to a baggage file by pressing - Adobe 65030089 | User Guide - Page 44
USING ROBOHELP HTML 9 38 Projects You can also browse to a program not listed in the program list. Add an HTML editor mapping 1 Select Tools > Options. 2 Click File Association tab. 3 For HTML editors, click Add. 4 Select from the recommended or other programs registered to edit or view .html or - Adobe 65030089 | User Guide - Page 45
All sound and video files used in your project are saved in this folder. Adobe Captivate demos (SWF files) are also stored here. You can drag sound or and scripts • The JavaScript file (ehlpdhtm.js) that supports Dynamic HTML effects such as related topics pop-ups, smart pop- ups, and - Adobe 65030089 | User Guide - Page 46
USING ROBOHELP HTML 9 40 Projects Rename folders Use the Project Manager to rename folders. 1 Select the Project Files folder in the Project Manager pod. 2 Right-click the folder. Select Rename. 3 Type the new name. Don't include special characters, and avoid spaces, especially for WebHelp and - Adobe 65030089 | User Guide - Page 47
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. Custom windows. Double-click to - Adobe 65030089 | User Guide - Page 48
GIF files to Adobe Photoshop®. When you rightclick a GIF file from the Images folder and select Edit, the file opens in Photoshop. More Help not affected in the end user's system. Support for multiple languages RoboHelp provides multiple language support at the paragraph, topic, and project level. - Adobe 65030089 | User Guide - Page 49
USING ROBOHELP HTML 9 Projects Languages 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 - Adobe 65030089 | User Guide - Page 50
for the Japanese language, and translate the content from English to Japanese. 9 Create Japanese tables of contents, indexes, and glossaries. 10 Create a conditional build tag called JapaneseContent. 11 Apply the JapaneseContent conditional build tag to the Japanese content. 12 Generate output for - Adobe 65030089 | User Guide - Page 51
language setting.). If you customize text in a skin, the skin text overrides any customizations you make in the LNG file. For FlashHelp, the Flash developer uses the Skin Development Kit to customize the text. WebHelp only • Without a skin Edit the language file. You can localize browse sequence - Adobe 65030089 | User Guide - Page 52
text settings in the LNG file. • Localize window captions in the Windows Properties dialog (not applicable to WebHelp projects). Language support for associated dictionaries If your project contains content authored for multiple languages, define RoboHelp language settings in the project, topic, and - Adobe 65030089 | User Guide - Page 53
Unicode and supported in RoboHelp overcomes this problem. Support for Unicode text encoding standards RoboHelp HTML supports Unicode text Language list. 6 Click OK. The selected language is included in the Installed Services list. 7 Select the desired language in the Default Input Language list. 8 - Adobe 65030089 | User Guide - Page 54
USING ROBOHELP HTML 9 48 Projects 10 Click Apply and click OK to save the settings recommended way. The recommended way is described in "Change project settings" on page 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 - Adobe 65030089 | User Guide - Page 55
ROBOHELP HTML 9 49 Projects • 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 - Adobe 65030089 | User Guide - Page 56
into a project 1 In the Project Manager pod, right-click Project Files. 2 Select the file to import into. 3 Select File > Import > PDF Document. 4 Select one or more PDF files. Click Open. 5 Select options in the Conversion Options dialog box. 6 If Create New Topic(s) Based On Style(s) was selected - Adobe 65030089 | User Guide - Page 57
USING ROBOHELP HTML 9 51 Projects 8 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: - Adobe 65030089 | User Guide - Page 58
USING ROBOHELP HTML 9 52 Projects Inline styles and style overrides You can convert inline styles to CSS styles in RoboHelp. However, converting inline styles to CSS styles can lead to numerous styles that share the same formatting. See "Converting Word styles to RoboHelp styles" on page 55. - Adobe 65030089 | User Guide - Page 59
importing a Word document. To import Word files, you must have Microsoft Word installed on your computer. Note: DOCX and DOCM formats are not supported by versions earlier than Microsoft Word 2007. See Microsoft Word Help for more information. 1 In the Starter pod, click Word Document under Import - Adobe 65030089 | User Guide - Page 60
USING ROBOHELP HTML 9 54 Projects Note: To import multiple documents with separate TOCs, select them in the order they should appear in the master TOC. 4 In the Content Settings dialog box, set conversion options for the TOC, index, and glossary, and click Next. For information about various - Adobe 65030089 | User Guide - Page 61
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. All Word style definitions in the Word document appear - Adobe 65030089 | User Guide - Page 62
USING ROBOHELP HTML 9 56 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, - Adobe 65030089 | User Guide - Page 63
USING ROBOHELP HTML 9 57 Projects 3 In the Conversion Settings dialog box, select the Character group. 4 Select the Word character style from the left pane of the Conversion Settings dialog box. 5 Select the RoboHelp character style from the pop-up menu. Optionally, you can do the following: • To - Adobe 65030089 | User Guide - Page 64
USING ROBOHELP HTML 9 58 Projects 2 In the Import tab, click Edit under Word Document. 3 Select the Word table style from the left pane of the Conversion Settings dialog box. 4 Select the RoboHelp table style from the pop-up menu. Optionally, to edit the table style in RoboHelp, click Edit Style. - Adobe 65030089 | User Guide - Page 65
paragraph style, the topic generated must contain relevant, complete information for the reader. For example, if you set pagination for Heading 3, you run the risk of creating topics with only task-level instructions. In this case, the required contextual information required to complete the task - Adobe 65030089 | User Guide - Page 66
the Help system uses sequentially numbered files, such as helptopic001.html, helptopic002.html, and so on, you can define the pattern to support that convention. 1 Do one of the following: • Select File > Import > Word Document. • Select File > Link > Word Document. • Select File > Project Settings - Adobe 65030089 | User Guide - Page 67
USING ROBOHELP HTML 9 61 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 - Adobe 65030089 | User Guide - Page 68
. You define the conversion settings, including style mapping and pagination, and then generate the topics. Select options to update a linked document manually. ❖ From the Project Manager pod, right-click a Word document, select Update, and select one of the following: Generate Generates HTML topics - Adobe 65030089 | User Guide - Page 69
USING ROBOHELP HTML 9 63 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 - Adobe 65030089 | User Guide - Page 70
USING ROBOHELP HTML 9 64 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 - Adobe 65030089 | User Guide - Page 71
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. For more information, see - Adobe 65030089 | User Guide - Page 72
a stand-alone topic does not provide the conceptual information for the reader. To avoid creating topics with incomplete information, assign context-sensitive Help the FrameMaker template. You don't have to apply the template manually. You can set RoboHelp to apply a selected template to FrameMaker - Adobe 65030089 | User Guide - Page 73
USING ROBOHELP HTML 9 67 Projects 3 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 - Adobe 65030089 | User Guide - Page 74
USING ROBOHELP HTML 9 68 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 - Adobe 65030089 | User Guide - Page 75
delineating topics from FrameMaker source, or to pass processing instructions to RoboHelp for images and tables. Formats Paragraph formats Converted to text, such as in table cells. (Rotated text is not supported in HTML). Images and anchored frames Images Only converted if they are inside - Adobe 65030089 | User Guide - Page 76
USING ROBOHELP HTML 9 70 Projects Structured FrameMaker components XML files in book XHTML files in book Content references Converted like FrameMaker documents. Converted like FrameMaker documents. Text or files inserted into FrameMaker documents as content references appear as part of the - Adobe 65030089 | User Guide - Page 77
, you can define a single FrameMaker template for conversion. For example, suppose the documentation set contains a Getting Started Guide, Installation Guide, User Guide, and an Administration Guide. These documents can have different page layouts and formats in print, none of which is relevant for - Adobe 65030089 | User Guide - Page 78
the styles either in RoboHelp or in an external CSS editing application such as Adobe® Dreamweaver®. 1 Select File > Project Settings. 2 Click the Import tab earlier document-level settings or convert to the project-level settings supported in RoboHelp 9. After you upgrade your project, you cannot - Adobe 65030089 | User Guide - Page 79
USING ROBOHELP HTML 9 73 Projects 3 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. • To discard the - Adobe 65030089 | User Guide - Page 80
USING ROBOHELP HTML 9 74 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 - Adobe 65030089 | User Guide - Page 81
format, follow these guidelines: Completeness of content in the topic Ensure that the topic generated contains relevant and complete information for the reader. For example, if you set pagination for Heading 3 level paragraph, it is possible that the topic contains only the task information, without - Adobe 65030089 | User Guide - Page 82
the conversion settings. RoboHelp imports the markers from FrameMaker documents and adds the map IDs from the strings contained in the context-sensitive Help markers. Manually adding a map ID file If you received map IDs from your development team, you use these map IDs as the context-sensitive Help - Adobe 65030089 | User Guide - Page 83
USING ROBOHELP HTML 9 77 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/ - Adobe 65030089 | User Guide - Page 84
USING ROBOHELP HTML 9 78 Projects 3 Select the FrameMaker character format from the left pane of the Conversion Settings dialog box. 4 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 - Adobe 65030089 | User Guide - Page 85
USING ROBOHELP HTML 9 79 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 - Adobe 65030089 | User Guide - Page 86
, click Edit Style. Image conversion settings Some FrameMaker documents, especially those optimized for high-quality printing through PDF, contain images in EPS format. Convert EPS images to web-supported image formats such as JPEG, GIF, or PNG for online Help. You specify the following image - Adobe 65030089 | User Guide - Page 87
the border width, select it in, in points, from the Width menu. Format Define the image format, color depth, and quality settings for the web-supported images that are converted from the images in the FrameMaker document: • As Is Select this option for retaining the images in the current web - Adobe 65030089 | User Guide - Page 88
can access the content through screen readers. If you link or import completed documents. These entries are not visible in PDF files, but they appear in online do not contain the meta tag Note: The XHTML file must have well-formed - Adobe 65030089 | User Guide - Page 89
USING ROBOHELP HTML 9 83 Projects Use DITA Val For Conditional Processing Specify a DITA Val file to use for conditional processing of the DITA files. The XHTML is generated based on the Val file. A DITA Val file contains filter, flagging, and revision information. The equivalent parameter for - Adobe 65030089 | User Guide - Page 90
USING ROBOHELP HTML 9 84 Projects 8 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 specified field. Edit the XSL file and reimport the XML - Adobe 65030089 | User Guide - Page 91
import FrameMaker (.fm, .book, and .mif) files, Word files (.doc, .docx), PDF files, and XML files. Note: If you use an HTML editor other than Design Editor pop-ups that resize to accommodate content. All HTML formatting is supported. Regular Hyperlinks Create links that open in the window in which - Adobe 65030089 | User Guide - Page 92
USING ROBOHELP HTML 9 86 Projects External topics Links To External HTML Help Topic Convert external WinHelp topic links to HTML topic links in external CHM files. Retain Keep External WinHelp Topic Links HTML topics include WinHelp Topic controls. Use this option when linking HTML topics to - Adobe 65030089 | User Guide - Page 93
character-bycharacter basis. Apply styles after importing the project. Manually apply character and paragraph attributes to new topics. External Style viewer. Note: Display pages from the WinHelp CNT in custom windows. HTML supports jumps from TOC pages to custom windows. Add Keywords To Selects the - Adobe 65030089 | User Guide - Page 94
in WinHelp? You can format books and pages in the TOC to display destination topics in custom windows or frames. Microsoft HTML Help does not support links to custom windows, though you can format these links to use pop-up note windows and frames. Last updated 12/14/2011 - Adobe 65030089 | User Guide - Page 95
the Formatted Text option to import paragraph formatting from Word documents. My WinHelp topics use manually numbered lists with {SEQ} fields. What happens to these fields? HTML does not support {SEQ} fields, but recognizes number sequences and converts the lists into numbered paragraphs. You can - Adobe 65030089 | User Guide - Page 96
the HTML files to eight characters. Distribute the HTML project as uncompiled HTML Help (not using Adobe WebHelp) Distribute the project as compiled Microsoft HTML Help or crossplatform Help using Adobe WebHelp, JavaHelp, or Oracle Help output. Actions Click Browse and navigate to the drive/folder - Adobe 65030089 | User Guide - Page 97
topics in the Design Editor. HTML topics can use AVI, AU, MID, RMI, WAV, and other files. Non-scrolling regions HTML-based output does not support non-scrolling regions. Numbered lists Numbered lists use a 12-point serif font by default. You can create a numbered list style and use it to reformat - Adobe 65030089 | User Guide - Page 98
and apply it to all topics or use different style sheets for different topics. • WinHelp topics can use a combination of defined styles and manual character and paragraph formatting. If so, create style sheets that use the same styles from the WinHelp topics to retain the special formats. • You - Adobe 65030089 | User Guide - Page 99
with RoboHelp, your version control software must support the Microsoft SCC API. You can use Adobe RoboSource Control (installed with RoboHelp) or destination folders. To turn off prompts when performing version control tasks manually, deselect the option on the Version Control tab (Select Tools > - Adobe 65030089 | User Guide - Page 100
USING ROBOHELP HTML 9 94 Projects Project Manager pod Select View > Pods > Project Manager. Displays file icons. A red check mark indicates that a file is checked out. Note: The RoboHelp user interface is optimized for RoboSource Control, Microsoft Team Foundation Server 2005, and Microsoft - Adobe 65030089 | User Guide - Page 101
by other users) when you open the project, or manually. How can I add output files to version control? connection to access the database. See Adobe RoboSource Control Help for more information. the Browse button next to the Root Path field. 10 If prompted, enter the same password that you entered - Adobe 65030089 | User Guide - Page 102
TOC. See "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 65030089 | User Guide - Page 103
Pro projects are automatically published by RoboHelp Server. Create a master project This procedure applies to HTML Help, WebHelp, FlashHelp, Adobe AIR Application, and browser-based Adobe AIR projects. 1 Create the master project and the projects that you want to merge. For ease of maintenance, the - Adobe 65030089 | User Guide - Page 104
AIR, the corresponding child project has to be generated in its own folder. Note: The name mergedProjects is reserved. Do not give any folder in the project folder the name mergedProjects. 10 If you generate a WebHelp/FlashHelp/Adobe AIR output using a skin, the you need to manually construct the URL - Adobe 65030089 | User Guide - Page 105
in the RoboHelp.cfg file of in the FlashPlayerTrust folder. See "Distribute Adobe AIR output" on page 321. 2 Right-click the layout in the Single Source another tool to remove the old files or remove them manually. Customize merged WebHelp/FlashHelp Pro projects RoboHelp Server automatically merges - Adobe 65030089 | User Guide - Page 106
update any changes. 7 Publish the master project. 8 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 - Adobe 65030089 | User Guide - Page 107
HTML topics can all link to external topics in any of the CHM files that are included in the master project. (Remote topics are not supported in WebHelp.) WebHelp projects How do I distribute merged WebHelp projects? Publish merged WebHelp projects to an intranet or a web address, a local or network - Adobe 65030089 | User Guide - Page 108
Windows Explorer.) Distribute the most current versions of all CHM files. 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 - Adobe 65030089 | User Guide - Page 109
USING ROBOHELP HTML 9 103 Projects Send reports You can share reports with others by sending the content as an e-mail message. 1 Select Tools > Reports. 2 Select the report type. The Reports dialog box appears. 3 Use the options available to customize the report. (Not all reports are customizable - Adobe 65030089 | User Guide - Page 110
USING ROBOHELP HTML 9 104 Projects Keywords And Topics Contains a list of keywords. Each keyword lists the topics that use it. You can discover if keywords are not linked to any topics and identify topics to remove from keywords. Topics And Keywords Contains a list of topics. Each topic list the - Adobe 65030089 | User Guide - Page 111
USING ROBOHELP HTML 9 105 Projects The glossary report is shown for the glossary selected. Images report ❖ Select Tools > Reports > Images. The Image report appears. View An Alphabetized List Of Images Grouped under each image is a list of all topics that use it. View An Alphabetized List Of - Adobe 65030089 | User Guide - Page 112
USING ROBOHELP HTML 9 106 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 - Adobe 65030089 | User Guide - Page 113
USING ROBOHELP HTML 9 107 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 - Adobe 65030089 | User Guide - Page 114
USING ROBOHELP HTML 9 108 Projects Reference URL Properties dialog box Use this dialog box to link index keywords to URLs in your project. Keywords Enter the word or phrase that end users must enter in the index to access the URL. Delete Old Project dialog box Delete the old WebHelp Pro project - Adobe 65030089 | User Guide - Page 115
USING ROBOHELP HTML 9 109 Projects Auto Synchronize TOC Formats the left and right panes to synchronize as users navigate content. Note: Project filenames cannot include spaces. You can automatically replace spaces with underscores after you create the project. Width Defines the navigation pane - Adobe 65030089 | User Guide - Page 116
thesaurus, smart indexing, and full-text search indexing. The output UI is controlled by the project language setting. For more information about language support, see "Authoring content in multiple languages" on page 42 7 Add keywords to enable search on this topic. To separate the keywords, you - Adobe 65030089 | User Guide - Page 117
topics in the same editor and click No. More Help topics "RoboHelp Design Editor" on page 133 "Third-party HTML editors" on page 134 Support for multiple document interfaces You can open multiple topics in Design Editor. You can edit topics simultaneously, compare topics, and copy content from one - Adobe 65030089 | User Guide - Page 118
party editors such as Notepad, Microsoft Word, or Adobe Dreamweaver to edit your files and retain these third-party XHTML editor. RoboHelp retains its processing instructions (PI) as comments to avoid any data files are in HTML or XHTML. XHTML pages support all the DHTML effects that can be applied - Adobe 65030089 | User Guide - Page 119
113 Working with topics The following features are not supported in XHTML: • Marquees in topics • Border color . Note: You can similarly import FrameMaker documents (*.mif, *.fm, *.book, *.bk), PDF documents (*.pdf), Word documents (*.docx, *.docm, *.doc, *.rtf), XML files (*.xml), DITA maps - Adobe 65030089 | User Guide - Page 120
effects, access frames and forms, and view features. 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. If you have multiple browsers installed on your computer - Adobe 65030089 | User Guide - Page 121
USING ROBOHELP HTML 9 115 Working with topics OR Includes or excludes topics that use specified conditional build tags. 4 Click OK to return to the preview window. 5 To remove the condition from the preview, select None from the menu. View design elements ❖ Select View > Show > [design element]. - Adobe 65030089 | User Guide - Page 122
USING ROBOHELP HTML 9 116 Working with topics You can use tables to create a precise layout where each placeholder is placed in a table cell. Body placeholder When you create a topic from a master page, the topic includes content from the master page. Copyright information is an example. When you - Adobe 65030089 | User Guide - Page 123
USING ROBOHELP HTML 9 117 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 - Adobe 65030089 | User Guide - Page 124
USING ROBOHELP HTML 9 118 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). • You - Adobe 65030089 | User Guide - Page 125
USING ROBOHELP HTML 9 119 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 - Adobe 65030089 | User Guide - Page 126
USING ROBOHELP HTML 9 120 Working with topics Update topic references If you rename a topic title, make sure that you update the following items as indicated. Text links 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 includes the - Adobe 65030089 | User Guide - Page 127
for topics based on a specific priority assignment. You can enter a number at the right of this option. Note: Searching by author is not supported. The Found Topics area has these features: Found Topics Displays the topics that match the search criteria. Select a topic from this list to preview - Adobe 65030089 | User Guide - Page 128
USING ROBOHELP HTML 9 122 Working with topics By Title Click to search for text in topic titles instead of in filenames. Topics Containing Displays the topics that match the search criteria. Select a topic from this list to preview it or modify its properties. 5 Click OK. Assign a default - Adobe 65030089 | User Guide - Page 129
USING ROBOHELP HTML 9 123 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). The currently selected item is on the right. • - Adobe 65030089 | User Guide - Page 130
USING ROBOHELP HTML 9 124 Working with topics Specify application-level Resource Manager settings 1 In the Options dialog box, specify how you want to use shared resources in projects. Select either of the following options: As Copy Inserts a copy of a shared resource in the project. Resource - Adobe 65030089 | User Guide - Page 131
USING ROBOHELP HTML 9 125 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 - Adobe 65030089 | User Guide - Page 132
A reference to the resource exists in the project but the resource is deleted from the project folder. This scenario occurs only in the case of manual deletion of the resource. Sync Allows you to update the resource either in the project or in the shared location. Last updated 12/14/2011 - Adobe 65030089 | User Guide - Page 133
the shared location. The resources remain in the project as copied resources; any updates to the master copies in the shared location must be tracked manually. Replace Link Replaces the current link with a link to another shared resource that has the same file extension. Check spelling and find and - Adobe 65030089 | User Guide - Page 134
End the spelling check and close the dialog box. Note: The Spell Check tool works for the language selected. If the selected language does not support the Spell Check tool, the tool is disabled in the Tools menu. Last updated 12/14/2011 - Adobe 65030089 | User Guide - Page 135
USING ROBOHELP HTML 9 129 Working with topics Spelling check options for projects Currently Checking Display the topic currently being checked. Skip Skip the current topic. Not In Dictionary Display the word not found in the dictionary. Add Add the word to the dictionary. Suggestions Show a list - Adobe 65030089 | User Guide - Page 136
USING ROBOHELP HTML 9 130 Working with topics Close Close the dialog box. Find and replace Find and replace text in a topic 1 Open a topic. 2 Select Edit > Find or Edit > Replace. 3 Type the text in the Find box. 4 (Optional) Set options. Use expressions to broaden or restrict search results. 5 - Adobe 65030089 | User Guide - Page 137
USING ROBOHELP HTML 9 131 Working with topics Find and replace options ❖ Select Edit > Replace. Find What Search for this word or phrase. Replace With Use this word or phrase as the replacement text. Find Next Locate the first occurrence in the text. Replace Replace selected text. Replace All - Adobe 65030089 | User Guide - Page 138
USING ROBOHELP HTML 9 132 Working with topics Project Do one of the following: • 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 - Adobe 65030089 | User Guide - Page 139
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. Last updated - Adobe 65030089 | User Guide - Page 140
USING ROBOHELP HTML 9 134 Editing and formatting You can add keyword expansions in the HTML Editor. 1 In the HTML Editor, right-click and select Edit Expansions. 2 Click New. 3 (Optional) Enter a new keyword in the Keyword box. 4 Enter a caption for the keyword in the Caption box. 5 Enter some - Adobe 65030089 | User Guide - Page 141
USING ROBOHELP HTML 9 135 Editing and formatting Remove or rename an HTML editor 1 Select Tools > Options. 2 Click the Associations tab. 3 Select an editor. Click Edit. • To rename the editor, click Edit and type a name in the Name box. • To remove the editor, click Remove. Note: RoboHelp Design - Adobe 65030089 | User Guide - Page 142
USING ROBOHELP HTML 9 136 Editing and formatting Specify an editor for new topics Specify the default editor for new topics. 1 In the Project Manager pod, right-click a topic. Select New > Topic With. 2 Select an editor. Click OK. Click the General tab, and specify options. 3 Select Tools > - Adobe 65030089 | User Guide - Page 143
USING ROBOHELP HTML 9 137 Editing and formatting Change character spacing 1 Select Format > Font. 2 Click the Spacing tab. 3 Select Normal, Expand, or Compress. Set options: By (For Expand or Compress) Specify the amount of space between characters. Position Specify a location for the text. 4 - Adobe 65030089 | User Guide - Page 144
USING ROBOHELP HTML 9 138 Editing and formatting Insert symbols and special characters 1 Open a topic in the Design Editor. Select a location for the character. 2 Select Insert > HTML > Symbol. 3 Double-click the symbol. Insert a non-breaking space ❖ Place the insertion point where you want the - Adobe 65030089 | User Guide - Page 145
is selected, the project language applies to the paragraph. ❖ Right-click and select Paragraph. Select a language from the Language menu. More Help topics "Support for multiple languages" on page 42 Apply text wrapping 1 In the Design Editor, double-click an object. 2 Under Text Wrapping, select an - Adobe 65030089 | User Guide - Page 146
of space after each paragraph. At (for Multiple and Exactly) Enter the spacing (in points) between selected lines. 3 Click OK. Add line breaks to paragraphs A manual line break ends the current line and aligns the text on the next line. 1 Open the topic in the Design Editor. Click where you want - Adobe 65030089 | User Guide - Page 147
USING ROBOHELP HTML 9 141 Editing and formatting More Help topics "Add or edit borders or backgrounds in style sheets" on page 163 Remove borders or backgrounds 1 Open a topic. 2 Select the item with the border or shading. 3 Do one or more of the following: • In the toolbar, click the Border Type - Adobe 65030089 | User Guide - Page 148
You can apply a conditional build tag on each column listing the features for the specific output and display only if you generate that output. Support for mini TOCs and breadcrumbs in Tables make them more useful for displaying content in an organized and user-friendly fashion. Last updated 12/14 - Adobe 65030089 | User Guide - Page 149
USING ROBOHELP HTML 9 143 Editing and formatting Workflow for creating a table 1 Insert a table using the toolbar or the Table menu. Then select the number of rows and columns in the table grid. See "Insert tables" on page 143. 2 Select a global style to apply on the table. You can also create - Adobe 65030089 | User Guide - Page 150
USING ROBOHELP HTML 9 144 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 - Adobe 65030089 | User Guide - Page 151
USING ROBOHELP HTML 9 145 Editing and formatting 4 In the Top, Bottom, Left, and Right boxes, enter a value. 5 Click OK twice to apply changes. Note: The Margins option sets the spacing around the table. Merge or split table cells 1 Select the cells to merge or split. 2 Select Table > Merge Cells - Adobe 65030089 | User Guide - Page 152
shading, and DHTML effects. 6 Select Format > Font. 7 Select a color. 8 Click OK twice. 9 Select the text that you want to format. Click Bulleted List. 10 From the Styles list, select the style you created. Remove bullets and numbering 1 Select the bulleted or numbered list items. 2 From the Format - Adobe 65030089 | User Guide - Page 153
Open the topic or master page. 2 Select View > Header or Footer. 3 Type the content for the header or footer. Text-only pop-ups are not supported. 4 (Optional) To add or edit margins, borders, color, or an image, right-click in the header or footer, and select Header Properties or Footer Properties - Adobe 65030089 | User Guide - Page 154
USING ROBOHELP HTML 9 148 Editing and formatting 5 Click outside the header or footer. 6 Click the Save All button. Remove headers and footers 1 Open the topic or master page containing the header or footer. 2 Click the Header button or the Footer button. 3 Right-click in the header or footer, - Adobe 65030089 | User Guide - Page 155
USING ROBOHELP HTML 9 149 Editing and formatting 2 Select View > Toolbars > Positioning. 3 From the Z menu, select 1. 4 Repeat for additional text boxes. Layered text boxes Change text box properties 1 Right-click the text box. Select Text Box Properties or Positioned Text Box Properties. 2 - Adobe 65030089 | User Guide - Page 156
USING ROBOHELP HTML 9 150 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. 3 Click OK. The variable is inserted. Press Ctrl+F9, and then specify the variable name within the - Adobe 65030089 | User Guide - Page 157
USING ROBOHELP HTML 9 151 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 - Adobe 65030089 | User Guide - Page 158
USING ROBOHELP HTML 9 152 Editing and formatting 3 In the Variable Name field, enter a name. 4 In the Variable Value field, modify the value. 5 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, - Adobe 65030089 | User Guide - Page 159
USING ROBOHELP HTML 9 153 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 - Adobe 65030089 | User Guide - Page 160
USING ROBOHELP HTML 9 154 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 - Adobe 65030089 | User Guide - Page 161
155 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: Inline styles A block of text and its formatting - Adobe 65030089 | User Guide - Page 162
USING ROBOHELP HTML 9 156 Styles and style sheets Sound Loop Count Define the number of times the sound clip plays when the topic is opened. Select Infinite to play the sound continuously while the topic is open. 5 Click OK. Note: Use this same procedure to link a style sheet to a topic in Design - Adobe 65030089 | User Guide - Page 163
the files linked to the style sheet, topics authored in third-party editors are converted to RoboHelp HTML. Special HTML tags are added to support specific Help features in the program. Create a style using the Styles And Formatting pod 1 To open the Styles And Formatting pod, open a topic and - Adobe 65030089 | User Guide - Page 164
list. You can always recover the styles from C:\Program Files\Adobe\Adobe RoboHelp [version]\RoboHTML\Gallery\Tables. In addition to the predefined and paste at C:\Documents and Settings\[user name]\Application Data\Adobe\RoboHTML\[version]\Templates\Tables. These table styles are available globally - Adobe 65030089 | User Guide - Page 165
USING ROBOHELP HTML 9 159 Styles and style sheets 2 Click Create New Style and select Table Style. 3 Name the new table style and click OK. 4 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 - Adobe 65030089 | User Guide - Page 166
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. Create HTML lists 1 Right-click List Style in the Styles dialog box. 2 Click New. 3 Name the new list. 4 Select a font - Adobe 65030089 | User Guide - Page 167
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 1 In the Styles dialog box, click New. 2 Select the sequence from the Sequence pop-up menu, and - Adobe 65030089 | User Guide - Page 168
USING ROBOHELP HTML 9 162 Styles and style sheets • Click inside the paragraph to format. For multiple paragraphs, select the paragraphs. 2 In the Styles And Formatting pod, double-click a style. • Character styles apply to selected blocks of text and impact fonts and DHTML effects. • Paragraph - Adobe 65030089 | User Guide - Page 169
USING ROBOHELP HTML 9 163 Styles and style sheets 2 If Hide Inherited Styles is selected, deselect it to see available styles. 3 From the Available In menu, select the style sheet name. For embedded styles, select the topic name. 4 From the Style menu, select the style to remove. To delete custom - Adobe 65030089 | User Guide - Page 170
USING ROBOHELP HTML 9 164 Styles and style sheets 6 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. More Help topics "Add - Adobe 65030089 | User Guide - Page 171
165 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 - Adobe 65030089 | User Guide - Page 172
USING ROBOHELP HTML 9 166 TOCs, indexes, glossaries 3 From the pop-up menu, select the information to print. Overview Print all book and page titles. Detailed Print all book and page titles, the topic titles linked to each, and the folders in which the topics are located. 4 Click Properties or - Adobe 65030089 | User Guide - Page 173
is listed in the Page Title box. 3 (Optional) In the Page Title box, add a prefix or suffix to the variable. For example, add the prefix "Adobe" to the variable "RoboHelp." 4 From the Existing Topics list, select a topic for the new page. 5 Click OK. The book or page appears in the table - Adobe 65030089 | User Guide - Page 174
USING ROBOHELP HTML 9 168 TOCs, indexes, glossaries 3 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, - Adobe 65030089 | User Guide - Page 175
USING ROBOHELP HTML 9 169 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. 1 Select Tools > Resolve Broken Links. References To Selected Topic Shows all references to the missing topic. The Open - Adobe 65030089 | User Guide - Page 176
USING ROBOHELP HTML 9 170 TOCs, indexes, glossaries 3 From the Select Table Of Contents menu, select the table of contents to merge. 4 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 - Adobe 65030089 | User Guide - Page 177
multiple indexes for a project. When working with index file keywords, consider the following details: • You can use index file keywords with all supported output types and with Keyword Link controls. • Index file keywords can cross-reference (link to) other index file keywords. • Index file - Adobe 65030089 | User Guide - Page 178
USING ROBOHELP HTML 9 172 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 1 Click the Index pod. 2 From the pop-up - Adobe 65030089 | User Guide - Page 179
USING ROBOHELP HTML 9 173 TOCs, indexes, glossaries 4 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 1 In the Topic List or Project Manager pod, select a topic. 2 Click the - Adobe 65030089 | User Guide - Page 180
is listed in the Index Keyword box. 3 (Optional) In the Index Keyword box, add a prefix or suffix to the variable. For example, add the prefix "Adobe" to the variable "RoboHelp." 4 From the Topics list, select a topic to link this new keyword to. 5 Click OK. Cross-reference index keywords You can - Adobe 65030089 | User Guide - Page 181
USING ROBOHELP HTML 9 175 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 - Adobe 65030089 | User Guide - Page 182
USING ROBOHELP HTML 9 176 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 - Adobe 65030089 | User Guide - Page 183
status. Check Only New Topics (That Have Not Been Smart Indexed) Search only non-indexed topics. 9 Click Next. Suggested keywords appear for the first topic. 10 Select, deselect, rename, or remove keywords. Last updated 12/14/2011 - Adobe 65030089 | User Guide - Page 184
USING ROBOHELP HTML 9 178 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 - Adobe 65030089 | User Guide - Page 185
USING ROBOHELP HTML 9 179 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) - Adobe 65030089 | User Guide - Page 186
USING ROBOHELP HTML 9 180 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 - Adobe 65030089 | User Guide - Page 187
USING ROBOHELP HTML 9 181 TOCs, indexes, glossaries Under Image, Auto indicates that the book or page uses the standard icon. 3 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. 4 (Optional) Select Mark As New - Adobe 65030089 | User Guide - Page 188
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. requires compiled HTML Help and doesn't support customization or external TOC files. Last updated 12/14/2011 - Adobe 65030089 | User Guide - Page 189
into the project if you want to select the HHC file with the TOC control. Add index controls (HTML Help) If your 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 the topic is opened - Adobe 65030089 | User Guide - Page 190
window. 5 From the Frame pop-up menu, select a custom frame. 6 Click OK. Version-control projects may have more options. Note: Microsoft HTML Help doesn't support links to custom windows from the topic, only links to pop-ups. More Help topics "Link to a pop-up" on page 192 "Automatic indexing with - Adobe 65030089 | User Guide - Page 191
USING ROBOHELP HTML 9 185 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. 1 In the Project Manager - Adobe 65030089 | User Guide - Page 192
USING ROBOHELP HTML 9 186 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. 1 In the Glossary pod, select the term to change. 2 Edit the definition text. - Adobe 65030089 | User Guide - Page 193
4.0 or later. If they are used in a style, they require Internet Explorer 5.0 or later. Netscape Navigator doesn't support expanding glossary hotspots. • The Glossary panel is not supported in Oracle Help. Definitions appear inline instead of in a hotspot. • The glossary appears in the printed - Adobe 65030089 | User Guide - Page 194
USING ROBOHELP HTML 9 188 TOCs, indexes, glossaries 5 Click Next. Repeat steps for each topic that the Glossary Hotspot wizard displays. 6 Click Finish. Test expanding glossary hotspots 1 In the Topic List pod, right-click the topic containing the hotspot. 2 Click View. 3 Click the glossary term - Adobe 65030089 | User Guide - Page 195
, drop-down hotspots, and twisties Text links that expand to display additional information, but not other topics. These hotspots are available in browsers that support Dynamic HTML (DHTML). Text-only pop-up A window that displays only text, not topics or web pages. Text-only pop-ups are useful for - Adobe 65030089 | User Guide - Page 196
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 in WebHelp, WebHelp Pro, FlashHelp, FlashHelp Pro, HTML Help, and AIR Help. For all other layouts, breadcrumbs are not generated, even if - Adobe 65030089 | User Guide - Page 197
to use the default format settings. 10 (Optional) Click Format to change newsgroups, FTP sites, files (such as PDF) associated with other programs, and remote the destination topic in a pop-up window. To manually size the window, type a number in the Width supported as links. Last updated 12/14/2011 - Adobe 65030089 | User Guide - Page 198
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. When a user clicks the link, the pop-up opens and - Adobe 65030089 | User Guide - Page 199
USING ROBOHELP HTML 9 193 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 1 Open the destination for the link. To create a link within a topic, - Adobe 65030089 | User Guide - Page 200
USING ROBOHELP HTML 9 194 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. 1 In the Design Editor, click the multimedia object or the image - Adobe 65030089 | User Guide - Page 201
USING ROBOHELP HTML 9 195 Linking and navigation Link to e-mail addresses, FTP sites, newsgroups, and web addresses 1 In the Design Editor, choose a location for the link or select text or an image to define a hotspot. 2 Click the Insert Hyperlink button . 3 In Link To, click the triangle button - Adobe 65030089 | User Guide - Page 202
and whether other topics link to it. Enable BugHunter For context-sensitive topics in Microsoft HTML Help systems. Use this option to diagnose problems that can occur when linking HTML Help systems to Windows applications. Resolve Broken Links Identifies missing or deleted topics that caused broken - Adobe 65030089 | User Guide - Page 203
USING ROBOHELP HTML 9 197 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. • To fix a TOC item, index keyword, or image map, first select the item. - Adobe 65030089 | User Guide - Page 204
USING ROBOHELP HTML 9 198 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. 1 Select View > Pods > Link View. The Link View pod appears. 2 Drag topics - Adobe 65030089 | User Guide - Page 205
USING ROBOHELP HTML 9 199 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. Keyword Links Controls that let - Adobe 65030089 | User Guide - Page 206
USING ROBOHELP HTML 9 200 Linking and navigation Label Displays a control as a square gray button with black text. The text in the box displays on the button. You can edit the label. Image Displays a control as an image. The image filename appears in the box below this option. (You can't add a - Adobe 65030089 | User Guide - Page 207
USING ROBOHELP HTML 9 201 Linking and navigation Find Topic Find topics based on search criteria. 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). See Also Keywords In Project Display a list of all - Adobe 65030089 | User Guide - Page 208
USING ROBOHELP HTML 9 202 Linking and navigation 6 Under See Also Keywords In Project, select a See Also keyword. 7 Click Add. Repeat for all keywords you want to add. Click Next. 8 Select display and font options. 9 Click Finish. To test the control, generate the project. Change, reuse, or - Adobe 65030089 | User Guide - Page 209
that term. The topic list sometimes provides context, depending on output type. When you view the topic, RoboHelp highlights the search term. RoboHelp search supports these features: Keywords You can assign a keyword to a topic that does not contain that word. For example, you can assign the keyword - Adobe 65030089 | User Guide - Page 210
. You can disable the display of context by using the SSL dialog box. Note: Only WebHelp/Pro and FlashHelp/Pro support context in Help results. In Flash Help/Pro, the context appears as a tool tip. Search Office and PDF files (WebHelp/Pro, FlashHelp/Pro) You can search for baggage files (such as - Adobe 65030089 | User Guide - Page 211
or edit browse sequences Use browse sequences to provide a path for your readers to move through a series of topics. When working with browse sequences, 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 - Adobe 65030089 | User Guide - Page 212
in the browse sequence, and click OK. 5 Click OK. If the Enable Browse Sequence dialog box appears, click Yes. Create browse sequences manually 1 Select Tools > Browse Sequence Editor. 2 Click New and then name the browse sequence. 3 From Available Topics, select the folder containing the topics - Adobe 65030089 | User Guide - Page 213
USING ROBOHELP HTML 9 207 Linking and navigation 2 Click the Properties button . 3 Click the Advanced tab. Test browse sequences in a browser or view 1 Verify that browse sequences are enabled. 2 Click the Generate button to generate. 3 Click View Result and click through the browse sequence. - Adobe 65030089 | User Guide - Page 214
either a .jpeg or .jpg filename extension. BMP (Windows Bitmap) The standard bitmap image format intended for Windows, used in WinHelp applications. Bitmap images support up to 24-bit color. When you import WinHelp projects into HTML, the bitmaps are converted into GIF or JPG format. You can use - Adobe 65030089 | User Guide - Page 215
USING ROBOHELP HTML 9 209 Multimedia and special effects Copy an image 1 In the Toolbox pod, double-click the Graphics Locator button . 2 Select an image from the Image Files list. 3 Browse to a destination. 4 Click Copy File. View an image To view an image, you associate the filename extension - Adobe 65030089 | User Guide - Page 216
area. 7 Click Save . 8 Close RoboScreenCapture. The Image dialog box of RoboHelp for HTML appears. 9 (Optional) Resize the image or place borders around it. 10 Click OK. Remove an image from a topic • To remove an image from a topic, in the Design Editor, select the image. Click the Delete button - Adobe 65030089 | User Guide - Page 217
topics "Create text links" on page 191 "Link to a pop-up" on page 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 - Adobe 65030089 | User Guide - Page 218
topic where you want to insert the demo. 2 Place the cursor where you want to insert the demo. 3 From the Insert menu, select Adobe Captivate Demo. The Adobe Captivate Demo dialog box appears: • If the demo SWF file is already in the project, select it from the Multimedia In Project Folders list - Adobe 65030089 | User Guide - Page 219
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 - Adobe 65030089 | User Guide - Page 220
-compliant output. If you validate the code for W3C compliance, the report can indicate errors. Note: HTML files support DHTML effects in IE and non-IE browsers, but XHTML does not support all instances of DHTML effects. More Help topics "W3C compliance" on page 131 DHTML basics Add DHTML effects to - Adobe 65030089 | User Guide - Page 221
then select DHTML > Remove Dynamic HTML Effects. The ePub output does not support DHTML effects. To exclude DHTML effects from the ePub output, you can DHTML hotspots differently from surrounding text to make them noticeable to readers. Remove hotspots Note: Content inside a hotspot is removed when - Adobe 65030089 | User Guide - Page 222
USING ROBOHELP HTML 9 216 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. 1 Select Format > Styles. - Adobe 65030089 | User Guide - Page 223
properties first, click the marquee destination in the topic. Set marquee properties, and enter the marquee content. Note: XHTML does not support Marquees. Set or change marquee properties 1 Select Insert > HTML > Marquee. 2 Right-click the marquee, select Marquee Properties, and specify or change - Adobe 65030089 | User Guide - Page 224
page. Insert an iframe 1 Select Insert > HTML > IFrame. 2 Double-click the iframe. 3 Specify a name. Click the browse button to select a URL, HTML file, or PDF file to link. 4 (Optional) Click the Border tab to set border options. 5 Click OK. Note: You can view the inserted file in the preview as - Adobe 65030089 | User Guide - Page 225
219 Chapter 10: Conditional text Conditional text basics Conditional text lets you generate . Determine whether to apply multiple tags to topics, for varied output types. For example, to deliver a manual for testers of beta software, tag the beta-specific topics with a tag such as Beta. Tag the other - Adobe 65030089 | User Guide - Page 226
USING ROBOHELP HTML 9 220 Conditional text 9 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 " - Adobe 65030089 | User Guide - Page 227
USING ROBOHELP HTML 9 221 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 - Adobe 65030089 | User Guide - Page 228
USING ROBOHELP HTML 9 222 Conditional text Apply conditional build tags to a folder, index, or TOC 1 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 - Adobe 65030089 | User Guide - Page 229
build tag name before you regenerate the project. Conditional build tag expressions Define conditional build tag expressions An expression is a set of instructions. Expressions specify topics to include or exclude from the output. You can define a basic expression that excludes tags, or a complex - Adobe 65030089 | User Guide - Page 230
USING ROBOHELP HTML 9 224 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 - Adobe 65030089 | User Guide - Page 231
WebHelp Pro, FlashHelp, FlashHelp Pro, and AIR Help do not support What's This Help. WebHelp window support is available only with the context-sensitive Help specify offline Help. Both RH_ShowHelp and RH_AssociateOfflineHelp are in the support files. Use airplane Help to provide back-up Help when an - Adobe 65030089 | User Guide - Page 232
with topics. As author, if you receive a map file from your developer, assign a map ID from the map file. If you manually create a map file, either auto-generate or manually create the map ID. A project can include multiple map files. Map files use the extensions .h, .hh, and .hm. The default map - Adobe 65030089 | User Guide - Page 233
the developer creates the map file, the author then imports it. Note: RoboHelp also supports dynamic context-sensitive mapping of dialog boxes and topics. This approach eliminates the need for technical authors to manually keep track of map IDs. See "Dynamic editing of context-sensitive topics" on - Adobe 65030089 | User Guide - Page 234
USING ROBOHELP HTML 9 228 Context-sensitive Help 4 Select the programming languages to save the map files to. 5 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. Do - Adobe 65030089 | User Guide - Page 235
USING ROBOHELP HTML 9 229 Context-sensitive Help 3 Expand the Map Files folder. 4 Double-click All Map IDs. 5 In Map File, click the Down Arrow and select a map file to store the map ID. 6 Click the Create/Edit Map ID button . 7 In Topic ID, type a word or phrase to identify the topic. 8 In Map - Adobe 65030089 | User Guide - Page 236
number. 7 In the Topic field, select the topic. 8 Click Auto Map to create a map ID. 9 If necessary, double-click the map file to edit it. 10 Provide a copy of the map file to the developer. Generate a map ID The IDs reside in the map file you select from the Edit Map - Adobe 65030089 | User Guide - Page 237
supports dynamic context-sensitive mapping of dialog boxes and topics. This approach eliminates the need for technical authors to manually keep ID to assign. 7 Select the topic. 8 Click Assign. 9 Click Close. 10 Generate the project. 11 Test the window-level topics with the application. Unassign a - Adobe 65030089 | User Guide - Page 238
only C++ APIs on Windows are supported. Usage scenarios Mapping dialog boxes topics eliminates the need for technical authors to manually keep track of map IDs. Instead, technical also greatly facilitates Help integration testing and troubleshooting. Technical authors can readily test whether all - Adobe 65030089 | User Guide - Page 239
. The source code for this function is contained in the support 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 - Adobe 65030089 | User Guide - Page 240
new RoboHelp_CSH .RH_ShowHelp Me.HWND, StrPathAndWindow, cshObject.HH_HELP_CONTEXT, 1; Notes: • In WebHelp Pro projects, the new context-sensitive Help API is supported only with RoboHelp Server. • Create one global RoboHelp_CSH object to use for all context-sensitive Help calls. Airplane Help for - Adobe 65030089 | User Guide - Page 241
USING ROBOHELP HTML 9 235 Context-sensitive Help Program Help for Visual C++ applications This information is for developers connecting context-sensitive Help topics to C++ applications. 1 Open the project in the C++ IDE. 2 Add RoboHelp_CSH.cpp and RoboHelp_CSH.h to the project. 3 Link the - Adobe 65030089 | User Guide - Page 242
"0". In WebHelp Pro systems, default window settings for default navigation buttons override the HH_DISPLAY constant. Call a context-sensitive Help function for AIR Help Note: The AIR Help API is provided for many languages including JAVA, VC.NET, CS.NET, VB, VB.NET. The following example shows how - Adobe 65030089 | User Guide - Page 243
value is 0 for a successful result and non-zero if any error occurs. RH_GetAIRAppPath Call RH_GetAIRAppPath function to get AIR Help Application. TCHAR * RH_GetAIRAppPath(const TCHAR * a_pszAppId, const TCHAR * a_pszPublisherId); Parameter a_pszAppId a_pszPublisherId Data Type const char * const - Adobe 65030089 | User Guide - Page 244
the Help call. Notes: • If using airplane Help, associate the offline Help before making calls. • In WebHelp Pro projects, the Help API is supported only with RoboHelp Server or RoboEngine 3.0 or later. Overriding the default MFC Help Handler This topic is for Visual C++ developers who create MFC - Adobe 65030089 | User Guide - Page 245
USING ROBOHELP HTML 9 239 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 - Adobe 65030089 | User Guide - Page 246
Add RoboHelp_csh.java to the project. 3 Call the function defined in RoboHelp_csh.java using any needed parameters. Note: Airplane Help is not supported in the Java API. Function calls from Java applications In the following examples, the API shares the same parameters regardless of output type. The - Adobe 65030089 | User Guide - Page 247
USING ROBOHELP HTML 9 241 Context-sensitive Help public static boolean RH_ShowHelp(int hParent, String a_pszHelpFile, int uCommand, int dwData) Parameter hParent a_pszHelpFile uCommand Data Type int String int dwData int Description Reserved for future versions. Use 0. Help source For - Adobe 65030089 | User Guide - Page 248
contained in RoboHelp_csh.js wherever you call Help from the website. Program Help for web pages (WebHelp/Pro) Use the context-sensitive Help support files. These files allow developers to call built-in functionality. The example below shows one way to declare a JavaScript function that displays - Adobe 65030089 | User Guide - Page 249
1: Click for Help (map number 1) 2 Run the application and test the Help call. Note: In WebHelp Pro projects, the new context-sensitive Help API is supported only in RoboEngine 3.0 or later. Last updated 12/14/2011 - Adobe 65030089 | User Guide - Page 250
all forms of RoboHelp Server with .NET development: • Creates web services, WebForms, and WinForms. • Provides comprehensive support for .NET Framework. • Operates as a self-contained .NET web service. • Provides APIs to support Help development in Visual C .NET, C# .NET, Visual Basic .NET, and - Adobe 65030089 | User Guide - Page 251
project. 3 Add a button named Help. 4 Navigate to the context-sensitive Help supporting files in C:\Program Files\[RoboHelp Install Folder]\CSH API\CS.NET. 5 Copy the Reference. 8 Select .Net tab > System.Web.Services.Dll. 9 Click OK. 10 Right-click the Reference folder. Select Add Reference. 11 - Adobe 65030089 | User Guide - Page 252
Install Folder]\CSH API\ASP.NET. 4 Copy the RoboHelp_CSH.cs file. 5 Paste the supporting files to the ASP.NET project. 6 Right-click the Reference folder. Select Add Reference. 7 Select .Net tab > System.Web.Services.Dll. 8 Click OK. 9 Add a button in the application. Last updated 12/14/2011 - Adobe 65030089 | User Guide - Page 253
NET. 4 Copy the RoboHelp_CSH.vb file. 5 Paste the supporting files to the ASP .NET project. 6 Right-click the Reference folder. Select Add Reference. 7 Select .Net tab > System.Web.Services.Dll. 8 Click OK. 9 Right-click the Reference. Select Add Reference. 10 Select: msxml2.dll 11 Select OK. 12 Add - Adobe 65030089 | User Guide - Page 254
provides the following two services using the REST web services. Robowindow Requests the server to get the window properties and context Help URL. See code details. Search Performs the sentence search and returns results. See code details. Steps without using support files WebHelp Pro WebHelp - Adobe 65030089 | User Guide - Page 255
project= Advanced window control When opening context-sensitive WebHelp Pro from a browser, use the context-sensitive Help API and support files. WebHelp Context-sensitive Help for Visual Basic applications Use this information to connect context-sensitive WebHelp or WebHelp Pro topics - Adobe 65030089 | User Guide - Page 256
USING ROBOHELP HTML 9 250 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) - Adobe 65030089 | User Guide - Page 257
USING ROBOHELP HTML 9 251 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; - Adobe 65030089 | User Guide - Page 258
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 Sample code: HtmlHelp(hWnd, /*Window handle of program or dialog*/ "CSHHelp.chm", /*Name of the - Adobe 65030089 | User Guide - Page 259
USING ROBOHELP HTML 9 253 Context-sensitive Help Dwmapnumber A map number from the map file. Troubleshoot window-level Help Note: Microsoft HTML Help projects only. Problem Error message Cause Resolution OR: Cause Resolution Wrong Help topic opens. Command: HH_HELP_CONTEXT Processing C:\ - Adobe 65030089 | User Guide - Page 260
give it to the developer. Use this file to correct map number assignments. Problem Error message Cause Resolution Topic appears in wrong dialog box. "HTML Help context-sensitive JavaHelp Use the context-sensitive Help API and support files to call built-in functionality, rather than creating - Adobe 65030089 | User Guide - Page 261
and windows. Resolve Errors Work with your developer to solve any problems. Create context-sensitive Oracle Help Note: This information is for instead of having to create the functions to display topics. Oracle Help supports context-sensitive Help, but your developer must write and customize the - Adobe 65030089 | User Guide - Page 262
USING ROBOHELP HTML 9 256 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 - Adobe 65030089 | User Guide - Page 263
USING ROBOHELP HTML 9 257 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( - Adobe 65030089 | User Guide - Page 264
USING ROBOHELP HTML 9 258 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, - Adobe 65030089 | User Guide - Page 265
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. It supports both WinHelp authored in RoboHelp for Word and Microsoft HTML Help. This tool scans applications and generates projects. It reads program files and - Adobe 65030089 | User Guide - Page 266
generate Help topics for default buttons such as OK and Cancel. 9 To include these topics, select Yes, Create Default Help Text For This Project. 10 Click Finish. The application's files are scanned and a database of information is generated. After a few moments, the new project opens in What's This - Adobe 65030089 | User Guide - Page 267
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. Remove What's This? Help from a project 1 Open the HTML Help project. 2 Select View > Pods > Project Set-up. The - Adobe 65030089 | User Guide - Page 268
HH_Display_Topic. Map Number The map number to test for HH_Help_Context. Troubleshoot What's This? Help Note: Microsoft HTML Help projects only. Options > Display Options. Deselect Only Window-Level Help Messages. Problem Error message Cause Resolution Topic does not appear. No message Author - Adobe 65030089 | User Guide - Page 269
topic ID. or A topic ID is matched to the wrong topic. If the problem is caused by a missing topic ID, correct the map file. If the developer . Select the map number. Enter the topic ID. Click Add/Update. If the problem is caused by a topic ID matched to the wrong topic, remove the text-only - Adobe 65030089 | User Guide - Page 270
USING ROBOHELP HTML 9 264 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 - Adobe 65030089 | User Guide - Page 271
the text-only topics file that matches topic IDs to topics. Tips: • Use BugHunter to test application calls. • Use the Duplicate Map IDs to resolve problems with repeated map numbers. Remove text-only topics You can remove text-only topics in Microsoft HTML Help projects when changes to dialog box - Adobe 65030089 | User Guide - Page 272
map number appears. Test with BugHunter for HTML Help Note: Microsoft HTML Help projects only. BugHunter is a troubleshooting tool to test context-sensitive Help topics and diagnose problems. During testing, BugHunter captures and displays calls that the application makes. Last updated 12/14/2011 - Adobe 65030089 | User Guide - Page 273
USING ROBOHELP HTML 9 267 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: • Test Help buttons, F1 - Adobe 65030089 | User Guide - Page 274
USING ROBOHELP HTML 9 268 Context-sensitive Help View map numbers in hex format 1 Select Tools > Options. Click the BugHunter tab. 2 In Display options, select Map Numbers In Hex. Test in the application To test context-sensitive Help in the application, follow these guidelines: • If you auto- - Adobe 65030089 | User Guide - Page 275
this function for WebHelp Pro, WebHelp, and HTML Help. Support files (WebHelp and WebHelp Pro projects) Adobe provides support files that allow developers to import code and enter variables. Each supported language has a corresponding support file with functions to use for calling WebHelp Pro or - Adobe 65030089 | User Guide - Page 276
270 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 - Adobe 65030089 | User Guide - Page 277
• Default topic • 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 - Adobe 65030089 | User Guide - Page 278
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 - Adobe 65030089 | User Guide - Page 279
and visual warnings such as flashing toolbars. Consider the following in a new browser window. WebHelp features that support Section 508 compliance • A Section 508 Compliant option a link to the location where users can download the appropriate reader. • Document keyboard shortcuts and other methods - Adobe 65030089 | User Guide - Page 280
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. You create WebHelp Pro or FlashHelp Pro projects in RoboHelp, authoring content, adding features, and customizing the appearance - Adobe 65030089 | User Guide - Page 281
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 - Adobe 65030089 | User Guide - Page 282
tags to mark elements, such as text and graphics, in a document with display instructions. HTML Help includes HTML documents (HTM files) for the topics, along with Explorer 6 and later supply the required components for HTML Help support. HTML Help viewer Displays compiled HTML Help (CHM file). It - Adobe 65030089 | User Guide - Page 283
, and compiling errors during generation. If the compiler finds problems with the source files, error messages appear: Notes Conditions that probably do not cause a serious problem in the output. Note numbers range from 1000 through 2999. Warnings - Adobe 65030089 | User Guide - Page 284
USING ROBOHELP HTML 9 278 Generating Help and printed documents Extract CHM files You can extract source files from a compiled Microsoft HTML Help file (CHM). 1 In the Toolbox pod, double-click HTML Help Studio. 2 Select File > Open, and then select a CHM file. Click Open. 3 Do either of the - Adobe 65030089 | User Guide - Page 285
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 - Adobe 65030089 | User Guide - Page 286
within the TABLE tag, the break tag (BR) causes the table cell to expand by the number of BR tags used. Note: This feature is supported in JavaHelp 1.1.3 and later. • Table alignment cannot be set precisely. Text animations and effects Unsupported. Oracle Help layout About Oracle Help Oracle Help is - Adobe 65030089 | User Guide - Page 287
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 - Adobe 65030089 | User Guide - Page 288
reference to an external HS file adds all views, with other project files, to the existing project. Oracle Help indexes One level of indenting is supported. Users can search for keywords in the list. As keywords are selected, topics are listed in the lower pane. Double-clicking a topic in the lower - Adobe 65030089 | User Guide - Page 289
sound files, such as WAV or MIDI, and video files, such as AVI. Plain text Supports non-HTML files. Special effects Supports ActiveX controls, DHTML, JavaScript, startup screens, and Visual Basic scripts. Unsupported DHTML appears as plain text in generated Oracle Help projects. Text animations - Adobe 65030089 | User Guide - Page 290
packaged data file that can be viewed in an AIR Help viewer. Adobe AIR is a cross-platform runtime for building and deploying applications that connect the desktop to the web. Note: On Linux, the AIR Runtime is not supported after Version 2.6. AIR Help will still run on Linux using Version 2.6. For - Adobe 65030089 | User Guide - Page 291
. You can upload this output to the server with specific configurations. Users can view this Help using a browser with Adobe Flash plug-in 9.0 or later installed. Note: Browser-based Help does not support Adobe AIR application features such as commenting, favorites, resources, RSS, and auto-update - Adobe 65030089 | User Guide - Page 292
from a drop-down list. Each Help system has its own TOC, index, browse sequences, and search. ❖ In the Content Categories tab of the Adobe AIR dialog box, do the following: • To create a content category, click New and specify a name. • To rename a content category, select the category. Click Rename - Adobe 65030089 | User Guide - Page 293
topic in the project. 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: Template Select a template from the pop-up menu. Skin Select a skin from the pop - Adobe 65030089 | User Guide - Page 294
and navigation options. They also have some common features. These features are support for TOC, index, glossary, search, print, and the Content pane. how the Help application behaves when a user uses it. ❖ In the Adobe AIR dialog box, select the View group, and set the following: Enable Highlight - Adobe 65030089 | User Guide - Page 295
in the Help application. You can add resources such as technical support pages, knowledgebase articles, RSS feeds, and related websites. Show Online option is applicable only if you select the output type as Adobe AIR Application or AIR Application And Browser Based Help. Note: If you select this - Adobe 65030089 | User Guide - Page 296
administrator for information about which server to use. Note: Server configuration is not applicable if your output type is Adobe AIR Application. 1 Select Server in the Adobe AIR dialog box. 2 Click New. Specify the following options in the New Destination dialog box: Descriptive Name Name for the - Adobe 65030089 | User Guide - Page 297
, check if any topic file has the & character. Rename the topic and regenerate the output. • For a list of video formats supported in Adobe AIR output, see http://kb2.adobe.com/cps/402/kb402866.html . Create a self-signed digital certificate You can create a digital certificate to test or privately - Adobe 65030089 | User Guide - Page 298
Online Content option and publish Browser Based Help output to the location pointed by the server URL that you've specified. See "Configure the Adobe AIR layout" on page 284. Generate output You generate output to your local hard drive. When you generate a layout output for the first time, a new - Adobe 65030089 | User Guide - Page 299
USING ROBOHELP HTML 9 293 Generating Help and printed documents 2 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 - Adobe 65030089 | User Guide - Page 300
through an HTML validator. Note: Dynamic effects in styles aren't supported in W3C-compliant output. Add Mark Of The Web Mark downloading only the data immediately needed. For example, the Contents pane fills quickly by initially downloading only enough data to fill the pane. The rest is downloaded - Adobe 65030089 | User Guide - Page 301
9 295 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. Add Breadcrumbs Links Select to add breadcrumbs in the topic pages - Adobe 65030089 | User Guide - Page 302
in the project. W3C Compliant Topics For W3C-compliant topics, this option passes the topics through an HTML validator. Note: Dynamic effects in styles aren't supported in W3C-compliant output. Last updated 12/14/2011 - Adobe 65030089 | User Guide - Page 303
Flash Security RoboHelp automatically adds the output path to the local-trusted sandbox for Flash Player for the machine to ensure compatibility with Flash Select the following options as desired: • Browse Sequences Enables support of browse sequences if you created them. The window contains - Adobe 65030089 | User Guide - Page 304
No, you can generate using the skin, but without new FlashHelp features. • To update the skin, download the skin again from Community Help, see the SDK documentation, or contact the Flash developer. Set options for generating WebHelp Pro or FlashHelp Pro 1 Set the following options, and then click - Adobe 65030089 | User Guide - Page 305
in search results. W3C Compliant Topics For W3C-compliant topics, this option passes the topics through an HTML validator. Note: Dynamic effects in styles aren't supported in W3C-compliant output. Add Mark Of The Web Mark of the Web is a comment in the HTML markup for a web page. Internet Explorer - Adobe 65030089 | User Guide - Page 306
7 and later, place SWF files in the trusted security sandbox of Flash Player. RoboHelp maintains the RoboHelp[version].cfg file in the FlashPlayerTrust folder. Note: Dynamic effects in styles are not supported in W3C-compliant output. Show Print Button In Skin (FlashHelp Pro) Displays the Print - Adobe 65030089 | User Guide - Page 307
USING ROBOHELP HTML 9 301 Generating Help and printed documents Exclude Unreferenced Topics From Output Select this option to exclude any topic that exists in the project but is not the default topic in the layout or is not referenced from the selected TOC, index, or browse sequence, or any - Adobe 65030089 | User Guide - Page 308
USING ROBOHELP HTML 9 302 Generating Help and printed documents Apply To All Topics Select this option to apply formatting at the project level: • Master Page The selected master page overrides the settings of all the individual topics with or without a master page applied to them in the project. - Adobe 65030089 | User Guide - Page 309
USING ROBOHELP HTML 9 303 Generating Help and printed documents Default Topic Click Select to select a topic to display when Help opens. In-Topic Navigation Bar Specify options for the navigation bar. Table Of Contents Select a table of contents to display in the output. Index Select an index to - Adobe 65030089 | User Guide - Page 310
USING ROBOHELP HTML 9 304 Generating Help and printed documents • Remove Delete the selected SubHelpSet file. Locate Java SDK Install Folder Click to browse to the Java JDK install folder. Click Network to locate and map the folder on a network drive. You can define the viewer class for a given - Adobe 65030089 | User Guide - Page 311
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. RoboHelp - Adobe 65030089 | User Guide - Page 312
Generating Help and printed documents Note: The ePub output does not support indexes and glossaries. 6 Select or define the conditional build If zip.exe is not available on your computer, click Open In Browser to download zip.exe for Windows. 7 Select Open ePub In Default Application. 8 Click - Adobe 65030089 | User Guide - Page 313
pane to resolve the problem. For WinHelp projects, generate the project in the Layout wizard and use Error wizard to locate the problem. • View published 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 - Adobe 65030089 | User Guide - Page 314
content differently. Multibrowser support for previewing topics and PDFs, make sure that Adobe® Acrobat® 10 is installed on your computer. Previewing any PDF in Acrobat AIR Help viewer is an AIR file that installs the Help application. 1 Go to the C:/Program Files/[folder name]. 2 Double-click the AIR - Adobe 65030089 | User Guide - Page 315
You can use this ID to call the CSH API or to start the AIR Help viewer. The label for Help content when the Help viewer contains multiple Help to any name. The name does not need to match the name of the .air or .exe file in the installation folder. Publish output You can publish output for - Adobe 65030089 | User Guide - Page 316
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. Last updated 12/14/2011 - Adobe 65030089 | User Guide - Page 317
USING ROBOHELP HTML 9 311 Generating Help and printed documents Open the application from the command prompt 1 At the command prompt, enter the command in the following format: rhcl myproject\myproject.xpj 2 Access the output files in the default output folder. Generate layouts from the command - Adobe 65030089 | User Guide - Page 318
updating existing Help content, retain the Help title and Help ID of the Help output you configured earlier, but update the version number. 3 In the Adobe AIR dialog box, select the View group and select Enable Auto Update, if it is not enabled already. 4 Specify the location of the updated Help - Adobe 65030089 | User Guide - Page 319
a central location, only the information relevant to the current inquiry is downloaded to user browsers. The system can also be stored locally. By whframes.js whgbody.htm Description Data for context-sensitive Help Legacy support for context-sensitive API Style sheet Default skin JavaScript for - Adobe 65030089 | User Guide - Page 320
glossary Lists and loads files in index and glossary Index lower pane Index frameset Index upper pane Supports index Language support Netscape Navigator functions Message type definition and structure Displayed when JavaScript disabled Determines project contents Project data JavaScript that - Adobe 65030089 | User Guide - Page 321
ROBOHELP HTML 9 315 Generating Help and printed documents File whthost.js whtopic.js whutils.js whver.js Description Supports TOC Supports in-topic navigation bar Supports common functions Determines browser version Output files in the Whgdata subfolder Files in !SSL!\Webhelp\Whgdata are used - Adobe 65030089 | User Guide - Page 322
.htm Index of index data - XML version TOC data - HTML support TOC data - JavaScript supporting whtdata0.htm TOC data - XML support TOC index of TOC - HTML support TOC index of TOC - JavaScript supporting whtoc.htm TOC index of TOC - XML support Output files in the Whxdata subfolder Files in !SSL - Adobe 65030089 | User Guide - Page 323
data TOC data 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, files in the FlashHelp folder File cshdat_WEBHELP.htm Description Legacy support file for context-sensitive API *.css *.FHS WF_TOPICS.CSS - Adobe 65030089 | User Guide - Page 324
in Netscape Navigator JavaScript file required for FlashHelp run time JavaScript file required for FlashHelp run time Topic support file (In-topic navigation bar) Utility file for common functions Determines browser version Output files in the whgdata subfolder File whexpbar.gif Description - Adobe 65030089 | User Guide - Page 325
and CNT files. They are not compiled into the master CHM file DOC, PDF, XLS If the project includes links to external files, distribute the external Microsoft HTML Help Support Files Built-in components. • HHActiveX.DLL is an Adobe ActiveX control that provides support for online glossaries and - Adobe 65030089 | User Guide - Page 326
install and register the component support files for the user systems. the files. Note: The Adobe licensing agreement lets you redistribute Microsoft provides ActiveX controls, provide these instructions to users so they can register file (JRE), or have users download it from the Sun website. - Adobe 65030089 | User Guide - Page 327
Contains JavaScript functions for advanced functionality Project start page 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 - Adobe 65030089 | User Guide - Page 328
AIR (.air) file generated in the output location AIR Runtime See Adobe AIR Runtime Distribution All files generated in the output folder Flash folder. 1 Select Start > Run. 2 Type %appdata%\Macromedia\Flash Player\#Security\FlashPlayerTrust\ and click OK. 3 Open the RoboHelp.cfg file - Adobe 65030089 | User Guide - Page 329
set the status of new comments to Pending or Accepted at the time of generating Adobe AIR output. Users can access the settings.xml file present in the network location for share source files. Similarly, you can generate PDF files and print documents from the same source files. Last updated 12/ - Adobe 65030089 | User Guide - Page 330
Word is recommended. Do not edit this file; it contains only field codes referencing the documents. Do not use a master document for large manuals. Single document One Word file containing the title page, TOC, chapters, glossary, and index. Printed document structure • Books and pages at the root - Adobe 65030089 | User Guide - Page 331
USING ROBOHELP HTML 9 325 Generating Help and printed documents Feature Images Marquees Positioned text boxes Shading Text boxes Conversion notes 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 - Adobe 65030089 | User Guide - Page 332
USING ROBOHELP HTML 9 326 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 AutoCreate TOC. Topics from the Project Manager are automatically promoted or demoted in heading style depending on their - Adobe 65030089 | User Guide - Page 333
and on the title page. Location Specify the path for Word documents. PDF documents also are saved to this location. Creates the printed documentation files under OK. Note: Printed Word documentation supports both DOC and DOCX formats. PDF Settings Set PDF properties. Settings Select options for - Adobe 65030089 | User Guide - Page 334
USING ROBOHELP HTML 9 328 Generating Help and printed documents Content Select TOC, index, and glossary to display in the generated Help. Variable Set Select a variable set for the printed document. Advanced Specify detailed TOC, glossary, and text options. Note: If you apply inline formatting to - Adobe 65030089 | User Guide - Page 335
does not use the RoboHelp heading style names in the format Heading [number], the topic doesn't appear in the TOC. To solve this problem, modify one of the RoboHelp heading styles with settings from the custom heading style. Use styles consistently Printed documentation maps styles in the project - Adobe 65030089 | User Guide - Page 336
USING ROBOHELP HTML 9 330 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: Missing styles After - Adobe 65030089 | User Guide - Page 337
USING ROBOHELP HTML 9 331 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 Paragraph styles can be mapped only to paragraph styles in Word. They apply to - Adobe 65030089 | User Guide - Page 338
USING ROBOHELP HTML 9 332 Generating Help and printed documents Use Microsoft Word Templates In the Select Template File dialog box, open a template. Choose copy to the project folder or overwrite an existing template. Click Yes to enable quick access to the template. To share the template with - Adobe 65030089 | User Guide - Page 339
documentation layout. 2 In the Output Format area, select Generate Adobe PDF. 3 Click PDF Settings. Set options. 4 Select options on each screen to can create printed documentation and single-source layouts, and generate PDF files simultaneously with printed documents. If no template is used, - Adobe 65030089 | User Guide - Page 340
is Portrait or Landscape. Margins Specifies left, right, top, and bottom margins in inches. 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 - Adobe 65030089 | User Guide - Page 341
the skin subfolder under !Skinsubfolder!. More Help topics "Create custom skins for WebHelp and WebHelp Pro projects" on page 337 "Create custom skins for Adobe AIR projects" on page 336 Add skins to the gallery Store or reuse skins across projects by adding them to Skins Gallery. 1 In the Project - Adobe 65030089 | User Guide - Page 342
the Project Set-up pod, expand the Skins folder. 2 Right-click a skin. Select Compile. Create custom skins for Adobe AIR projects Adobe AIR Help Skin Editor helps you create and edit skins for Adobe AIR projects. 1 In the Project Set-up pod, right-click the Skins folder. Select New Skin. 2 Do one of - Adobe 65030089 | User Guide - Page 343
customized palettes by deleting the XML file from %Application Data%\Adobe\RoboHTML\[version]\AIRSkinEditor\ColorThemes. Modify font properties Font properties are 16x16, make sure that the new image has the same dimensions. Note: Supported file types for icons are .jpg, .gif, and .png. • To change - Adobe 65030089 | User Guide - Page 344
to both the toolbar and the Search pane. The Caption and the Text Box Width apply to the toolbar only. The box can be from 10 to 40 characters wide. About Select and click Edit to change which image is displayed in the upper right of the main toolbar. Specify an - Adobe 65030089 | User Guide - Page 345
Synchronize TOC (Manually) to Adobe Flash or the RoboHelp Skin Development Kit. The SDK includes instructions for using the kit and tips and tricks. Customize or create a skin with Flash Use an existing compressed skin file (FHZ) from the RoboHelp Skin Gallery or create one. 1 Download the Flash - Adobe 65030089 | User Guide - Page 346
to select it. 4 Click Finish to generate the FlashHelp output. The skin is added to the project and appears in the Skins project subfolder with a Flash icon . FlashHelp vertical-style skins In vertical-style skins, toolbar icons have tool tips. Tool tips appear when the mouse hovers over the button - Adobe 65030089 | User Guide - Page 347
. Contents is the default. WebSearch Displays the WebSearch button. This button is available only if enabled in the project. Browse Sequences Enables support of browse sequences if you created them. The window contains Previous and Next buttons. Use skins to customize them. Search Input Field In - Adobe 65030089 | User Guide - Page 348
. • Search Displays the Search tab in the navigation pane. • Adv Search Enables users to search for topics using Wildcard and Boolean characters. • Browse Sequences Enables support if you have created browse sequences. Last updated 12/14/2011 - Adobe 65030089 | User Guide - Page 349
USING ROBOHELP HTML 9 343 Generating Help and printed documents • Default Tab Select the tab to display when the HTML Help project opens. • Tab Position Select a default location for the window tabs. Tri-pane Options Set properties for the onscreen appearance and behavior of the panes. • Hide Nav - Adobe 65030089 | User Guide - Page 350
USING ROBOHELP HTML 9 344 Generating Help and printed documents Minimize Minimizes application when window is open. Window style ID is WS_MINIMIZE. Maximize Maximizes application when window is open. Window style ID is WS_MAXIMIZE. Border Displays border around window. Window style ID is - Adobe 65030089 | User Guide - Page 351
in the window (optional). 4 In Custom Button 1 URL, enter the link website address. 5 Click OK > OK. Notes: • Custom windows without a navigation pane do not support custom buttons. If you select options such as Back, Forward, or Hide/Show, these buttons do not appear when you test Help topics - Adobe 65030089 | User Guide - Page 352
USING ROBOHELP HTML 9 346 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 - Adobe 65030089 | User Guide - Page 353
347 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 - Adobe 65030089 | User Guide - Page 354
you want to include in the PDF. Note: The order of topics in the Create PDF for Review dialog box and in the PDF created is same as that in Acrobat 9 Pro or above is installed on the same computer. 5 Select Enabling Commenting In Adobe Reader. Note: This option is enabled in RoboHelp if Acrobat 10 - Adobe 65030089 | User Guide - Page 355
includes the SWFs inserted in the project, do the following: 1 Select Tools > Options > General. 2 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. Add comments to SWFs If the - Adobe 65030089 | User Guide - Page 356
text and deleted text. Reviewer Displays the reviewer name as configured in Acrobat (for review comments) or in Tools > Options (for tracked changes). of the comment. Note: RoboHelp supports three types of statuses: Accepted, Rejected, and None. When you import a PDF in which statuses are set, - Adobe 65030089 | User Guide - Page 357
USING ROBOHELP HTML 9 351 Review and collaboration Show All Displays all comments and changes in Review Pane as well as in Design Editor. Show By Type Enables you to select one of the three views: All Types, Review Comments, and Track Changes. All Types displays both comments and changes in - Adobe 65030089 | User Guide - Page 358
choose to work online or offline (with the ability to publish comments saved in offline mode). 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 - Adobe 65030089 | User Guide - Page 359
"Add comments" on page 354 and "Moderate comments" on page 354. Configure preferences for comments Users can configure the following preferences for comments in AIR Help (output): Always Use Log-In Name For Reviewer Name If comments are stored in a shared network folder, users can specify the name - Adobe 65030089 | User Guide - Page 360
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 in a shared network location or on a RoboHelp server, RoboHelp supports comment moderation. If moderation is enabled, the status of an unmoderated - Adobe 65030089 | User Guide - Page 361
WebHelp and WebHelp Pro projects, Internet Explorer 4.0 or later supports ActiveX controls. Add design-time controls Note: This information applies select months and years to view and print. Custom Buttons Users can download the latest information from a database or the latest version of the - Adobe 65030089 | User Guide - Page 362
distribute these controls.) By default, the controls are at C:\Program Files\Adobe\Adobe RoboHelp [version]\Redist. 1 Insert the cursor in the topic where you control to edit its appearance and properties. HTML Help doesn't support all ActiveX controls, and some controls don't have properties dialog - Adobe 65030089 | User Guide - Page 363
it. • Most applets are class files. Work with the developer to obtain class files for the applet. • To add class files to version control, manually add them to the Baggage Files folder. • Applets work only in WebHelp, WebHelp Pro, FlashHelp, and FlashHelp Pro projects. Last updated 12/14/2011 - Adobe 65030089 | User Guide - Page 364
Form elements are available from the Design Editor. Text Field Lets users type text in a form. You can enter default text in the field to guide users, or you can leave the field empty. Multi-Line Text Field Lets users enter over one line of text in a form field. Hidden Field - Adobe 65030089 | User Guide - Page 365
USING ROBOHELP HTML 9 359 Advanced program features Check Box Enables users to select any combination of alternatives. Check boxes can represent a group of nonexclusive choices. Button Lets users insert a plain button on the form, designate the caption, and perform customized actions defined by - Adobe 65030089 | User Guide - Page 366
USING ROBOHELP HTML 9 360 Advanced program features 4 Select a format for the field from the Format list. 5 (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. The Example column displays how - Adobe 65030089 | User Guide - Page 367
USING ROBOHELP HTML 9 361 Advanced program features Add radio buttons 1 Select a location in the form to insert a radio button. 2 Select Insert > HTML > Form > Radio Button. 3 Double-click the radio button and specify the properties: Control Type Select Radio Button. Control Identifier Type the - Adobe 65030089 | User Guide - Page 368
USING ROBOHELP HTML 9 362 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. - Adobe 65030089 | User Guide - Page 369
USING ROBOHELP HTML 9 363 Advanced program features 2 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 - Adobe 65030089 | User Guide - Page 370
USING ROBOHELP HTML 9 364 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. 1 In the Design Editor, open the topic that contains the control to reuse. 2 Right-click - Adobe 65030089 | User Guide - Page 371
USING ROBOHELP HTML 9 365 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 - Adobe 65030089 | User Guide - Page 372
USING ROBOHELP HTML 9 366 Advanced program features Image Inserts a custom image (BMP or ICO) that performs the action. Hidden Inserts a control that is not visible in the topic. 4 Click Next to set up shortcut functionality. Program To Run Specifies the program to run from the control. Navigate - Adobe 65030089 | User Guide - Page 373
such as job description or skill level. You can create up to 10 categories and 32 information types. Information types fall into two categories: HTML Help, it is not possible to filter Index and Search tabs to support information types. Users cannot access a topic from the HTML Help index that - Adobe 65030089 | User Guide - Page 374
USING ROBOHELP HTML 9 368 Advanced program features 2 In the Category field, enter a name. 3 Classify the category: Inclusive Users can select any combination of information types in a category. Exclusive Users can only select one information type in a category. Hidden Users do not see these - Adobe 65030089 | User Guide - Page 375
. 4 Click Delete Info Type. Scripts About scripts Scripts are coded instructions that tell the HTML Help viewer or browser how to react to functionality to HTML Help systems, intranets, and websites. Two common supported scripting languages are VBScript and JavaScript. The scripting used is the - Adobe 65030089 | User Guide - Page 376
script to convert an anchor link href target across all the files in a RoboHelp project. For 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. Master Page Import Use this script to import master - Adobe 65030089 | User Guide - Page 377
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 script folder Create a folder for storing specific scripts. For example, you can store scripts that record data in one folder and - Adobe 65030089 | User Guide - Page 378
To Connect 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 - Adobe 65030089 | User Guide - Page 379
373 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 - Adobe 65030089 | User Guide - Page 380
USING ROBOHELP HTML 9 374 Default keyboard shortcuts Task Open Project Settings dialog Open Topic Properties dialog Display Conditional Build Tag dialog* Text formatting in Design Editor Bold Italicize Underline Format - Paragraph menu Format - Font menu Font change Increase font size to next
-
1 -
2 -
3 -
4 -
5 -
6 -
7 -
8
-
9
-
10
-
11
-
12
-
13
-
14
-
15
-
16
-
17
-
18
-
19
-
20
-
21
-
22
-
23
-
24
-
25
-
26
-
27
-
28
-
29
-
30
-
31
-
32
-
33
-
34
-
35
-
36
-
37
-
38
-
39
-
40
-
41
-
42
-
43
-
44
-
45
-
46
-
47
-
48
-
49
-
50
-
51
-
52
-
53
-
54
-
55
-
56
-
57
-
58
-
59
-
60
-
61
-
62
-
63
-
64
-
65
-
66
-
67
-
68
-
69
-
70
-
71
-
72
-
73
-
74
-
75
-
76
-
77
-
78
-
79
-
80
-
81
-
82
-
83
-
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
-
96
-
97
-
98
-
99
-
100
-
101
-
102
-
103
-
104
-
105
-
106
-
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
-
115
-
116
-
117
-
118
-
119
-
120
-
121
-
122
-
123
-
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
-
132
-
133
-
134
-
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
-
155
-
156
-
157
-
158
-
159
-
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
-
172
-
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
-
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
-
189
-
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
-
213
-
214
-
215
-
216
-
217
-
218
-
219
-
220
-
221
-
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
-
234
-
235
-
236
-
237
-
238
-
239
-
240
-
241
-
242
-
243
-
244
-
245
-
246
-
247
-
248
-
249
-
250
-
251
-
252
-
253
-
254
-
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
-
263
-
264
-
265
-
266
-
267
-
268
-
269
-
270
-
271
-
272
-
273
-
274
-
275
-
276
-
277
-
278
-
279
-
280
-
281
-
282
-
283
-
284
-
285
-
286
-
287
-
288
-
289
-
290
-
291
-
292
-
293
-
294
-
295
-
296
-
297
-
298
-
299
-
300
-
301
-
302
-
303
-
304
-
305
-
306
-
307
-
308
-
309
-
310
-
311
-
312
-
313
-
314
-
315
-
316
-
317
-
318
-
319
-
320
-
321
-
322
-
323
-
324
-
325
-
326
-
327
-
328
-
329
-
330
-
331
-
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
-
343
-
344
-
345
-
346
-
347
-
348
-
349
-
350
-
351
-
352
-
353
-
354
-
355
-
356
-
357
-
358
-
359
-
360
-
361
-
362
-
363
-
364
-
365
-
366
-
367
-
368
-
369
-
370
-
371
-
372
-
373
-
374
-
375
-
376
-
377
-
378
-
379
-
380
 |
 |
Using
ADOBE
®
ROBOHELP
®
HTML 9