Adobe 65030089 User Manual
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 Manual - Page 1
Using ADOBE® ROBOHELP® HTML 10 - Adobe 65030089 | User Manual - Page 2
Legal notices Legal notices For legal notices, see http://help.adobe.com/en_US/legalnotices/index.html. Last updated 7/13/2012 - Adobe 65030089 | User Manual - Page 3
Basic workflow ...1 Activation and registration 2 Help and support ...3 What's new in RoboHelp 10 5 About RoboHelp Server 12 Chapter 2: Exploring the manage projects 26 Authoring content in multiple languages 39 Import PDF files ...46 Importing and linking Word and FrameMaker documents 47 - Adobe 65030089 | User Manual - Page 4
USING ROBOHELP HTML 10 iv Contents W3C compliance ...136 Reference ...136 Chapter 5: Editing and formatting RoboHelp editors ...137 Character formatting and fonts 140 Format paragraphs 142 Borders, backgrounds, color, - Adobe 65030089 | User Manual - Page 5
search 216 Chapter 9: Multimedia and special effects Images ...218 Adobe Captivate demos 221 Multimedia ...223 Dynamic HTML and special effects 224 Marquees ...228 HTML comments in topics 228 Iframes ...229 Chapter 10: Conditional text Conditional text basics 230 Conditional build tags 231 - Adobe 65030089 | User Manual - Page 6
USING ROBOHELP HTML 10 vi Contents Chapter 13: Review and collaboration Review in Design Editor 385 PDF review ...386 Manage comments and changes 388 Review and collaboration in AIR Help 390 Chapter 14: Advanced program features ActiveX controls ...394 Applets ...396 Forms ...397 Frames ...400 - Adobe 65030089 | User Manual - Page 7
, eBook readers, and tablets Adobe AIR adobe.com/go/learn_robohelp_product_en Before you begin working with your software, take a few moments to read about the basic workflow and the many resources available to you. You have access to instructional (.xml), and Adobe PDF files (.pdf). See "Projects" - Adobe 65030089 | User Manual - Page 8
, 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 10. ❖ To register, follow the onscreen instructions in the Registration - Adobe 65030089 | User Manual - Page 9
Help Manager launches in the background and checks for the availability of new or updated content. Adobe Help Manager is an AIR-based content installation utility that downloads offline help content and notifies you when new updates are available, ensuring that you always have the most up-to-date - Adobe 65030089 | User Manual - Page 10
services, plug-ins, and extensions in your product. You can also download samples and other assets and see various resources to get your work done. Adobe Exchange Visit the Adobe Exchange at www.adobe.com/go/exchange to download Adobe TV Visit Adobe TV at http://tv.adobe.com to view instructional - Adobe 65030089 | User Manual - Page 11
RoboHelp users on various userrequested topics. Previous RoboHelp Help Download the documentation of older versions of RoboHelp from the speed and the size of the project you are accessing. Support for User Defined Variables in topic titles In RoboHelp 10, you can use UDVs not just in topic contents, - Adobe 65030089 | User Manual - Page 12
devices (eBook readers, mobile devices, tablet PCs, and more). End users can view content generated from RoboHelp in the latest version of Internet Explorer, Mozilla Firefox, and Google Chrome. Integration with FrameMaker 11, Adobe Captivate 6, and Acrobat 10 RoboHelp 10 supports the latest version - Adobe 65030089 | User Manual - Page 13
, and send it for review (Reviewers only need the free Adobe Reader to add comments to the PDF). After the review ends, import the comments into the project and view and manage the feedback from Review Pane. For step-by-step instructions, see "PDF review" on page 386 and "Manage comments and changes - Adobe 65030089 | User Manual - Page 14
8 Getting started For more information, see "Generate Multiscreen HTML5 output" on page 313. Support for packaging Help content as a native mobile app Using RoboHelp 10, you can package your content as a native mobile app. This functionality is currently available for the Android mobile operating - Adobe 65030089 | User Manual - Page 15
USING ROBOHELP HTML 10 9 Getting started iOS sample app demonstrating mobile Help API capabilities Android sample app demonstrating mobile Help API capabilities Last updated 7/13/2012 - Adobe 65030089 | User Manual - Page 16
SharePoint (ASPX) output generation RoboHelp 10 supports publishing WebHelp, FlashHelp, and Browser based Help (Adobe AIR SSL) output to a SharePoint pages). RoboHelp 10 supports publishing the Multiscreen HTML5 output to SharePoint in its native format (ASPX), ensuring a problem-free display of - Adobe 65030089 | User Manual - Page 17
Support AND search • AND search configurability for end users • Exclude specified baggage file types from search • Support Read the About Adobe RoboHelp 10 topic for an outline of the new features of RoboHelp 10. Open linked topics , FlashHelp, FlashHelp Pro, AIR Help, printed documentation, or HTML - Adobe 65030089 | User Manual - Page 18
10 12 Getting started Support for events in scripting In RoboHelp 9, a script must be invoked manually; it can't run automatically when an event occurs. RoboHelp 10 . Your Help system resides on a server (for example, Adobe Help Resource Center), and you can make instant updates to your - Adobe 65030089 | User Manual - Page 19
USING ROBOHELP HTML 10 13 Getting started • How users navigate online content: Tracks how glossary terms are combined at run time, or when end users access the system from the server. Support for languages other than English The runtime interface (including Table of Contents, index, glossary, and - Adobe 65030089 | User Manual - Page 20
14 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 Manual - Page 21
USING ROBOHELP HTML 10 15 Exploring the workspace Right-click a tab to find options to save the active topic, close the active topic, close all topics, close all but - Adobe 65030089 | User Manual - Page 22
HTML 10 16 Exploring the workspace Import Import a Help project, such as an HTML 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 - Adobe 65030089 | User Manual - Page 23
USING ROBOHELP HTML 10 17 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 - Adobe 65030089 | User Manual - Page 24
USING ROBOHELP HTML 10 18 Exploring the workspace Resource Manager pod Resource Manager stores all the common resources to use across projects and allows for quick access and management - Adobe 65030089 | User Manual - Page 25
USING ROBOHELP HTML 10 19 Exploring the workspace 2 Browse to an RHS file and 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 - Adobe 65030089 | User Manual - Page 26
USING ROBOHELP HTML 10 20 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 - Adobe 65030089 | User Manual - Page 27
USING ROBOHELP HTML 10 21 Exploring the workspace 2 Click the Keyboard tab. 3 Do one of the following: • To remove a keyboard shortcut, select the category and command for the shortcut - Adobe 65030089 | User Manual - Page 28
USING ROBOHELP HTML 10 22 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 - Adobe 65030089 | User Manual - Page 29
23 Chapter 3: Projects Project basics About projects Projects contain the source files that become the final Help system. Help authors work with the project files, and Help users view the output. For CHM output, the project contains the content you create and the properties you set up, such as what - Adobe 65030089 | User Manual - Page 30
USING ROBOHELP HTML 10 24 Projects Image and multimedia files Images and multimedia files enhance Help by adding graphics, sound, video, animation, and more. Windows Windows are the frames - Adobe 65030089 | User Manual - Page 31
HTML 10 25 also provides customizable navigation panes and quick downloads. WebHelp Pro WebHelp Pro is used Adobe FlashHelp® uses Adobe Flash® to provide an interactive navigation pane, customizable navigation controls, Flash animation, streaming video, audio, and graphics. Users need Flash Player - Adobe 65030089 | User Manual - Page 32
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 Manual - Page 33
USING ROBOHELP HTML 10 27 Projects • In the Starter pod, click More under Create New. 2 On 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 - Adobe 65030089 | User Manual - Page 34
USING ROBOHELP HTML 10 28 Projects Create a project by importing documents 1 Do one of . 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 - Adobe 65030089 | User Manual - Page 35
USING ROBOHELP HTML 10 29 Projects 5 Enter the following information in the New Project wizard 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 - Adobe 65030089 | User Manual - Page 36
USING ROBOHELP HTML 10 30 Projects Go To Last Folder Visited icon Displays the last folder you accessed. Click the arrowhead to view a list of the most recent folders - Adobe 65030089 | User Manual - Page 37
USING ROBOHELP HTML 10 31 Projects Advanced Click to create or edit lists pane Change text elements in the user interface for Multiscreen, WebHelp, WebHelp Pro, FlashHelp, FlashHelp Pro, AIR Help, printed documentation, or HTML Help output. See the complete list of available changes you can make - Adobe 65030089 | User Manual - Page 38
USING ROBOHELP HTML 10 32 Projects When you edit the LNG file, your changes supersede settings made in Project Settings in other locations. ❖ Select an element, and click either - Adobe 65030089 | User Manual - Page 39
USING ROBOHELP HTML 10 33 Projects View your project often to test links and make sure that styles appear properly. View each single-source in the viewer required for - Adobe 65030089 | User Manual - Page 40
USING ROBOHELP HTML 10 34 Projects You can generate a report on the customized To Do list. Edit items on the • 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 Last updated 7/13/2012 - Adobe 65030089 | User Manual - Page 41
USING ROBOHELP HTML 10 35 Projects 4 Click Yes. Note: You can create a link to a baggage file by pressing the SHFT key while dragging and dropping it into a topic. Remove - Adobe 65030089 | User Manual - Page 42
USING ROBOHELP HTML 10 36 Projects Note: You can choose to remove the references, but and pressing F2. Multimedia 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 video files into the Design - Adobe 65030089 | User Manual - Page 43
USING ROBOHELP HTML 10 37 Projects Baggage Files Certain files are automatically added to the Image files used in topic backgrounds and scripts • The JavaScript file (ehlpdhtm.js) that supports Dynamic HTML effects such as related topics pop-ups, smart pop- ups, and drop-down hotspots. • The - Adobe 65030089 | User Manual - Page 44
USING ROBOHELP HTML 10 38 Projects Icon , Description Closed folders. Closed folders that 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 - Adobe 65030089 | User Manual - Page 45
USING ROBOHELP HTML 10 39 Projects Icon Description Table of contents folder. Expand to applications. For example, map 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 topics "Define chapter layout" - Adobe 65030089 | User Manual - Page 46
USING ROBOHELP HTML 10 40 Projects Support for multiple languages RoboHelp provides multiple language support at the paragraph, in the Design view and choose Paragraph from the context menu. RoboHelp supports the following languages: Languages Danish (Denmark) German (Germany) English (US - Adobe 65030089 | User Manual - Page 47
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. Last updated 7/13/2012 - Adobe 65030089 | User Manual - Page 48
USING ROBOHELP HTML 10 42 Projects 12 Generate output for the Japanese language. Note: To view the Japanese output, you must change your PC's language to Japanese. Note: To - Adobe 65030089 | User Manual - Page 49
USING ROBOHELP HTML 10 43 Projects WebHelp, WebHelp Pro, FlashHelp and FlashHelp Pro • With a 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 - Adobe 65030089 | User Manual - Page 50
USING ROBOHELP HTML 10 44 Projects Language support for associated dictionaries If your project contains content character set provided by Unicode and supported in RoboHelp overcomes this problem. Support for Unicode text encoding standards RoboHelp HTML supports Unicode text encoding. You can - Adobe 65030089 | User Manual - Page 51
Services And Input Languages dialog box. 9 Click the Regional Options tab, and choose the language you selected in the Default Input Language list. 10 Click the file to modify. These files reside in C:\Program Files\Adobe\Adobe RoboHelp [version]\RoboHTML\!Language!\en_US. 3 Open the project. Do - Adobe 65030089 | User Manual - Page 52
(files that require a password). • 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 Manual - Page 53
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, click Next to select styles. 7 Click Finish. Importing and linking Word and FrameMaker documents You can import Microsoft Word and Adobe FrameMaker documents - Adobe 65030089 | User Manual - Page 54
USING ROBOHELP HTML 10 48 Projects Importing and linking Microsoft Word documents In RoboHelp, you can import or link Microsoft Word documents (files with .docx, .docm, .doc, or .rtf - Adobe 65030089 | User Manual - Page 55
USING ROBOHELP HTML 10 49 Projects Option Linking Importing Remarks Ability to update generated topics Yes. You can update the generated topics whenever the source document or your RoboHelp - Adobe 65030089 | User Manual - Page 56
USING ROBOHELP HTML 10 50 Projects pages, you can also suppress page numbers in headers and footers. "Convert headers and footers in Word documents" on page 53. Chapter versus - Adobe 65030089 | User Manual - Page 57
USING ROBOHELP HTML 10 51 Projects • Link or import Word documents into a RoboHelp project. • 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 - Adobe 65030089 | User Manual - Page 58
USING ROBOHELP HTML 10 52 Projects 5 (Optional) To edit the conversion settings, click Edit. 6 Modify conversion settings according to your requirements, and click OK. For information about converting headers - Adobe 65030089 | User Manual - Page 59
USING ROBOHELP HTML 10 53 Projects Note: RoboHelp creates a glossary entry by finding a 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 - Adobe 65030089 | User Manual - Page 60
USING ROBOHELP HTML 10 54 Projects Convert Word paragraph styles to RoboHelp styles By default, RoboHelp converts all Word styles to CSS, thus retaining the appearance and behavior of - Adobe 65030089 | User Manual - Page 61
USING ROBOHELP HTML 10 55 Projects 5 Select the RoboHelp character style from the pop-up menu. Optionally, you can do the following: • To import the Word character style, select [ - Adobe 65030089 | User Manual - Page 62
USING ROBOHELP HTML 10 56 Projects 4 Select the RoboHelp table style from the pop-up menu. Optionally, to edit the table style in RoboHelp, click Edit Style. Convert Word - Adobe 65030089 | User Manual - Page 63
ROBOHELP HTML 10 57 Projects Even though you can set pagination for any Word 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 - Adobe 65030089 | User Manual - Page 64
USING ROBOHELP HTML 10 58 Projects • Select File > Link > Word Document. • Select File > Project Settings. 2 In the Conversion Settings dialog box, select Other Settings. 3 In the Other Settings tab, - Adobe 65030089 | User Manual - Page 65
USING ROBOHELP HTML 10 59 Projects If you imported documents into the project, the Project 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 - Adobe 65030089 | User Manual - Page 66
USING ROBOHELP HTML 10 60 Projects Force Update Overwrites the current set of topics generated from the selected Word document. Use this option to force an update of the - Adobe 65030089 | User Manual - Page 67
USING ROBOHELP HTML 10 61 Projects Regenerate a deleted topic If you delete a topic generated from a linked Word document, the topic is removed from the project. However, you can regenerate - Adobe 65030089 | User Manual - Page 68
USING ROBOHELP HTML 10 62 Projects You define these settings once. For subsequent projects, import these settings to the project. In this way, you can quickly set up the - Adobe 65030089 | User Manual - Page 69
USING ROBOHELP HTML 10 63 Projects Character formats Table formats Lists Converted. You can map 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 - Adobe 65030089 | User Manual - Page 70
HTML 10 64 Projects nonlinear medium, it requires less redundant content. Use cross-references and conditional text options to minimize redundant content in your outputs. Chapter versus topic Printed documentation requires you to segregate content into self-contained chapters, which allow readers - Adobe 65030089 | User Manual - Page 71
USING ROBOHELP HTML 10 65 Projects 6 Set up alternate text or captions for the images and graphics to create accessible online content. See "Create alternate text for images" on - Adobe 65030089 | User Manual - Page 72
USING ROBOHELP HTML 10 66 Projects FrameMaker document components converted to RoboHelp RoboHelp can use these markers for delineating topics from FrameMaker source, or to pass processing instructions to RoboHelp for images and tables. Formats Paragraph formats Character formats Converted. You - Adobe 65030089 | User Manual - Page 73
USING ROBOHELP HTML 10 67 Projects Table formats Converted. You can map FrameMaker table and bottom of topics. 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 anchored frames. If the images - Adobe 65030089 | User Manual - Page 74
USING ROBOHELP HTML 10 68 Projects Conversion basics Convert a FrameMaker TOC When you import a FrameMaker book to a RoboHelp project, you can also import the table of contents (TOC). Import - Adobe 65030089 | User Manual - Page 75
USING ROBOHELP HTML 10 69 Projects Add To Topic Add the FrameMaker index entries . 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 - Adobe 65030089 | User Manual - Page 76
USING ROBOHELP HTML 10 70 Projects Select the CSS for style mapping You custom CSS. You can later edit 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 of the Project Settings dialog box. - Adobe 65030089 | User Manual - Page 77
USING ROBOHELP HTML 10 71 Projects c Click Edit (FrameMaker Document). 3 In the Conversion Settings dialog, do the following as required: a Select Paragraph and then select Automap Paragraph Styles b Select - Adobe 65030089 | User Manual - Page 78
in the online Help output. Upgrading from RoboHelp 7 to RoboHelp 10 RoboHelp 7 allowed document-level conversion settings for the FrameMaker documents that document-level settings or convert to the project-level settings supported in RoboHelp 10. After you upgrade your project, you cannot open the - Adobe 65030089 | User Manual - Page 79
USING ROBOHELP HTML 10 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 - Adobe 65030089 | User Manual - Page 80
USING ROBOHELP HTML 10 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 - Adobe 65030089 | User Manual - Page 81
USING ROBOHELP HTML 10 75 Projects • Format conversion settings, image conversion settings, and other settings Export conversion settings 1 Select File > Project Settings. 2 On the Import tab, click Export. 3 Specify a - Adobe 65030089 | User Manual - Page 82
10 76 Projects Follow these guidelines for paginating a document: Completeness of content in the topic Ensure that the topic generated contains relevant and complete information for the reader HTML files that indicate the topic title. RoboHelp supports various ways to customize topic names in the - Adobe 65030089 | User Manual - Page 83
USING ROBOHELP HTML 10 77 Projects Set pagination and topic names 1 Select File > Project Settings. 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 - Adobe 65030089 | User Manual - Page 84
USING ROBOHELP HTML 10 78 Projects Converting FrameMaker content Convert FrameMaker paragraph formats to RoboHelp styles By default, RoboHelp converts all paragraph formats from FrameMaker to RoboHelp CSS styles, - Adobe 65030089 | User Manual - Page 85
USING ROBOHELP HTML 10 79 Projects Exclude a FrameMaker paragraph format from Help topics You can exclude the content in FrameMaker documents that has a specified paragraph format from the converted - Adobe 65030089 | User Manual - Page 86
USING ROBOHELP HTML 10 80 Projects Convert Autonumber To HTML List Autonumber format converts to list items using HTML tags such as , , and . Converted Autonumber To - Adobe 65030089 | User Manual - Page 87
USING ROBOHELP HTML 10 81 Projects • In RoboHelp, define a paragraph style "RH_Para1" and link the first 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 - Adobe 65030089 | User Manual - Page 88
USING ROBOHELP HTML 10 82 Projects • Maximum Dimensions Set the maximum dimensions for 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 - Adobe 65030089 | User Manual - Page 89
10 the content through screen readers. If you link or entries are not visible in PDF files, but they appear different requirements, such as a reference manual, a tutorial, or online Help. the meta tag Note: The XHTML file must have - Adobe 65030089 | User Manual - Page 90
USING ROBOHELP HTML 10 84 Projects Show Image Filename In Annotation Select to add annotations to images showing the filename of the image or the full path to include - Adobe 65030089 | User Manual - Page 91
USING ROBOHELP HTML 10 85 Projects Select XML Import Handler Handler Name The following are in it. Import Import an existing handler. Note: Initially a handler is an HDF file with a subfolder of support files. To bring a handler file from the HDF Editor into this program, export the HDF file as a - Adobe 65030089 | User Manual - Page 92
ROBOHELP HTML 10 86 Projects (.fm, .book, and .mif) files, Word files (.doc, .docx), PDF files, and XML files. Note: If you use an HTML editor other than Design ups that resize to accommodate content. All HTML formatting is supported. Regular Hyperlinks Create links that open in the window in - Adobe 65030089 | User Manual - Page 93
USING ROBOHELP HTML 10 87 Projects Images Converts BMP images into GIFs or JPEGs. on a paragraph-by-paragraph and character-bycharacter basis. Apply styles after importing the project. Manually apply character and paragraph attributes to new topics. External Style Sheets (One For Each Source - Adobe 65030089 | User Manual - Page 94
USING ROBOHELP HTML 10 88 Projects External Style Sheet Based On One Source Document the HTML topics in the 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 location for saving keywords: Index - Adobe 65030089 | User Manual - Page 95
USING ROBOHELP HTML 10 89 Projects HLP and HPJ files When you import compiled WinHelp 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 - Adobe 65030089 | User Manual - Page 96
USING ROBOHELP HTML 10 90 Projects Tables convert into HTML topics, but the columns do not 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 - Adobe 65030089 | User Manual - Page 97
USING ROBOHELP HTML 10 91 Projects Desired Result Limit the length of 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 - Adobe 65030089 | User Manual - Page 98
USING ROBOHELP HTML 10 92 Projects custom windows are not supported. Only buttons convert for Popup 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 - Adobe 65030089 | User Manual - Page 99
USING ROBOHELP HTML 10 93 Projects 4 Click the browse button, and select the HPJ file 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 - Adobe 65030089 | User Manual - Page 100
10 94 Projects To work with RoboHelp, your version control software must support the Microsoft SCC API. You can use Adobe source and destination folders. To turn off prompts when performing version control tasks manually, deselect the option on the Version Control tab (Select Tools > Options - Adobe 65030089 | User Manual - Page 101
USING ROBOHELP HTML 10 95 Projects Version control FAQs How does version control work? A Help You can get the latest file versions (checked in by other users) when you open the project, or manually. How can I add output files to version control? If others need access to your output files, add - Adobe 65030089 | User Manual - Page 102
Control. RoboHelp uses this connection to access the database. See Adobe RoboSource Control Help for more information. 1 Open the project in Source Control dialog box, click the Browse button next to the Root Path field. 10 If prompted, enter the same password that you entered to log in. Note: - Adobe 65030089 | User Manual - Page 103
HTML 10 97 checked in version. Version control with Microsoft SharePoint RoboHelp supports version control with Microsoft SharePoint 2010 natively, which it. RoboHelp uses it in file comparison operations. You can download the free comparison program Winmerge from http://winmerge.org/ Note: - Adobe 65030089 | User Manual - Page 104
USING ROBOHELP HTML 10 98 Projects 5 Click Version Settings and then configure the following ? Select Create major and minor (draft) versions. Note: The Create major versions option is also supported. In this case, files cannot be checked in as minor versions. Keep the following number of major - Adobe 65030089 | User Manual - Page 105
HTML 10 99 Projects • Publish the child projects. See "Publish child projects" on page 100. Note: For master projects having the Adobe AIR Application output type, publish the child projects as browser-based Adobe AIR Help. Browser based Help output type selection • (Adobe AIR Application - Adobe 65030089 | User Manual - Page 106
USING ROBOHELP HTML 10 100 Projects • For WebHelp/FlashHelp/Adobe AIR projects, click the WebHelp/FlashHelp/Adobe AIR tab. 8 Do one the generated and published files. Otherwise, while hyperlinking, you need to manually construct the URL based on the folder structure of the generated and published - Adobe 65030089 | User Manual - Page 107
USING ROBOHELP HTML 10 101 Projects After you trusted folders defined in the RoboHelp.cfg file of in the FlashPlayerTrust folder. See "Distribute Adobe AIR output" on page 352. 2 Right-click the layout in the Single Source Layouts folder old files or remove them manually. Last updated 7/13/2012 - Adobe 65030089 | User Manual - Page 108
USING ROBOHELP HTML 10 102 Projects Customize merged WebHelp/FlashHelp Pro projects 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 - Adobe 65030089 | User Manual - Page 109
USING ROBOHELP HTML 10 103 Projects You can place the child project anywhere in the 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 - Adobe 65030089 | User Manual - Page 110
USING ROBOHELP HTML 10 104 Projects Although you publish the master project where you normally would 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 - Adobe 65030089 | User Manual - Page 111
USING ROBOHELP HTML 10 105 Projects Print reports 1 Select Tools > Reports. 2 Select the report type. 3 Customize report options. 4 Click Print. Print the table of contents or index from the - Adobe 65030089 | User Manual - Page 112
USING ROBOHELP HTML 10 106 Projects 2 (Optional) To change the sort order, select Options. The Build Tag Report Option dialog box appears. 3 Select Topic, TOC, And Index Name. 4 Click - Adobe 65030089 | User Manual - Page 113
USING ROBOHELP HTML 10 107 Projects Tips: • Use this report to test your links. • Share this report with authors who use these URLs. Glossary report 1 Select Tools > Reports > Glossary. 2 - Adobe 65030089 | User Manual - Page 114
USING ROBOHELP HTML 10 108 Projects Style Sheets report Use this report (Tools > Reports > Style Sheets) to view an alphabetized list of style sheets or topics. The list of - Adobe 65030089 | User Manual - Page 115
USING ROBOHELP HTML 10 109 Projects To customize the information in this report, click Options and select the information you want to include in it. You can select a range - Adobe 65030089 | User Manual - Page 116
USING ROBOHELP HTML 10 110 Projects Variables report Use this report (Tools > Reports > Variables) to list variables in the order they were created along with their values and information - Adobe 65030089 | User Manual - Page 117
USING ROBOHELP HTML 10 111 Projects HTML Help Advanced Settings tri-pane Buttons Defines the buttons/controls to include in the toolbar. Options: Hide/Show Hides the left-tab - Adobe 65030089 | User Manual - Page 118
is controlled by the project language setting. For more information about language support, see "Authoring content in multiple languages" on page 39 9 Add to the index. For more information, see "Topic keywords" on page 178. 10 Select Exclude This Topic From Search only if you do not want to display - Adobe 65030089 | User Manual - Page 119
USING ROBOHELP HTML 10 113 Working with topics Save topics Save a topic • Press Ctrl+S. • In the toolbar, click Save. Enable or disable Save If you deselect Save Without Prompt, - Adobe 65030089 | User Manual - Page 120
10 114 Working with topics Support can use third-party editors such as Notepad, Microsoft Word, or Adobe Dreamweaver to edit your files and retain these files in their using a third-party XHTML editor. RoboHelp retains its processing instructions (PI) as comments to avoid any data loss. You can - Adobe 65030089 | User Manual - Page 121
HTML 10 to validate all the topics. The following features are not supported in XHTML: • Marquees in topics • Border color in framesets You can similarly import FrameMaker documents (*.mif, *.fm, *.book, *.bk), PDF documents (*.pdf), Word documents (*.docx, *.docm, *.doc, *.rtf), XML files (*.xml - Adobe 65030089 | User Manual - Page 122
HTML 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 - Adobe 65030089 | User Manual - Page 123
USING ROBOHELP HTML 10 117 Working with topics 2 Specify tags to exclude from the output: • To move one tag, select it and click the single arrow button. • To move - Adobe 65030089 | User Manual - Page 124
USING ROBOHELP HTML 10 118 Working with topics A master page is a template for HTML topics. You define the placement of headers, footers, and placeholders for the body, breadcrumbs, and - Adobe 65030089 | User Manual - Page 125
USING ROBOHELP HTML 10 119 Working with topics 2 Do one of the following: • Right-click in the Design Editor and select Add To > Master Pages. • Select File > Add To - Adobe 65030089 | User Manual - Page 126
USING ROBOHELP HTML 10 120 Working with topics Format and edit placeholders You can format styles in placeholders using the Format Placeholders option from the context menu. Open a master - Adobe 65030089 | User Manual - Page 127
USING ROBOHELP HTML 10 121 Working with topics 2 Select the topics that are associated with the master page that you want to substitute. If you are applying master pages - Adobe 65030089 | User Manual - Page 128
USING ROBOHELP HTML 10 122 Working with topics Note: To match the filename to the updated topic title, change the filename when you change a topic title. More Help topics " - Adobe 65030089 | User Manual - Page 129
USING ROBOHELP HTML 10 123 Working with topics Change topic properties on the Index tab (WebHelp Pro) Work with keywords referenced by the topic. Select Index Select an index - Adobe 65030089 | User Manual - Page 130
USING ROBOHELP HTML 10 124 Working with topics File Modified Click to ignore file . 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. - Adobe 65030089 | User Manual - Page 131
USING ROBOHELP HTML 10 125 Working with topics View and manage topic details in the Topics List pod ❖ In the Topic List pod, do any of the following: • To - Adobe 65030089 | User Manual - Page 132
USING ROBOHELP HTML 10 126 Working with topics Configure Resource Manager settings 1 Do one of the of these cases, you can use the Refresh icon in the Resource Manager pod for manual refresh. Specify project-level Resource Manager settings You can specify your preferences for the update - Adobe 65030089 | User Manual - Page 133
USING ROBOHELP HTML 10 127 Working with topics Manage shared resources in the Resource as shared locations in the Resource Manager pod are not automatically refreshed. Click the Refresh icon to manually refresh the contents of these folders. 2 Browse and select a folder preferably on a network or - Adobe 65030089 | User Manual - Page 134
USING ROBOHELP HTML 10 128 Working with topics Explore Right-click a folder and select Explore to open the folder in Windows Explorer. You can right-click a file and select - Adobe 65030089 | User Manual - Page 135
USING ROBOHELP HTML 10 129 Working with topics A B Resource icons indicate in-sync and out-of 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 - Adobe 65030089 | User Manual - Page 136
USING ROBOHELP HTML 10 130 Working with topics Specify spelling options ❖ Select Tools > Spelling Options and select from the following sets of options: Main Options Check Spelling As You - Adobe 65030089 | User Manual - Page 137
USING ROBOHELP HTML 10 131 Working with topics • Select Tools > Spell Check Project. (Optional) Click Skip. : 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. Spelling check options for - Adobe 65030089 | User Manual - Page 138
USING ROBOHELP HTML 10 132 Working with topics Note: The Dictionary Editor is case sensitive. 1 Select Tools > Spelling Options. 2 Click the Options tab. 3 Click Modify. 4 In the Dictionary Editor, - Adobe 65030089 | User Manual - Page 139
USING ROBOHELP HTML 10 133 Working with topics Windows expressions ? c?rd finds card and cord * r*m finds ram and random [ ] [cg]lass finds class and glass [-] [c-g]lip finds clip and - Adobe 65030089 | User Manual - Page 140
USING ROBOHELP HTML 10 134 Working with topics Find and replace text in files Use the Multifile Find and Replace tool to globally find and replace text, HTML tags, - Adobe 65030089 | User Manual - Page 141
USING ROBOHELP HTML 10 135 Working with topics Note: When you use To replace found text or tags, click Replace All or Replace. Use Microsoft-style regular expressions RoboHelp supports various Microsoft-style regular expressions like the following: ? c?rd finds card and cord * r*m finds - Adobe 65030089 | User Manual - Page 142
USING ROBOHELP HTML 10 136 Working with topics W3C compliance You can validate XHTML or HTML topics for World Wide Web Consortium (W3C) compliance and view error messages, informative - Adobe 65030089 | User Manual - Page 143
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 Manual - Page 144
USING ROBOHELP HTML 10 138 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 ( - Adobe 65030089 | User Manual - Page 145
USING ROBOHELP HTML 10 139 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 - Adobe 65030089 | User Manual - Page 146
USING ROBOHELP HTML 10 140 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. - Adobe 65030089 | User Manual - Page 147
USING ROBOHELP HTML 10 141 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 - Adobe 65030089 | User Manual - Page 148
USING ROBOHELP HTML 10 142 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- - Adobe 65030089 | User Manual - Page 149
USING ROBOHELP HTML 10 143 Editing and formatting Marker position for a first-line indent Change . ❖ Right-click and select Paragraph. Select a language from the Language menu. More Help topics "Support for multiple languages" on page 40 Apply text wrapping 1 In the Design Editor, double-click an - Adobe 65030089 | User Manual - Page 150
USING ROBOHELP HTML 10 144 Editing and formatting 4 Click OK. Notes: • Tables must be 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 - Adobe 65030089 | User Manual - Page 151
USING ROBOHELP HTML 10 145 Editing and formatting More Help topics "Add or edit borders or backgrounds in style sheets" on page 171 Remove borders or backgrounds 1 Open a topic. 2 - Adobe 65030089 | User Manual - Page 152
USING ROBOHELP HTML 10 146 Editing and formatting • Select Snap To Safe to change the each column listing the features for the specific output and display only if you generate that output. Support for topic TOCs and breadcrumbs in Tables make them more useful for displaying content in an organized - Adobe 65030089 | User Manual - Page 153
USING ROBOHELP HTML 10 147 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 - Adobe 65030089 | User Manual - Page 154
USING ROBOHELP HTML 10 148 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 - Adobe 65030089 | User Manual - Page 155
USING ROBOHELP HTML 10 149 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 - Adobe 65030089 | User Manual - Page 156
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 Manual - Page 157
USING ROBOHELP HTML 10 151 Editing and formatting 4 Click the Numbered tab. Select a numbering 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 - Adobe 65030089 | User Manual - Page 158
USING ROBOHELP HTML 10 152 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 - Adobe 65030089 | User Manual - Page 159
USING ROBOHELP HTML 10 153 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- - Adobe 65030089 | User Manual - Page 160
USING ROBOHELP HTML 10 154 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 - Adobe 65030089 | User Manual - Page 161
USING ROBOHELP HTML 10 155 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 - Adobe 65030089 | User Manual - Page 162
USING ROBOHELP HTML 10 156 Editing and formatting 3 In the Variable Name field, enter a navigate to the destination folder. • To create a PDF for review with the snippet contents, right-click the snippet in the Snippets pod and select Create PDF For Review. Customize the settings and click OK. - Adobe 65030089 | User Manual - Page 163
USING ROBOHELP HTML 10 157 Editing and formatting Insert a snippet in a topic 1 Open a topic. 2 Do one of the following: • From the Object toolbar, click Insert Snippet . • From the Snippet - Adobe 65030089 | User Manual - Page 164
USING ROBOHELP HTML 10 158 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 7/13/2012 - Adobe 65030089 | User Manual - Page 165
159 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 Manual - Page 166
USING ROBOHELP HTML 10 160 Styles and style sheets Add a media rule in topic styles Follow this procedure when you want to define different media rules for a style in - Adobe 65030089 | User Manual - Page 167
USING ROBOHELP HTML 10 161 Styles and style sheets Media queries Media queries help you gain finer control over media-specific styles by combining media types with media features, - Adobe 65030089 | User Manual - Page 168
USING ROBOHELP HTML 10 162 Styles and style sheets 5 Click OK. Note: Use this same procedure to link a style sheet to a topic in Design Editor. More Help topics "Applying a - Adobe 65030089 | User Manual - Page 169
USING ROBOHELP HTML 10 163 Styles and style sheets Create styles for style sheets 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 - Adobe 65030089 | User Manual - Page 170
USING ROBOHELP HTML 10 164 Styles and style sheets Table styles With Style Editor, you still visible in the Global Styles list. You can always recover the styles from C:\Program Files\Adobe\Adobe RoboHelp [version]\RoboHTML\Gallery\Tables. In addition to the predefined global styles, you can copy - Adobe 65030089 | User Manual - Page 171
USING ROBOHELP HTML 10 165 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 - Adobe 65030089 | User Manual - Page 172
10 166 Styles and style sheets Number or Table Number. In simple numbered lists, the paragraph style and numbering styles share the same font, font size, font weight, and font color. For a video introduction by John Daigle, see Easy ways to create lists and autonumbering on the Adobe www.adobe.com - Adobe 65030089 | User Manual - Page 173
USING ROBOHELP HTML 10 167 Styles and style sheets • Create a paragraph style. 2 Click the , 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 - Adobe 65030089 | User Manual - Page 174
USING ROBOHELP HTML 10 168 Styles and style sheets You can edit the Div, Hyperlink, and Image styles using the Styles editor or from the Styles and Formatting pod. - Adobe 65030089 | User Manual - Page 175
USING ROBOHELP HTML 10 169 Styles and style sheets Edit Image styles You can edit the properties of Image styles from the Styles editor or the Styles and Formatting - Adobe 65030089 | User Manual - Page 176
USING ROBOHELP HTML 10 170 Styles and style sheets Edit a style using the Styles And Formatting pod 1 Select a style in the Styles And Formatting pod. 2 Click Edit Selected Item. 3 - Adobe 65030089 | User Manual - Page 177
USING ROBOHELP HTML 10 171 Styles and style sheets 7 Under Font Color, select a color. Click OK. More Help topics "Create styles for style sheets" on page 163 "Skins" on - Adobe 65030089 | User Manual - Page 178
USING ROBOHELP HTML 10 172 Styles and style sheets Reset styles Each style category can right-click Reset styles and click Apply.) Example (Reset a table style) The following example illustrates how a table style is reset. Clear formatting To remove all styling and formatting from a selection in - Adobe 65030089 | User Manual - Page 179
173 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 Manual - Page 180
USING ROBOHELP HTML 10 174 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 - Adobe 65030089 | User Manual - Page 181
USING ROBOHELP HTML 10 175 TOCs, indexes, glossaries Create TOC books and pages with (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 - Adobe 65030089 | User Manual - Page 182
USING ROBOHELP HTML 10 176 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 - Adobe 65030089 | User Manual - Page 183
USING ROBOHELP HTML 10 177 TOCs, indexes, glossaries Identify and fix broken TOC links If books or pages have broken links, they appear in the Table Of Contents pod - Adobe 65030089 | User Manual - Page 184
USING ROBOHELP HTML 10 178 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 - Adobe 65030089 | User Manual - Page 185
USING ROBOHELP HTML 10 179 TOCs, indexes, glossaries Additional details for HTML Help projects • 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 - Adobe 65030089 | User Manual - Page 186
USING ROBOHELP HTML 10 180 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 - Adobe 65030089 | User Manual - Page 187
USING ROBOHELP HTML 10 181 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 - Adobe 65030089 | User Manual - Page 188
USING ROBOHELP HTML 10 182 TOCs, indexes, glossaries • To link to another type of (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 - Adobe 65030089 | User Manual - Page 189
USING ROBOHELP HTML 10 183 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 - Adobe 65030089 | User Manual - Page 190
USING ROBOHELP HTML 10 184 TOCs, indexes, glossaries Manage indexes Manage indexes with reports RoboHelp provides reports to use in managing indexes, such as the Index and Unused Index - Adobe 65030089 | User Manual - Page 191
USING ROBOHELP HTML 10 185 TOCs, indexes, glossaries Apply conditional build tags to an index 1 In the Index pod, select a keyword. Search only non-indexed topics. 9 Click Next. Suggested keywords appear for the first topic. 10 Select, deselect, rename, or remove keywords. Last updated 7/13/2012 - Adobe 65030089 | User Manual - Page 192
USING ROBOHELP HTML 10 186 TOCs, indexes, glossaries To skip to the next topic, click Skip. Click Options to add verbs, synonyms, and existing index keywords. Note: The Sentences - Adobe 65030089 | User Manual - Page 193
USING ROBOHELP HTML 10 187 TOCs, indexes, glossaries The list is stored as an STP file in the project folder. Version-control projects may have more options. More Help - Adobe 65030089 | User Manual - Page 194
USING ROBOHELP HTML 10 188 TOCs, indexes, glossaries Multiple indexes Create multiple indexes You can create multiple indexes in the same project. New indexes are added to the Index - Adobe 65030089 | User Manual - Page 195
USING ROBOHELP HTML 10 189 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. - Adobe 65030089 | User Manual - Page 196
USING ROBOHELP HTML 10 190 TOCs, indexes, 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 and doesn't support customization or external TOC files. Last updated 7/13/2012 - Adobe 65030089 | User Manual - Page 197
USING ROBOHELP HTML 10 191 TOCs, indexes, glossaries Customize an index (HTML Help) The index 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. - Adobe 65030089 | User Manual - Page 198
USING ROBOHELP HTML 10 192 TOCs, indexes, glossaries You can use other index files 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- - Adobe 65030089 | User Manual - Page 199
USING ROBOHELP HTML 10 193 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 - Adobe 65030089 | User Manual - Page 200
USING ROBOHELP HTML 10 194 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 - Adobe 65030089 | User Manual - Page 201
USING ROBOHELP HTML 10 195 TOCs, indexes, glossaries Glossary hotspots About , 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 - Adobe 65030089 | User Manual - Page 202
USING ROBOHELP HTML 10 196 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 - Adobe 65030089 | User Manual - Page 203
, 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 Manual - Page 204
ROBOHELP HTML 10 198 Linking, 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, WebHelp Pro, FlashHelp, FlashHelp Pro, HTML Help, and AIR Help. For all other layouts, breadcrumbs are not generated, even - Adobe 65030089 | User Manual - Page 205
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 7/13/2012 - Adobe 65030089 | User Manual - Page 206
USING ROBOHELP HTML 10 200 Linking, navigation, and search More Help topics "Image maps" on page 221 Link to a pop-up You can create a link that displays an HTML topic in a pop-up rather than in the default browser or viewer. A pop-up supports HTML formatting, images, Dynamic HTML, link controls - Adobe 65030089 | User Manual - Page 207
USING ROBOHELP HTML 10 201 Linking, navigation, and search 3 Enter a name, without spaces, using any combination of letters and numbers. After you save the topic, bookmark icons appear indented - Adobe 65030089 | User Manual - Page 208
USING ROBOHELP HTML 10 202 Linking, navigation, and search Add links from images and multimedia Topics can include multimedia as links, sound or video clips, local or external HTML - Adobe 65030089 | User Manual - Page 209
USING ROBOHELP HTML 10 203 Linking, navigation, and search Link to e-mail addresses, FTP sites, newsgroups, and web addresses 1 In the Design Editor, choose a location for the link or - Adobe 65030089 | User Manual - Page 210
USING ROBOHELP HTML 10 204 Linking, navigation, and search Set options in the Link View 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 - Adobe 65030089 | User Manual - Page 211
USING ROBOHELP HTML 10 205 Linking, navigation, and search Fix broken links ❖ Select Tools > Resolve Broken Links > References To Selected Topic. • To fix a link, first select a link. Then click - Adobe 65030089 | User Manual - Page 212
USING ROBOHELP HTML 10 206 Linking, navigation, and search View and test hyperlinks View hyperlinks and identify browse sequences In the Design Editor, right-click and select Show Topic - Adobe 65030089 | User Manual - Page 213
USING ROBOHELP HTML 10 207 Linking, navigation, and search because you define the group of topics in one location (not in each topic). Make sure that you update the - Adobe 65030089 | User Manual - Page 214
USING ROBOHELP HTML 10 208 Linking, navigation, and search Label Displays a control as a square gray button with black text. The text in the box displays on the button. You - Adobe 65030089 | User Manual - Page 215
USING ROBOHELP HTML 10 209 Linking, navigation, and search Find Topic Find topics based on search criteria. Set See Also Keywords in the See Also wizard The See Also - Adobe 65030089 | User Manual - Page 216
USING ROBOHELP HTML 10 210 Linking, navigation, and search 6 Under See Also Keywords In Project, select a See Also keyword. 7 Click Add. Repeat for all keywords you want to add. - Adobe 65030089 | User Manual - Page 217
10 Use browse sequences to provide a path for your readers to move through a series of topics. When working project level. In both WebHelp and Adobe AIR layouts, you can select the browse sequences box appears, click Yes. Create browse sequences manually 1 Select Tools > Browse Sequence Editor. 2 - Adobe 65030089 | User Manual - Page 218
USING ROBOHELP HTML 10 212 Linking, navigation, and search Remove a topic from a browse sequence ❖ From the Browse Sequence list, select the topic and click Remove. Rename or remove a browse - Adobe 65030089 | User Manual - Page 219
10 213 Linking, navigation, and search RoboHelp output search RoboHelp offers a variety of options through which you can add search metadata, optimize the contents of a project for search, and configure the search experience of end users. RoboHelp search basics RoboHelp supports , and AIR Help) By - Adobe 65030089 | User Manual - Page 220
USING ROBOHELP HTML 10 214 Linking, navigation, and search Ranking of search results RoboHelp settings" on page 30. Optimize content for search RoboHelp supports many ways to optimize the content for search: Make Office and PDF files searchable (WebHelp/Pro, FlashHelp/Pro) Users can search - Adobe 65030089 | User Manual - Page 221
the layouts that support the Exclude Unreferenced Topics From Output and Exclude Unreferenced Baggage Files From Search options: SSL Exclude Unreferenced Topics From Output option Multiscreen Yes eBook Adobe AIR Yes Output type: Adobe AIR Application Adobe AIR Yes Output type: Browser - Adobe 65030089 | User Manual - Page 222
USING ROBOHELP HTML 10 216 Linking, navigation, and search Customizable search results list (WebHelp/Pro enable external content search in the following layoutsSSLs: • Multiscreen • WebHelp • FlashHelp • Adobe AIR • WebHelp Pro • FlashHelp Pro 1 In the Single Source Layouts pod, right-click the - Adobe 65030089 | User Manual - Page 223
USING ROBOHELP HTML 10 217 Linking, navigation, and search • (Adobe AIR) Click Search and select Enable External Content Search. • (WebHelp) Click Search and select Enable External Content Search. • (WebHelp Pro) Select Enable External Content Search. • (FlashHelp - Adobe 65030089 | User Manual - Page 224
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 Manual - Page 225
USING ROBOHELP HTML 10 219 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 - Adobe 65030089 | User Manual - Page 226
USING ROBOHELP HTML 10 220 Multimedia and special effects 5 Click OK. RoboScreenCapture opens and 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 - Adobe 65030089 | User Manual - Page 227
USING ROBOHELP HTML 10 221 Multimedia and special effects Note: See RoboScreenCapture Help for more If you have installed Technical Communication Suite, you can also create topics with the Adobe Captivate Step by Step and Handout output. For more information, see Using Technical Communication Suite. - Adobe 65030089 | User Manual - Page 228
USING ROBOHELP HTML 10 222 Multimedia and special effects Create an Adobe Captivate demo Create an Adobe Captivate demo from within RoboHelp. Note: If you have installed Technical Communication Suite, you can also create topics with the Adobe Captivate Step by Step and Handout output. 1 Select - Adobe 65030089 | User Manual - Page 229
10 223 Multimedia and special effects 4 Specify the path of the SWF output for the demo. Note: If you have specified an HTML5 output path and skipped specifying the corresponding SWF output path, RoboHelp adds a placeholder SWF for use in Design Editor. This SWF is non-editable. Edit an Adobe - Adobe 65030089 | User Manual - Page 230
10 codec are natively supported by most browsers 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 - Adobe 65030089 | User Manual - Page 231
ROBOHELP HTML 10 225 Multimedia and special effects • Dynamic effects in styles are not supported in W3C-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 - Adobe 65030089 | User Manual - Page 232
10 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 Manual - Page 233
USING ROBOHELP HTML 10 227 Multimedia and special effects 2 Do one of the following: • To change formatting in a single topic, choose Available In and select the name of the - Adobe 65030089 | User Manual - Page 234
USING ROBOHELP HTML 10 228 Multimedia and special effects 3 From the menu, select a DHTML effect. 4 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 - Adobe 65030089 | User Manual - Page 235
USING ROBOHELP HTML 10 229 Multimedia and special effects Insert an HTML comment 1 Open a topic 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 - Adobe 65030089 | User Manual - Page 236
230 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 Manual - Page 237
USING ROBOHELP HTML 10 231 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 - Adobe 65030089 | User Manual - Page 238
USING ROBOHELP HTML 10 232 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 - Adobe 65030089 | User Manual - Page 239
USING ROBOHELP HTML 10 233 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 - Adobe 65030089 | User Manual - Page 240
USING ROBOHELP HTML 10 234 Conditional text • To remove conditional build tags from topic content, 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 - Adobe 65030089 | User Manual - Page 241
USING ROBOHELP HTML 10 235 Conditional text Advanced conditional build tag expressions If you define advanced conditional build tag expressions using Boolean operators, use these guidelines for customizing output. - Adobe 65030089 | User Manual - Page 242
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 Manual - Page 243
USING ROBOHELP HTML 10 237 Context-sensitive Help Author and developer 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 - Adobe 65030089 | User Manual - Page 244
USING ROBOHELP HTML 10 238 Context-sensitive Help #define ID_SetupScreen 101 • ID_SetupScreen is the 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. - Adobe 65030089 | User Manual - Page 245
USING ROBOHELP HTML 10 239 Context-sensitive Help Export a map file 1 In the Project Set-up pod, expand the Context-Sensitive Help folder. 2 Right-click the Map Files folder. 3 - Adobe 65030089 | User Manual - Page 246
USING ROBOHELP HTML 10 240 Context-sensitive Help Managing map IDs Create a map ID 1 Open the Project Set-up pod. 2 Expand the Context-Sensitive Help folder. 3 Expand the Map - Adobe 65030089 | User Manual - Page 247
USING ROBOHELP HTML 10 241 Context-sensitive Help Auto Map Assign a map ID in the custom or default map file (BSSCDefault.h). 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. Last updated 7/13/2012 - Adobe 65030089 | User Manual - Page 248
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 Manual - Page 249
10 Test the window-level topics with the application. Note: If you assign map IDs to bookmarks and remove the bookmarks from the topics, manually unassign map IDs from the bookmarks. Dynamic editing of context-sensitive topics RoboHelp supports testing and troubleshooting. Technical authors - Adobe 65030089 | User Manual - Page 250
USING ROBOHELP HTML 10 244 Context-sensitive Help 7 Click OK. Information for developers 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 - Adobe 65030089 | User Manual - Page 251
USING ROBOHELP HTML 10 245 Context-sensitive Help 5 To launch the Help system, call RH_ShowHelp with uCommand , 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- - Adobe 65030089 | User Manual - Page 252
USING ROBOHELP HTML 10 246 Context-sensitive Help Example strOnline = "http:// www.mycompany.com/roboapi.asp?project=myproject" strOffline = "C:\Program Files\My App\WebHelp\StartPage.htm" Public cshObject as - Adobe 65030089 | User Manual - Page 253
USING ROBOHELP HTML 10 247 Context-sensitive Help Parameter hParent a_pszHelpFile Data type 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, - Adobe 65030089 | User Manual - Page 254
USING ROBOHELP HTML 10 248 Context-sensitive Help a_ pszHelpId a_pszWindowName ulMapNum a_pszMapId a_pszTopicURL const char 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 * - Adobe 65030089 | User Manual - Page 255
USING ROBOHELP HTML 10 249 Context-sensitive Help Call a context-sensitive function for , 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 - Adobe 65030089 | User Manual - Page 256
USING ROBOHELP HTML 10 250 Context-sensitive Help • To use the RoboHelp API instead of the default MFC Help handler, override the WinHelp function in your mainframe class. By - Adobe 65030089 | User Manual - Page 257
USING ROBOHELP HTML 10 251 Context-sensitive Help CWaitCursor wait; // Get the path to the Help 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 - Adobe 65030089 | User Manual - Page 258
USING ROBOHELP HTML 10 252 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 - Adobe 65030089 | User Manual - Page 259
USING ROBOHELP HTML 10 253 Context-sensitive Help Program Help for web pages This information is 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 - Adobe 65030089 | User Manual - Page 260
USING ROBOHELP HTML 10 254 Context-sensitive Help Parameter hParent a_pszHelpFile uCommand Data Type var var var dwData var 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 7/13/2012 - Adobe 65030089 | User Manual - Page 261
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 Manual - Page 262
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 Add Reference. 8 Select .Net tab > System.Web.Services.Dll. 9 Click OK. 10 Right-click the Reference folder. Select Add Reference. - Adobe 65030089 | User Manual - Page 263
USING ROBOHELP HTML 10 257 Context-sensitive Help 12 Select OK. 13 Double-click the 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 - Adobe 65030089 | User Manual - Page 264
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 Manual - Page 265
USING ROBOHELP HTML 10 259 Context-sensitive Help 13 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 - Adobe 65030089 | User Manual - Page 266
USING ROBOHELP HTML 10 260 Context-sensitive Help Display content An ASP file is included for 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 - Adobe 65030089 | User Manual - Page 267
USING ROBOHELP HTML 10 261 Context-sensitive Help Private Declare Function ShellExecute Lib _ "shell32.dll" Alias "ShellExecuteA" _ (ByVal hwnd As Long, _ ByVal lpOperation As String, _ ByVal lpFile As String, _ - Adobe 65030089 | User Manual - Page 268
USING ROBOHELP HTML 10 262 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); - Adobe 65030089 | User Manual - Page 269
USING ROBOHELP HTML 10 263 Context-sensitive Help Using ShowHelpContext makes 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 - Adobe 65030089 | User Manual - Page 270
USING ROBOHELP HTML 10 264 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 Manual - Page 271
USING ROBOHELP HTML 10 265 Context-sensitive Help Problem Error message Cause Resolution Topic does not appear or wrong topic retest. Create context-sensitive JavaHelp Use the context-sensitive Help API and support files to call built-in functionality, rather than creating functions to display - Adobe 65030089 | User Manual - Page 272
USING ROBOHELP HTML 10 266 Context-sensitive Resolve Errors Work with your developer to solve any problems. Create context-sensitive Oracle Help Note: This information having to create the functions to display topics. Oracle Help supports context-sensitive Help, but your developer must write and - Adobe 65030089 | User Manual - Page 273
USING ROBOHELP HTML 10 267 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 - Adobe 65030089 | User Manual - Page 274
USING ROBOHELP HTML 10 268 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 - Adobe 65030089 | User Manual - Page 275
USING ROBOHELP HTML 10 269 Context-sensitive Help Label label = new Label("Country:", Label.LEFT); mainPanel.add(label); // Set context help for component. TopicID = LABEL // Pass the component with - Adobe 65030089 | User Manual - Page 276
USING ROBOHELP HTML 10 270 Context-sensitive Help Note: Oracle Help uses topic IDs 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 - Adobe 65030089 | User Manual - Page 277
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 Manual - Page 278
USING ROBOHELP HTML 10 272 Context-sensitive Help • To open your project in What's 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 - Adobe 65030089 | User Manual - Page 279
HTML 10 273 . 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 Manual - Page 280
USING ROBOHELP HTML 10 274 Context-sensitive Help Problem Error message Cause Resolution The wrong topic or no Topics dialog box. 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 topic. Create - Adobe 65030089 | User Manual - Page 281
USING ROBOHELP HTML 10 275 Context-sensitive Help Notes: • If you are creating text-only topics and window-level topics, avoid using the same map file for both. • Each - Adobe 65030089 | User Manual - Page 282
USING ROBOHELP HTML 10 276 Context-sensitive Help 3 Double-click the topic file (.TXT). 4 Select . 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 - Adobe 65030089 | User Manual - Page 283
USING ROBOHELP HTML 10 277 Context-sensitive Help Remove text-only topic files Remove 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 - Adobe 65030089 | User Manual - Page 284
USING ROBOHELP HTML 10 278 Context-sensitive Help Note: Before you start using BugHunter, you must launch Html Help Workshop once. To launch Html Help Workshop, double-click the - Adobe 65030089 | User Manual - Page 285
USING ROBOHELP HTML 10 279 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. - Adobe 65030089 | User Manual - Page 286
USING ROBOHELP HTML 10 280 Context-sensitive Help HTML Help viewer (Microsoft HTML Help 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 - Adobe 65030089 | User Manual - Page 287
USING ROBOHELP HTML 10 281 Context-sensitive supports:(BOOL)supports; • -(void) setSupportsIPadOrientation: (UIInterfaceOrientation)orientation supports:(BOOL)supports; To understand how to use these API functions, refer to the comments in the code. Android The following code sample illustrates - Adobe 65030089 | User Manual - Page 288
USING ROBOHELP HTML 10 282 Context-sensitive Help Sample app RoboHelp ships with sample apps demonstrating the capabilities of the mobile Help API. Last updated 7/13/2012 - Adobe 65030089 | User Manual - Page 289
USING ROBOHELP HTML 10 283 Context-sensitive Help iOS sample app demonstrating mobile Help API capabilities Android sample app demonstrating mobile Help API capabilities Last updated 7/13/2012 - Adobe 65030089 | User Manual - Page 290
USING ROBOHELP HTML 10 284 Context-sensitive Help Reference BugHunter tab of the Options dialog box (HTML Help) Display options Window-Level Help Messages captures messages only for window- - Adobe 65030089 | User Manual - Page 291
with layout types" on page 289 Layout types in RoboHelp RoboHelp supports the following layout types: • "Multiscreen HTML5 layout" on page 289 Oracle Help layout" on page 300 • "XML layout" on page 303 • "Adobe AIR layout" on page 304 Specify the primary layout A primary layout is the default layout - Adobe 65030089 | User Manual - Page 292
USING ROBOHELP HTML 10 286 Generating output Create and edit single-source layouts Create or duplicate single-source layouts A duplicate layout retains the settings of the original. 1 In the - Adobe 65030089 | User Manual - Page 293
USING ROBOHELP HTML 10 287 Generating output RoboHelp considers a topic unreferenced if the topic is not generation basics" on page 312 Generate dynamic user-centric content (DUCC) Generate Adobe® AIR® and WebHelp output as integrated Help systems with different content categories. Users select - Adobe 65030089 | User Manual - Page 294
HTML 10 288 replacement for multiple web applications and supports various combinations of enterprise website requirements. instructions, see "Generate Multiscreen HTML5 output" on page 313. Notes: • (Only for Internet Explorer) If your content has an iFrame containing a PDF document, readers - Adobe 65030089 | User Manual - Page 295
output to Microsoft SharePoint WebHelp, FlashHelp, and Browser based Help (Adobe AIR SSL) Publish HTML output to a SharePoint site using a Universal Naming Work with layout types Multiscreen HTML5 layout Most web browsers support native optimizations for displaying content on small-screen devices, - Adobe 65030089 | User Manual - Page 296
USING ROBOHELP HTML 10 290 Generating output Multiscreen HTML5 output Screen layouts help you HTML5 output" on page 313 "Screen profiles" on page 377 "Screen layouts" on page 379 Supported browsers The primary target platforms for the output generated using the Multiscreen HTML5 SSL are Android OS - Adobe 65030089 | User Manual - Page 297
USING ROBOHELP HTML 10 291 Generating output Platform Android OS iOS Windows Desktop OS Mac OS Supported browser Default installed Webkit-based browser (Chrome Lite) Apple Safari Firefox 4+, Chrome 9+, Internet Explorer 9 Apple Safari Note: In addition to HTTP servers, you can publish - Adobe 65030089 | User Manual - Page 298
ROBOHELP HTML 10 292 thumbnail is used to depict the book in the library view of eBook readers. More Help topics "Generate EPUB and Kindle Book output" on page supports standard Help features and provides customizing capabilities. You can author content in another HTML editor, such as Adobe - Adobe 65030089 | User Manual - Page 299
ROBOHELP HTML 10 293 speech and sound, and visual warnings such as flashing toolbars. Consider the following when you create Section , the subproject opens in a new browser window. WebHelp features that support Section 508 compliance • A Section 508 Compliant option that provides alternative text - Adobe 65030089 | User Manual - Page 300
HTML 10 294 Generating , include a link to the location where users can download the appropriate reader. • Document keyboard shortcuts and other methods of accessibility installed. WebHelp Pro is an uncompiled output type that supports standard Help features. You create WebHelp Pro or FlashHelp - Adobe 65030089 | User Manual - Page 301
USING ROBOHELP HTML 10 295 Generating output Convert desktop Help to WebHelp Pro 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 ( - Adobe 65030089 | User Manual - Page 302
ROBOHELP HTML 10 296 mark elements, such as text and graphics, in a document with display instructions. HTML Help includes HTML documents (HTM files) for the topics, along 6 and later supply the required components for HTML Help support. HTML Help viewer Displays compiled HTML Help (CHM file - Adobe 65030089 | User Manual - Page 303
USING ROBOHELP HTML 10 297 Generating output Compressed HTML A collection of all files in the displays messages, statistics, 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 - Adobe 65030089 | User Manual - Page 304
USING ROBOHELP HTML 10 298 Generating output Extract CHM files You can extract source files from a compiled Microsoft HTML Help file (CHM). 1 In the Toolbox pod, double-click HTML - Adobe 65030089 | User Manual - Page 305
USING ROBOHELP HTML 10 299 Generating output JavaHelp layout About JavaHelp JavaHelp is a compressed output type that works with applications written in the Java programming language. JavaHelp and Java applications run on various platforms. RoboHelp provides support for the JavaHelp format and - Adobe 65030089 | User Manual - Page 306
USING ROBOHELP HTML 10 300 Generating output Expanding glossary hotspot definitions Appear 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. - Adobe 65030089 | User Manual - Page 307
USING ROBOHELP HTML 10 301 Generating output Note: Version 3.2.2 is built using the Oracle internal Java GUI tool kit called EWT. Version 4.1.2 is built using Java Foundation Classes. The functionality, APIs, and supported file formats are the same in both versions. To build applications using - Adobe 65030089 | User Manual - Page 308
USING ROBOHELP HTML 10 302 Generating output Titles Assigned to top-level books or nodes 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 - Adobe 65030089 | User Manual - Page 309
HTML 10 303 Generating output Example of an Oracle Help full-text search Oracle Help limitations Not all limitations apply to every Oracle Help project. Capitalization Supports all caps and small caps. Expanding glossary hotspot definitions Appear inline. Fonts Limited font support. Glossary - Adobe 65030089 | User Manual - Page 310
USING ROBOHELP HTML 10 304 Generating output The following predefined handler files are 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 - Adobe 65030089 | User Manual - Page 311
. 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 Manual - Page 312
USING ROBOHELP HTML 10 306 Generating output Configure the Help application installer You configure the settings for the Help application installer. ❖ In the General tab of the Adobe AIR dialog box, set the following under the Installer Settings group: Digital Certificate A digital signature - Adobe 65030089 | User Manual - Page 313
USING ROBOHELP HTML 10 307 Generating output Language Specify the output 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 - Adobe 65030089 | User Manual - Page 314
HTML 10 308 options. They also have some common features. These features are support for TOC, index, glossary, search, print, and the In the Adobe AIR dialog box, select the View group, and set the following: Enable Auto Update Enables the AIR application to synchronize the AIR file installed - Adobe 65030089 | User Manual - Page 315
as technical support pages, knowledgebase articles, RSS feeds, and related websites. Show Online Content Specify the full path from where the AIR Help viewer 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 Manual - Page 316
USING ROBOHELP HTML 10 310 Generating output Configure collaboration Collaboration settings are available for Adobe AIR Application only. ❖ In the Adobe AIR dialog box, select the Collaboration group, and set the following: Enable Topic Rating Enables users to rate any topic on a scale of 0-5 - Adobe 65030089 | User Manual - Page 317
USING ROBOHELP HTML 10 311 Generating output Connection Protocols Select the protocol for 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 - Adobe 65030089 | User Manual - Page 318
10 312 Generating output Digital certificates from certificate authorities can be verified through the web. They assure end-users that the Help application installer is genuine and free from malware. See www.adobe 've specified. See "Configure the Adobe AIR layout" on page 304. Output generation - Adobe 65030089 | User Manual - Page 319
USING ROBOHELP HTML 10 313 Generating output • Exclude the project folder from virus scan. Note: Turning off virus-scanning software increases speed but is not recommended for security reasons. • - Adobe 65030089 | User Manual - Page 320
USING ROBOHELP HTML 10 314 Generating output Index Select the index to be displayed in the generated output. See "Indexes" on page 178. Glossary Select the glossary to be - Adobe 65030089 | User Manual - Page 321
USING ROBOHELP HTML 10 315 Generating output Exclude Baggage Files Types From Search pinching the device screen. Use Adobe Captivate HTML5 Output Select this option to use Adobe Captivate HTML5 output instead of Adobe Captivate SWF output. Note: Adobe Captivate HTML5 output must be available - Adobe 65030089 | User Manual - Page 322
USING ROBOHELP HTML 10 316 Generating output Publish Location: Depending on the version you select, do one of the following: • If you selected SharePoint 2010, click Browse, enter the - Adobe 65030089 | User Manual - Page 323
must manually readers. Adobe Digital Editions reader software is free and can be downloaded from the Digital Editions product site. More Help topics "Apply conditional build tags to content" on page 232 EPUB resources Read this article by Neil Perlin to get an overview of EPUB, RoboHelp's support - Adobe 65030089 | User Manual - Page 324
HTML 10 318 Generating output Validate EPUB 3 Output Set RoboHelp to validate the EPUB output using the standard EPUB validation tool EpubCheck. EpubCheck require Java Runtime 1.5 or above installed on the computer. Note: If the EpubCheck.jar file is not available on your computer, download it - Adobe 65030089 | User Manual - Page 325
can use the XML format below: urn:doi:10.1016/j.iheduc.2008.03.001 - Adobe 65030089 | User Manual - Page 326
HTML 10 320 Generating output Generate EPUB 2.0.1 output Prepare for generating the EPUB 2.0.1 output 1 Review your project content and apply CBTs to content not supported by , click Open In Browser to download zip.exe for Windows. 7 Select Open ePub In Default Application. 8 Click Generate. Last - Adobe 65030089 | User Manual - Page 327
USING ROBOHELP HTML 10 321 Generating output Generate WebHelp output 1 In the Single Source Layouts pod, double-click the WebHelp layout. Note: If you are not working on a new - Adobe 65030089 | User Manual - Page 328
USING ROBOHELP HTML 10 322 Generating output Encoding Specify the character encoding format. Map Files Specify the map files that contain topic IDs associated with map IDs to provide - Adobe 65030089 | User Manual - Page 329
10 323 Generating output Optimize Speed For Select the option by which most users access Help. XML formats reduce load times by downloading only the data immediately needed. For example, the Contents pane fills quickly by initially downloading when supported, pure menu and select Manually. Note: - Adobe 65030089 | User Manual - Page 330
USING ROBOHELP HTML 10 324 Generating output Hide Rank Column In Search Results Select to not display the Rank column in search results. Show Total Number Of Search Results - Adobe 65030089 | User Manual - Page 331
10 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 Flash Security RoboHelp automatically adds the output path to the local-trusted sandbox for Flash Player for the machine to ensure compatibility with Flash - Adobe 65030089 | User Manual - Page 332
10 326 Generating output Optimize Speed For Select the option by which most users access Help. XML formats reduce load times by downloading only the data immediately needed. For example, the Contents pane fills quickly by initially downloading Browse Sequences Enables support of browse sequences - Adobe 65030089 | User Manual - Page 333
USING ROBOHELP HTML 10 327 Generating output Note: If you change the destination to 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. Generate WebHelp Pro or FlashHelp Pro output 1 Set - Adobe 65030089 | User Manual - Page 334
HTML 10 328 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 of Flash Player. Because of security changes in Flash 7 and later, place SWF files in the trusted security sandbox of Flash Player. - Adobe 65030089 | User Manual - Page 335
USING ROBOHELP HTML 10 329 Generating output Note: Dynamic effects in styles are not supported in W3C-compliant output. Show Print Button In Skin (FlashHelp Pro) Displays the Print button in the output. Show Navigation Pane Link In Topics Includes a - Adobe 65030089 | User Manual - Page 336
USING ROBOHELP HTML 10 330 Generating output Note: RoboHelp displays the unreferenced topics that are excluded from the output in the Output View pod. Add Breadcrumbs Links Select to - Adobe 65030089 | User Manual - Page 337
USING ROBOHELP HTML 10 331 Generating output Apply To All Topics Select this option to apply formatting at the project level: • Master Page The selected master page overrides the - Adobe 65030089 | User Manual - Page 338
USING ROBOHELP HTML 10 332 Generating output Default Topic Click Select to select a topic to display when Help opens. In-Topic Navigation Bar Specify options for the navigation bar. - Adobe 65030089 | User Manual - Page 339
USING ROBOHELP HTML 10 333 Generating output • Remove Delete the selected SubHelpSet file. Locate Java SDK Install Folder Click to browse to the Java JDK install folder. Click Network - Adobe 65030089 | User Manual - Page 340
USING ROBOHELP HTML 10 334 Generating output Generate EclipseHelp EclipseHelp contains a bunch of tab, navigate to the following: PhoneGap SDK Path Folder on your computer where you've downloaded and unzipped the PhoneGap software development kit Android SDK Path Folder on your computer where the - Adobe 65030089 | User Manual - Page 341
USING ROBOHELP HTML 10 335 Generating output Specify PhoneGap SDK, Android SDK, JDK, and Apache Ant paths 7 Click Generate. RoboHelp generates the Android project files, including the APK binary, - Adobe 65030089 | User Manual - Page 342
10 336 to resolve the problem. For WinHelp projects, generate the project in the Layout wizard and use Error wizard to locate the problem. • View published 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 Manual - Page 343
-based content differently. Multibrowser support for previewing topics and project PDFs, make sure that Adobe® Acrobat® 10 is installed on your computer. Previewing any PDF in Acrobat AIR Help viewer (AIR file) and installer, define the content appearance, and specify other settings. Generate an AIR - Adobe 65030089 | User Manual - Page 344
USING ROBOHELP HTML 10 338 Generating output Copy the Help content file ❖ Copy the Help helpcfg file can be set 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 WebHelp and FlashHelp projects. - Adobe 65030089 | User Manual - Page 345
USING ROBOHELP HTML 10 339 Generating output 2 Do the following: • (WebHelp) Click Publish. • (FlashHelp) Click Next until the Publish dialog box appears. 3 Specify a publishing destination by doing one of - Adobe 65030089 | User Manual - Page 346
USING ROBOHELP HTML 10 340 Generating output • Destination Path (HTTP protocol) Path to the simultaneously. Note: To access the command prompt from within RoboHelp, click Start > Programs > Adobe RoboHelp [version]> Tools > RoboHelp Command Prompt. Open the application from the command prompt 1 - Adobe 65030089 | User Manual - Page 347
USING ROBOHELP HTML 10 341 Generating output " Indicates spaces. -o Sends the output to a folder. 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. - Adobe 65030089 | User Manual - Page 348
ROBOHELP HTML 10 342 Generating central location, only the information relevant to the current inquiry is downloaded to user browsers. The system can also be stored locally. By .jar Description Data for context-sensitive Help Legacy support for context-sensitive API Style sheet Default skin - Adobe 65030089 | User Manual - Page 349
USING ROBOHELP HTML 10 343 Generating output File whestart.ico whfbody.htm whfdhtml.htm whfform.htm 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 - Adobe 65030089 | User Manual - Page 350
HTML 10 344 Generating output File whskin_plist.htm whskin_tbars.htm whst_topics.xml whstart.ico whstart.js whstub.js whtbar.js whtdhtml.htm whthost.js whtopic.js whutils.js whver.js Description Navigation pane for Pure HTML Toolbar (skins) Parses topics during generation WebHelp icon Supports - Adobe 65030089 | User Manual - Page 351
USING ROBOHELP HTML 10 345 Generating output File whnvt30.htm whnvt31.htm whnvt32.htm HTML support Full-text search data - JavaScript supporting WHFDATA0.HTM Full-text search data - XML support Full-text search index data - HTML support Full-text search index data - JavaScript supporting whFull- - Adobe 65030089 | User Manual - Page 352
HTML 10 346 central server/location, only information relevant to the current query is downloaded to the Web browser on user computers. If necessary, you can to the correct folder in the MergedProjects subfolder. While manually copying the subprojects to the MergedProjects subfolder, overwrite all - Adobe 65030089 | User Manual - Page 353
USING ROBOHELP HTML 10 347 Generating output Note: Do not import Multiscreen-HTML5-generated Default resources Resources specific to the screen profile Distribute FlashHelp Users need a browser and Flash Player 8.0 or later to view FlashHelp. By default, all FlashHelp output files are placed - Adobe 65030089 | User Manual - Page 354
USING ROBOHELP HTML 10 348 Generating output Distribute FlashHelp with an application ❖ Copy the XML whmozemu.js WF_MASTER.JS wf_dispatcher.js whtopic.js whutils.js whver.js Description Legacy support file for context-sensitive API Style sheet FlashHelp skin file Style sheet for customized topic - Adobe 65030089 | User Manual - Page 355
USING ROBOHELP HTML 10 349 Generating output Output files in the whgdata subfolder File whexpbar.gif whlstf0.htm whlstfl0.htm whlstg0.htm whlsti0.htm whlstt0.htm whlstt1.htm whnvf30. - Adobe 65030089 | User Manual - Page 356
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 Manual - Page 357
USING ROBOHELP HTML 10 351 Generating output More Help topics "Create a project" on page 26 " . • JavaHelp 1.1.3 or later components. • Java Runtime Environment file (JRE), or have users download it from the Sun website. • If the project contains related topics buttons, distribute the Bsscjhrs. - Adobe 65030089 | User Manual - Page 358
USING ROBOHELP HTML 10 352 Generating output Output files for Oracle Help File .HS .JAR distribute Required on user computers AIR (.air) file generated in the output location AIR Runtime See Adobe AIR Runtime Distribution All files generated in the output folder Flash plug-in 9.0 or later - Adobe 65030089 | User Manual - Page 359
10 353 the FlashPlayerTrust folder. 1 Select Start > Run. 2 Type %appdata%\Macromedia\Flash Player\#Security\FlashPlayerTrust\ and click OK. 3 Open the RoboHelp.cfg file in Moderator password and configuration file path When you distribute Adobe AIR output, make sure that you share the moderator - Adobe 65030089 | User Manual - Page 360
10 to Pending or Accepted at the time of generating Adobe AIR output. Users can access the settings.xml file present source files. Similarly, you can generate PDF files and print documents from the same not use a master document for large manuals. Single document One Word file containing the title page - Adobe 65030089 | User Manual - Page 361
USING ROBOHELP HTML 10 355 Generating output Printed document structure • Books and pages at the root level of the printed document begin a new chapter. • Subbooks and pages that are - Adobe 65030089 | User Manual - Page 362
USING ROBOHELP HTML 10 356 Generating output Footers Footers repeat at the bottom of each page and contain page numbers. Page numbers are left-justified on evennumbered pages and - Adobe 65030089 | User Manual - Page 363
USING ROBOHELP HTML 10 357 Generating output • To convert expanding glossary hotspots, click the Start Glossary Hotspot wizard icon in the Glossary toolbar in the Glossary pod. You can - Adobe 65030089 | User Manual - Page 364
folder. Click the Browse button to browse to a different folder. Click OK. Note: Printed Word documentation supports both DOC and DOCX formats. PDF Settings Set PDF properties. Settings Select options for document files creation. • Generate Individual Documents Create a separate Word file for - Adobe 65030089 | User Manual - Page 365
USING ROBOHELP HTML 10 359 Generating output Topics excluded in the General dialog box using conditional build tags have a gray icon in the Chapter Layout column. Missing topics are - Adobe 65030089 | User Manual - Page 366
USING ROBOHELP HTML 10 360 Generating output Styles and formatting Ensure that both project styles 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 - Adobe 65030089 | User Manual - Page 367
USING ROBOHELP HTML 10 361 Generating output Share style mappings from a printed documentation layout with other authors to ensure consistency. Import style mappings (ZPL file) into the project, or - Adobe 65030089 | User Manual - Page 368
USING ROBOHELP HTML 10 362 Generating output Unmapped styles denoted by Unassigned - Use Style In Project in the Print Document Appearance dialog box are added to the Word document. - Adobe 65030089 | User Manual - Page 369
USING ROBOHELP HTML 10 363 Generating output Note: Styles must be mapped to other styles of the same type and click Next for each screen of the Properties dialog box. 5 Click Save. Generate PDFs PDFs retain links, bookmarks, formatting, graphics, fonts, special characters, and colors. Generate - Adobe 65030089 | User Manual - Page 370
USING ROBOHELP HTML 10 364 Generating output Generate a PDF with setup options 1 In the Single Source Layouts pod, double-click the printed 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 set up - Adobe 65030089 | User Manual - Page 371
USING ROBOHELP HTML 10 365 Generating output Skins About skins Use skins to change the appearance of Adobe AIR, WebHelp, and FlashHelp for WebHelp and WebHelp Pro projects" on page 368 "Create custom skins for Adobe AIR projects" on page 367 Add skins to the gallery Store or reuse skins across - Adobe 65030089 | User Manual - Page 372
ROBOHELP HTML 10 366 Generating output 2 Right-click a skin. Select Add To Gallery. Import skins When you import Adobe AIR AHS files, WebHelp SKN files, or FlashHelp FHS files, all associated files are added to the skins subfolder. You can also import a compressed AHZ (for Adobe AIR), ZKN (for - Adobe 65030089 | User Manual - Page 373
USING ROBOHELP HTML 10 367 Generating output 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 Manual - Page 374
USING ROBOHELP HTML 10 368 Generating output Note: Supported file types for icons are .jpg, .gif, and .png. • To change the icon set, click Select New Set. Select an icon set from the drop- - Adobe 65030089 | User Manual - Page 375
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 image for the Sync TOC button. When you generate, select Synchronize TOC (Manually) to ensure that the button appears on the navigation bar. Note: The Hide - Adobe 65030089 | User Manual - Page 376
ROBOHELP HTML 10 370 Generating 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 Manual - Page 377
USING ROBOHELP HTML 10 371 Generating output Example of vertical-style skins Windows RoboHelp supports WebHelp and FlashHelp windows for use with the context-sensitive Help API. Create or edit windows Note: This procedure applies to Multiscreen HTML5, Adobe AIR, WebHelp, WebHelp Pro, FlashHelp, - Adobe 65030089 | User Manual - Page 378
USING ROBOHELP HTML 10 372 Generating output 4 Select the options specific to WebHelp Pro and 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 - Adobe 65030089 | User Manual - Page 379
USING ROBOHELP HTML 10 373 Generating output Button Description Updates the topic content. Search Enables users to search for topics using Wildcard and Boolean characters. • Browse Sequences Enables support if you have created browse sequences. • Default Tab Select the tab to display when the - Adobe 65030089 | User Manual - Page 380
USING ROBOHELP HTML 10 374 Generating output • Auto Show/Hide Nav Pane Automatically hides the left pane when users switch focus from the HTML Help viewer to a program. The - Adobe 65030089 | User Manual - Page 381
USING ROBOHELP HTML 10 375 Generating output Advanced window Extended Styles properties Tool Window Sets the window for use as a floating toolbar. Window style ID is WS_EX_TOOLWINDOW. Client Edge - Adobe 65030089 | User Manual - Page 382
USING ROBOHELP HTML 10 376 Generating output 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. • Website links - Adobe 65030089 | User Manual - Page 383
USING ROBOHELP HTML 10 377 Generating output Assign a default window If the project doesn't profile, changing the width range requires manual updating of the style sheet. Save the screen properties and update the style sheet. For step-by-step instructions, see Manage media queries. Browser(s) - Adobe 65030089 | User Manual - Page 384
USING ROBOHELP HTML 10 378 Generating output Modify a screen profile RoboHelp provides a set of screens Check for new screen profiles link enables you to access latest screen profiles uploaded on adobe.com. Screen Resolution Set the range of screen resolutions for the screen profile by specifying - Adobe 65030089 | User Manual - Page 385
USING ROBOHELP HTML 10 379 Generating output 5 Click OK. Screen layouts Screen layouts layouts offer placeholders for different elements, such as Table of Contents, index, and glossary. This support gives you the flexibility to lay out the elements in the way you want. Screen layouts contain - Adobe 65030089 | User Manual - Page 386
USING ROBOHELP HTML 10 380 Generating output Editing a screen layout A screen layout has two key components, a set of screen layout pages and a CSS. The screen layout pages define the - Adobe 65030089 | User Manual - Page 387
USING ROBOHELP HTML 10 381 Generating output TOC Choose between Tree and Expanding Node to insert a TOC element on a screen layout page and style the various placeholders. Tree displays - Adobe 65030089 | User Manual - Page 388
USING ROBOHELP HTML 10 Generating output Placeholder Icon Index Parent Closed Book Open Book Page Link Note: These placeholders are children of TOC. Tab Content Group[HTML] Index Keyword - Adobe 65030089 | User Manual - Page 389
USING ROBOHELP HTML 10 383 Generating output Placeholder Tab Content Group Tab Group Tabbed Panel Text TOC Parent Tabbed Panel Tabbed Panel [HTML] Closed Book Open Book Page Link - Adobe 65030089 | User Manual - Page 390
care of supported devices • Make sure that hyperlink styles take care of touch scenarios and include webkit proprietary attributes (for example, -webkit-tap-highlight-color) if required. Note: These attributes cannot be inserted through RoboHelp CSS Editor and need to be inserted manually. • Use LNG - Adobe 65030089 | User Manual - Page 391
385 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 Manual - Page 392
name. Note: Relaunch RoboHelp to load the modified settings. PDF review Create a PDF for review The Create PDF For Review option in the Review menu lets you create a PDF that reviewers can review with the free Adobe Reader. The PDF stores a tagged structure of the RoboHelp project, enabling you - Adobe 65030089 | User Manual - Page 393
Acrobat 9 Pro or above is installed on the same computer. 7 Select Enabling Commenting In Adobe Reader. Note: This option is enabled in RoboHelp if Acrobat 10 Play to continue the review. Import comments from PDF • Select Review > Import Comments From PDF. • (Optional) Select Update Topic Status to - Adobe 65030089 | User Manual - Page 394
USING ROBOHELP HTML 10 388 Review and collaboration PDF Sticky note Callout Comment inserted on for example, inserted text and deleted text. Reviewer Displays the reviewer name as configured in Acrobat (for review comments) or in Tools > Options (for tracked changes). See "Configure review - Adobe 65030089 | User Manual - Page 395
USING ROBOHELP HTML 10 389 Review and collaboration Status Displays the status of the comment. Note: RoboHelp supports three types of statuses: Accepted, Rejected, and None. When you import a PDF in which statuses are set, RoboHelp converts the Canceled and Completed statuses to None. Type - Adobe 65030089 | User Manual - Page 396
USING ROBOHELP HTML 10 390 Review and collaboration • To set a status, select the comment, also deleted from Review Pane. Review and collaboration in AIR Help Rating, commenting, and moderation capabilities in AIR Help (Adobe AIR Application output) let you implement review and collaboration in - Adobe 65030089 | User Manual - Page 397
USING ROBOHELP HTML 10 391 Review and collaboration Topic rating If you are delivering Help as an Adobe AIR application, you can enable topic rating to gather user feedback. Users can rate any topic on a scale of 0-5 stars. The AIR Help application saves the topic rating for each user in a shared - Adobe 65030089 | User Manual - Page 398
10 392 Review and collaboration Configure preferences for comments Users can configure the following preferences for comments in AIR commenting is enabled when generating the Adobe AIR output. Comments are stored locally on a RoboHelp server, RoboHelp supports comment moderation. If moderation is - Adobe 65030089 | User Manual - Page 399
USING ROBOHELP HTML 10 393 Review and collaboration Moderate comments In the AIR Help output, do the following: 1 Click Preferences. 2 Click Comment. 3 Specify the password. 4 Select Show Moderation Pod. Click OK. 5 Use the following options to filter comments: - Adobe 65030089 | User Manual - Page 400
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 Manual - Page 401
HTML 10 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 control to edit its appearance and properties. HTML Help doesn't support all ActiveX controls, and some controls don't have properties - Adobe 65030089 | User Manual - Page 402
USING ROBOHELP HTML 10 396 Advanced program features 2 Select Calendar Control [version]. The 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 - Adobe 65030089 | User Manual - Page 403
USING ROBOHELP HTML 10 397 Advanced program features Forms Workflow to create forms Note: Forms created . 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 - Adobe 65030089 | User Manual - Page 404
USING ROBOHELP HTML 10 398 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 - Adobe 65030089 | User Manual - Page 405
USING ROBOHELP HTML 10 399 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 - Adobe 65030089 | User Manual - Page 406
USING ROBOHELP HTML 10 400 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 - Adobe 65030089 | User Manual - Page 407
USING ROBOHELP HTML 10 401 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. • - Adobe 65030089 | User Manual - Page 408
USING ROBOHELP HTML 10 402 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 - Adobe 65030089 | User Manual - Page 409
USING ROBOHELP HTML 10 403 Advanced program features HTML Help controls Reuse HTML Help controls HTML Help controls are portable. You can copy the controls into topics and change - Adobe 65030089 | User Manual - Page 410
USING ROBOHELP HTML 10 404 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 Manual - Page 411
USING ROBOHELP HTML 10 405 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 - Adobe 65030089 | User Manual - Page 412
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 Manual - Page 413
USING ROBOHELP HTML 10 407 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 - Adobe 65030089 | User Manual - Page 414
ROBOHELP HTML 10 408 Advanced Click Delete Info Type. Scripts About scripts Scripts are coded instructions that tell the HTML Help viewer or browser how to react HTML Help systems, intranets, and websites. Two common supported scripting languages are VBScript and JavaScript. The scripting used is - Adobe 65030089 | User Manual - Page 415
USING ROBOHELP HTML 10 409 Advanced program features Note: Add support files used in scripts (such as image files) double-click the icon. 6 Test the HTML file after you generate output. Event support in scripting Use events in scripts to invoke functions at specific trigger points defined in - Adobe 65030089 | User Manual - Page 416
USING ROBOHELP HTML 10 410 Advanced program features Register using the Script Explorer pod function: unregisterEvent (EventName:string, FilePath:string, FunctionName:string) About ExtendScript Toolkit support Create your own scripts to automate repetitive tasks and time-consuming workflows. For - Adobe 65030089 | User Manual - Page 417
HTML 10 411 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 the methods covered in the Data Object Model, see Adobe RoboHelp Scripting Guide. Manage script folders Create a script folder Create - Adobe 65030089 | User Manual - Page 418
USING ROBOHELP HTML 10 412 Advanced program features Edit Right-click a script in the 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 - Adobe 65030089 | User Manual - Page 419
USING ROBOHELP HTML 10 413 Advanced program features 3 Select an image to display closing drop-down text and another image to open a drop-down hotspot. Select different images to - Adobe 65030089 | User Manual - Page 420
414 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 Manual - Page 421
USING ROBOHELP HTML 10 415 Default keyboard shortcuts Task Insert image Insert text-only pop-up* Open Project Settings dialog Open Topic Properties dialog Display Conditional Build Tag dialog* - Adobe 65030089 | User Manual - Page 422
USING ROBOHELP HTML 10 416 Default keyboard shortcuts Task Move book or topic to the right in the table of contents Index pod Change index keyword to lowercase Change
-
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
-
381
-
382
-
383
-
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
-
417
-
418
-
419
-
420
-
421
-
422
 |
 |
Using
ADOBE
®
ROBOHELP
®
HTML 10