Home
/
Adobe
/
65030089 - Robohelp - PC
/
Using Manual

Adobe 65030089 - Robohelp - PC, Using Manual, Page: 231 / 380

Share

Page: 231 / 380

Adobe 65030089 - Robohelp - PC Using Manual Download Page 231

225

Last updated 12/14/2011

Chapter 11: Context-sensitive Help

About context-sensitive Help

A context-sensitive Help (CSH) topic provides information about the user interface of an application relative to the
task a user performs. For example, CSH topics provide details about fields and controls in dialog boxes, descriptions
of windows or screen objects, and explanations of messages. The user accesses a CSH topic by pressing F1, clicking a
Help button, selecting from a menu, or clicking a question-mark icon.

The process of creating and implementing context-sensitive Help typically involves the content author and the
application developer. To specify context-sensitive topics, the author creates

map IDs

and

map files

. When a user

accesses context-sensitive Help, a

map number

and

Help file

name are sent to the

Help engine

. The engine matches the

map number to a topic ID and an HTM filename so that the correct topic appears.

The final step in the process is to test the context-sensitive Help. RoboHelp HTML provides several tools you can use
in addition to testing context-sensitive Help in the application.

Window-level topic

Describes windows, dialog boxes, and messages in an application. Each window-level topic is in

HTM format and stored in a file with the extension .htm. It can contain text formatting, links, images, and other
features. These topics are more detailed than field-level topics because they describe the user interface components.
Users access these topics by pressing F1, clicking Help buttons, and selecting from menus.

If a custom window is not included with the application Help, context-sensitive topics appear in the HTML Help
viewer.

Field-level (What's This?) topic

(WinHelp and Microsoft HTML Help projects) Briefly describes a field. A user

accesses the topic by clicking a question-mark icon, and then clicking a field in a dialog box. In RoboHelp, field-level
topics are called

What’s This?

topics.

Note:

WebHelp, 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 API (Application Programming Interface).

Airplane Help

Offline Help unsupported by an Internet connection. To use

RH_ShowHelp

, associate the offline Help

system with the function

RH_AssociateOfflineHelp

. This step tells the function how to operate if no Internet

connection is available. Individual calls to

RH_ShowHelp

must specify offline Help. Both

RH_ShowHelp

and

RH_AssociateOfflineHelp

are in the support files. Use airplane Help to provide back-up Help when an Internet

connection fails.

Note:

RH_ShowHelp is a programming function that a developer uses to display a help topic using rules found in

RoboHelp's CSH API.

«
...
229
230
231
232
233
...
»

Summary of Contents for 65030089 - Robohelp - PC

Page 1: ...Using ADOBE ROBOHELP HTML 9...

Page 2: ...p www adobe com go thirdparty Portions include software under the following terms This product includes software developed by the Apache Software Foundation http www apache org MPEG Layer 3 audio comp...

Page 3: ...9 Authoring content in multiple languages 42 Import PDF files 48 Importing and linking Microsoft Word documents 50 Import FrameMaker documents 65 Import a DITA map file 82 Import XML files 83 Import M...

Page 4: ...s for style sheets 157 Table styles 158 List styles 159 Apply styles 161 Edit styles in CSS files 162 Delete styles from style sheets 162 Use color and images 163 Inline styles 164 Chapter 7 TOCs inde...

Page 5: ...ntext sensitive topics 232 Information for developers 232 What s This Help 259 Maintaining text only topics Microsoft HTML Help projects 263 Working with text only topics 264 Testing context sensitive...

Page 6: ...vi USING ROBOHELP HTML 9 Contents Last updated 12 14 2011 Information types for HTML Help 367 Scripts 369 About ExtendScript Toolkit support 370 Twisties 372 Chapter 15 Default keyboard shortcuts...

Page 7: ...user communities seminars tutorials RSS feeds and much more Activation and registration To review complete system requirements and recommendations for your Adobe RoboHelp 9 software see the ReadMe fil...

Page 8: ...integrated environment on Adobe com that gives you access to community generated content moderated by Adobe and industry experts Comments from users help guide you to an answer Search Community Help...

Page 9: ...u interact with like minded users Adobe Labs fosters a collaborative software development process In this environment customers quickly become productive with new products and technologies Adobe Labs...

Page 10: ...resources if the resources are modified in the shared location Using linked resources helps you maintain consistency and conform to organizational and industry standards See Managing resources on page...

Page 11: ...t formatting tables lists hyperlinks and images intact Automated CSH authoring From within RoboHelp open the application for which you want to provide context sensitive Help and map dialog boxes with...

Page 12: ...erage the latest enhancements in these products such as support for setting a text background color at both character and paragraph levels in FrameMaker RoboHelp Server reports to optimize content Rob...

Page 13: ...linking DITA maps and DITA topics You can now import or link DITA maps ditamap dita and xml and DITA topics dita and xml For RoboHelp a DITA map is similar to a FrameMaker book and a Dita topic is si...

Page 14: ...on a server running RoboHelp Server for users outside your corporate network In both scenarios RoboHelp supports comment moderation See Review and collaboration in AIR Help on page 352 Publishing feat...

Page 15: ...between the content for different roles products or variants For example queries that a call center agent handles sometimes pertain to different areas of system administration for example user admini...

Page 16: ...er encoding different from UTF 8 For information about how to set character encoding for an SSL see the relevant topic in Generate output on page 292 Note Character encoding in SSL is not supported fo...

Page 17: ...list in Printed Documentation layout properties Unnamed styles appear in the Microsoft Word styles All drop down list as Unassigned In the generated Microsoft Word document the mapped styles retain th...

Page 18: ...layout on page 284 and Distribute Adobe AIR output on page 321 Customization through settings xml Users can override the moderation setting defined in the SSL by configuring the moderation state setti...

Page 19: ...to stay ahead of the competition and enabling information collection and publication What s new in RoboHelp Server 9 User interface enhancements RoboHelp Server 9 features a fresh aesthetically appea...

Page 20: ...hHelp Pro projects published to RoboHelp Server with server side indexing enabled For keywords within topics words in the immediate vicinity of the keyword in the topic are displayed as context The st...

Page 21: ...authentication Configure LDAP settings Configure search indexing settings The little things The Web Administrator now provides functionalities to edit and delete users Only RoboHelp Server administrat...

Page 22: ...ace switcher Various toolbars appear below the menu bar Select View Toolbars to show or hide toolbars that you require The topic window or the Tabbed Document pane displays the topic s that you are ed...

Page 23: ...a pod and drag and drop it on the required part of the screen Change the display of the pod 1 Do one of the following Click the down arrow button in the upper right corner of a pod Right click in the...

Page 24: ...se skins with WebHelp or FlashHelp projects to change the appearance of the Help system You can match the appearance of a company website or add interest and style to the output Use skins to customize...

Page 25: ...pics Create a style using the Styles And Formatting pod on page 157 User Defined Variables pod From the User Defined Variables pod you can accomplish these tasks Create edit or delete variables Create...

Page 26: ...s on page 123 RoboHelp Server pod The RoboHelp Server pod enables you to connect to RoboHelp Server You can configure the setup for the server by selecting WebHelp Pro or FlashHelp Pro as the primary...

Page 27: ...drag it to the location where you want it to appear on the menu bar 5 Right click the New Menu item on the menu bar and click inside the Name field 6 Type the desired menu name and press Enter 7 Choos...

Page 28: ...to show large icons for the menus Show Screen Tips On toolbars Select this option to show Screen Tips on the toolbars Show Shortcut Keys In Screen Tips Select this option to show keyboard shortcuts in...

Page 29: ...tabs in Design Editor and allows editing Deselect this option to work in single topic mode Clear Project Cache cpd File Before Opening Any Project Controls whether the old ProjectName cpd file will b...

Page 30: ...cations By default notifications are enabled Some notifications include an option Don t Ask Me Again to suppress their display To enable or disable all notifications deselect or select Tools Options G...

Page 31: ...e browse sequences paths a user can follow through Help topics For example if a user must read several related topics to understand a feature completely you can link them in a browse sequence 5 Custom...

Page 32: ...when they open the Help system The table of contents presents a hierarchical outline of what the Help project contains Users can browse and select topics to view from the Contents tab Indexes If an in...

Page 33: ...modified if the order of topics or subfolders is changed in Project Manager Single source layout files SSL A single source layout file SSL is used for each single source layout An SSL file stores the...

Page 34: ...security changes Microsoft HTML Help is now used where the Help has to be run on the users PC it cannot be installed on a server without registry changes WebHelp and FlashHelp are used where the Help...

Page 35: ...cation Help does not use master pages or snippets but you can always add them e Handbook Create a project for an electronic handbook such as an employee handbook for a company The e Handbook project t...

Page 36: ...ns The first topic is selected in the HTML Files Topics folder More Help topics Change project settings on page 33 Create a project by importing documents 1 Do one of the following From the Starter po...

Page 37: ...Select File New Project 2 Click the Import tab 3 Select DITA Map File 4 Click OK 5 Enter the following information in the New Project wizard DITA Map File To Import Specify path to a valid DITA map f...

Page 38: ...t of the most recent folders you visited This icon is disabled if you do not access a folder in the dialog box Up one level icon Enables you to move to the parent folder of the current folder displaye...

Page 39: ...he default project language Advanced Click to create or edit lists for localization Set options in each pane To Do List Click Manage to manage the To Do list for your project For more information see...

Page 40: ...p WebHelp Pro FlashHelp FlashHelp Pro AIR Help printed documentation or HTML Help output See the complete list of available changes you can make in the LNG file tab When you edit the LNG file your cha...

Page 41: ...olbars in the left pane and along the top View your project often to test links and make sure that styles appear properly View each single source in the viewer required for the specified output type M...

Page 42: ...version of RoboHelp to a newer version You can generate a report on the customized To Do list Edit items on the To Do list 1 Select File Project Settings 2 Click the General tab 3 Click Manage 4 Do e...

Page 43: ...button 3 Double click the source file for any of the following Bitmaps and icons used with HTML Help controls Image files used in style sheets topic backgrounds and scripts The JavaScript file that su...

Page 44: ...ger pod To remove multiple topics use the Topic List pod 2 Press Delete If prompted do NOT remove references to removed topics Note You can choose to remove the references but if you do that you do no...

Page 45: ...ultimedia to topics You can also find out where the files are referenced in your project Style sheets Style sheets control the formatting of topics When you change a style sheet all topics associated...

Page 46: ...ght click for more options Open folders Open folders display a minus sign with the contents shown below Click the minus sign to collapse the folder Toggle view Click to switch between a simplified vie...

Page 47: ...fy styles Text only files For What s This Help TXT format Double click to create or modify text only topics files Map Files For Context Sensitive Help HH Includes imported map files or automatically g...

Page 48: ...not affected in the end user s system Support for multiple languages RoboHelp provides multiple language support at the paragraph topic and project level You can set the language at the paragraph leve...

Page 49: ...Yes No Yes Russian Russia Yes Yes No Yes Bulgarian Bulgaria Yes Yes No Yes Czech Czech Republic Yes Yes No Yes Polish Poland Yes Yes No Yes Romanian Romania Yes Yes No Yes Hungarian Hungary Yes Yes No...

Page 50: ...Japanese tables of contents indexes and glossaries 10 Create a conditional build tag called JapaneseContent 11 Apply the JapaneseContent conditional build tag to the Japanese content 12 Generate outpu...

Page 51: ...in the Skin Editor If you do not change the default text such as Contents for the Contents button the text is automatically translated using the project language setting If you customize text in a sk...

Page 52: ...us association and for spell checking For example suppose you set the project language to UK English and the paragraph language to French for several paragraphs The French spelling checker is activate...

Page 53: ...sing Unicode strings Convert and import text of non Unicode encoded file types HTML XML MIGF and so on Publish content to a non English server by adding multibyte characters in the complete path name...

Page 54: ...project folder Language language folder Minor customizations 1 Open Notepad 2 Open the file to modify These files reside in C Program Files Adobe Adobe RoboHelp version RoboHTML Language en_US 3 Open...

Page 55: ...ed HTML Advanced Creates a topic for each PDF page Positioning the content can require advanced HTML and subsequent editing can be difficult Use this option if the other options don t produce the resu...

Page 56: ...nversion settings on page 64 Steps to import a Word document into RoboHelp 1 Locate your Word document 2 Optimize the Word document for import See Optimizing Word documents for online output on page 5...

Page 57: ...cument If however you are bringing in content as a one time activity you can use the import option Ability to automatically update TOC index and glossary changes from the source document Yes When you...

Page 58: ...cient information to make sense as a standalone unit For example if a short task doesn t make sense without some introductory conceptual information don t display that task as a standalone topic To av...

Page 59: ...levant details in the New Project wizard and click Finish Link a Word document to a RoboHelp project 1 Create a project in RoboHelp 2 Select File Link Word Document 3 Click Browse to select one or mor...

Page 60: ...order that they should appear in the master TOC The converted TOC is based on the TOC field codes of the Word document Ensure that Headings for main books have lower level headings Headings for sub bo...

Page 61: ...es you can define consistent layouts and consistent headers and footers 1 Select File Project Settings 2 In the Import tab of the Project Settings dialog box click Edit under Word Document 3 In the Co...

Page 62: ...elect Glossary Definition Style to mark the style to consider for the glossary definition Select Glossary Term to mark the style to consider for the glossary term Note Follow Glossary Definition Style...

Page 63: ...convert the Word list styles to RoboHelp lists select RoboHelp List from the Convert Word List To pop up menu To convert the Word list styles to HTML lists select HTML List from the Convert Word List...

Page 64: ...also create RoboHelp styles from inline formatting in your Word documents Such styles are added to the project CSS 1 Select File Project Settings 2 In the Import tab click Edit under Word Document 3 I...

Page 65: ...der Word Document 3 In the Conversion Settings dialog box in the Paragraph group select the paragraph style on which to base pagination 4 Select the option marked Pagination Split into topics based on...

Page 66: ...pattern Topics are named according to the selected pattern You can select one of the following or create a topic name pattern Default Uses the topic title text as the topic filename filename_no_ext p...

Page 67: ...updates the converted HTML topics TOC index and glossary Word document synchronization status indicators The following table shows the different status indicators that appear on the Project Manager po...

Page 68: ...ll linked documents including Word and FrameMaker documents and overwrites all generated topics Preserve changes to a topic during an update Normally when you update a linked document all topics gener...

Page 69: ...dialog box select File Update Settings tab 3 On the right column select the deleted files that you want to retrieve and click OK 4 Update the Word document Edit a linked Word document You can edit lin...

Page 70: ...ings include Cascading style sheets CSS for RoboHelp projects Style mapping between Word styles and RoboHelp styles Style conversion and other settings Export conversion settings 1 Select File Project...

Page 71: ...ord document Else the Cross References are imported as plain text Unresolved cross references and hypertext entries appear as text in online Help URLs become live hypertext links in the online Help ou...

Page 72: ...rmats allow you to link specific topics to related content within the application workflow Although you can assign map IDs to topics in RoboHelp you can also assign context sensitive Help markers in F...

Page 73: ...ave indented hierarchical headings with different styles See Convert a FrameMaker TOC on page 70 Importing FrameMaker documents The RoboHelp workflow for linking or importing FrameMaker documents allo...

Page 74: ...ntent cannot be edited as a text inset in FrameMaker but can only be edited as text within Robohelp Index and glossary Index and glossary files generated in the FrameMaker book are not converted Inste...

Page 75: ...hat are associated with paragraph formats Page layout size and pagination Ignored These elements are not applicable to online Help See Pagination for Help on page 75 Headers footers Ignored Headers an...

Page 76: ...onts or no bold for the subsumed headings To make a heading a sub book place the heading under a main heading Then include indented heading levels beneath the sub book heading or use smaller fonts or...

Page 77: ...select the FrameMaker book or document 2 Select Convert Glossary in the Content Settings dialog box and select one of the following options Add To Existing Glossary Add the FrameMaker glossary to the...

Page 78: ...ersion parameters If you are opening a RoboHelp 7 project that had FrameMaker documents added by reference or by copy you can retain the document specific settings defined in the RoboHelp 7 project Wh...

Page 79: ...HTML topics Context Sensitive Help Marker Specify the context sensitive Help marker that RoboHelp should use for generating context sensitive Help User Defined HTML Tag Select the user defined HTML ta...

Page 80: ...Maker document 5 Double click a building block to append it to the RoboHelp cross reference definition Content reference Text or files that you have inserted into the FrameMaker documents as content r...

Page 81: ...nformation that is covered in another Heading 3 level topic To avoid such disconnected topics set the pagination at a higher level so that complete information is available in a single Help topic Drop...

Page 82: ...the marker to be used as context sensitive Help marker in your FrameMaker documents Later you create a map ID file by associating the map IDs from the development team and the context sensitive Help...

Page 83: ...el select the FrameMaker format from the Paragraph group 4 From the RoboHelp Style menu select the RoboHelp style that you want to map to the FrameMaker format To retain the appearance of FrameMaker t...

Page 84: ...character styles in the HTML output for the formats that you import from FrameMaker You can define separate HTML tags for each format in the FrameMaker document 1 Select File Project Settings 2 In th...

Page 85: ...the source document FrameMaker numbered list mapped to RoboHelp unnumbered style You can map a FrameMaker paragraph format with autonumbering properties to a RoboHelp paragraph style that is not link...

Page 86: ...e formats contained table titles and table footnotes convert these paragraph formats in FrameMaker to RoboHelp paragraph styles separately Decide whether you want to retain automatic numbering in the...

Page 87: ...argins on all sides by setting the margin in All Sides To set margins on individual sides set the margins on each side Borders Set a border for the images To set a uniform border on all sides select A...

Page 88: ...PDF files but they appear in online content when the mouse hovers over the images See FrameMaker Help to learn about setting alternate text for graphics and images Import a DITA map file You can impor...

Page 89: ...The Body Running header Area hdr Select the location of the file containing the XHTML to place in the body running header area of the output file The equivalent parameter for the Ant processing of the...

Page 90: ...TML imports as code Use Customized CSS XSL File Select the customized file Note You can create and edit customized handler files using the XML Handler Manager and the Handler Description File HDF Edit...

Page 91: ...e 134 Import WinHelp projects You can import compiled WinHelp 4 0 HLP or the WinHelp project file HPJ into a project The HPJ file is the main organizational file containing all the source files When g...

Page 92: ...ts and replace with auto numbered lists and bulleted lists in the Design Editor Create special bulleted and numbered list styles and apply them to paragraphs after they are converted WinHelp folder im...

Page 93: ...ply styles to the paragraphs and characters that use them With a one to one style relationship styles in HTML topics use the same names and formatting as the styles in WinHelp documents WinHelp genera...

Page 94: ...ML navigation WinHelp jumps convert into HTML hyperlinks WinHelp pop alls convert to smart ups Browse sequences also convert Mid topic jumps are maintained Maintains authorable buttons Authorable text...

Page 95: ...ns to nonscrolling regions HTML projects do not support nonscrolling regions and the tri pane output window does not need them The background in the Design Editor is gray but in the preview window is...

Page 96: ...L project and image GIF files use the same folder for both Click Browse and navigate to the drive folder to select it Or enter the name of the folder in the text box Limit the length of the HTML files...

Page 97: ...pics selected from Related Topics buttons Keyword Link controls See Also controls the table of contents and the index Table of contents The HTML TOC file HHC does not support WinHelp pages that link t...

Page 98: ...re individually formatted paragraphs and characters You can always create styles and apply them to topics after the HTML project is created If your project is large do use style sheets to create the H...

Page 99: ...ff prompts when performing version control tasks manually deselect the option on the Version Control tab Select Tools Options Files are then checked out automatically Files not selected in the list ca...

Page 100: ...ommended Where can I set version control options for RoboHelp Click Tools Options Version Control Will I need my version control program outside RoboHelp When removing files or folders from your proje...

Page 101: ...is on a server complete the following fields Connection Name Enter any name to identify the database from RoboSource Control Client If you want you can use the database name Server Enter either the IP...

Page 102: ...tes in the common project you can achieve a unified appearance in the merged projects The merging takes place at run time after the projects are generated Before merging the projects you simply place...

Page 103: ...default topic The child projects should store all the content For more information see Which project works best as the master project in FAQs about merging projects on page 100 2 Open the master proj...

Page 104: ...n Windows Explorer Do not rename the files in Windows Explorer however If either of the filenames has spaces open the project and rename the project file Then generate the project and change the name...

Page 105: ...a local drive the installation folder must be added in the list of trusted folders defined in the RoboHelp cfg file of in the FlashPlayerTrust folder See Distribute Adobe AIR output on page 321 2 Rig...

Page 106: ...s only The TOCs of the child projects appear in the output Can the master project include content categories Yes the master project can include any number of content categories However the child proje...

Page 107: ...keywords are combined at run time Can you merge browse sequences No browse sequences are not merged However all the browse sequences defined in each merged project are available in the merged Help How...

Page 108: ...and generate the child project copy the updated CHM file to the master project folder You can do this using Windows Explorer Distribute the most current versions of all CHM files Adobe AIR projects Ho...

Page 109: ...ironment ensure that you don t link to topics that have been moved renamed or removed These links will be broken For a version control project have one person test the latest version for broken links...

Page 110: ...eywords to remove from topics Select Index Select an Index from the list to generate a report for the index selected Duplicate Map IDs report Each map number in your project must be unique Use this di...

Page 111: ...ing Help Project Status report Generate information for a group of topics Tools Reports Project Status by selecting a specific folder from the Folder list Total number of topics completed in progress...

Page 112: ...rences and relink them to different topics If you don t remove references when you remove a topic this report identifies the breakable references Topics By Priority report The Topics By Priority repor...

Page 113: ...references included in your index Used Files report Use this report Tools Reports Used Files for an inventory of all files in the project Missing topics report Use this report Tools Reports Missing T...

Page 114: ...to the topics All HTML topics use WinHelp formatting Formatting is embedded into each HTML element Convert Bulleted Lists Uses bulleted list items from WinHelp topics in topics retains bulleted lists...

Page 115: ...dialog box Default Sets the font to use your default system setting HTML Help Advanced Settings TOC tab Border Add a border around the Contents pane Dialog Frame Add a frame around Contents pane Lines...

Page 116: ...for the project RoboHelp uses the language setting for a topic for the spelling checker the thesaurus smart indexing and full text search indexing The output UI is controlled by the project language s...

Page 117: ...pics You can open topics in Design Editor or another editor while still using RoboHelp to add online Help features In the Project Manager or Topic List pod do one of the following To open the topic in...

Page 118: ...existing format You can edit topics using a third party XHTML editor RoboHelp retains its processing instructions PI as comments to avoid any data loss You can use RoboHelp to edit the third party HT...

Page 119: ...y the file into the project folder Click Yes To All to copy the file and all its components Note You can similarly import FrameMaker documents mif fm book bk PDF documents pdf Word documents docx docm...

Page 120: ...n preview mode both in the Preview dialog box and the browser Text only popups cannot be viewed in Firefox Chrome and Safari If you close the Preview dialog box the topic displayed in the browser appe...

Page 121: ...s a template for HTML topics You define the placement of headers footers and placeholders for the body breadcrumbs and mini TOC Master pages can include snippets and user defined variables You can cre...

Page 122: ...nal build tag to the content inside or outside the body placeholder Create a master page 1 Do one of the following Select File New Master Page Select and right click Master Pages in the Project Set up...

Page 123: ...roperties 2 Click the Appearance tab 3 Select a style sheet from the list of style sheets available in a project 4 Click OK Note Select the Used In tab in the Master Page Properties dialog box to see...

Page 124: ...ange the master page to one or multiple topics at a time Use this option to change the master page of one or more but not all topics in your project You can apply the master page to all topics when yo...

Page 125: ...th the master page becomes effective and overrides the CSS associated with all other individual topics If you choose to apply a CSS master pages associated with individual topics take effect The selec...

Page 126: ...ren t affected unless you edit them 1 Select Tools Options 2 Click the General tab 3 Select Use Underscores In Filenames Change topic properties Topics have properties that define their appearance and...

Page 127: ...pod To find out where a topic is referenced in the index click the Index pod To find out if a topic is in your project click the Topic List pod 2 Select Edit Find Topic 3 To conduct a simple search c...

Page 128: ...Project Status report 1 In the Topic List pod select topics 2 Click the Properties button 3 Click the Status tab 4 Set options as needed Status Click the triangle to select a development stage Priori...

Page 129: ...ts and baggage files in a shared location on your computer or network Multiple authors can use them across projects and manage them from the Resource Manager pod in RoboHelp RoboHelp provides easy way...

Page 130: ...level Resource Manager settings You can specify your preferences for the update of linked resources at a project level For example for project A you can specify that Resource Manager should auto upda...

Page 131: ...ager pod 4 Select one of the following options All Displays all the resources in the shared locations Linked Displays only the resources used in the open project Maintain shared resources 1 Select Vie...

Page 132: ...rce and the copy used in the project are same Modified in the shared location The original shared resource is modified and the copy used in the project is out of sync Modified in the project The copy...

Page 133: ...able with WebHelp and Microsoft HTML Help Specify spelling options Select Tools Spelling Options and select from the following sets of options Main Options Check Spelling As You Type Checks for misspe...

Page 134: ...or projects 1 Open a topic in the Design Editor Do one of the following Select Tools Spell Check Select Tools Spell Check All Topics Optional Click Skip Topic Select Tools Spell Check Project Optional...

Page 135: ...c to the language and the user Every language has its own dictionary and every user can save changes to the dictionary Note The Dictionary Editor is case sensitive 1 Select Tools Spelling Options 2 Cl...

Page 136: ...c g lip finds clip and flip ste p finds step and steep UNIX expressions sells finds sell and sells co p finds cop coop and cp r m finds ram and random cg lass finds class and glass c g lip finds clip...

Page 137: ...is word or phrase as the replacement text Named Specify the file type s to search Where Specify the location to search Case Sensitive Limit the search to strings that exactly match the case of the ent...

Page 138: ...l pane for Oracle projects The General pane applies to the Topic Properties and New Topic dialog boxes in Oracle Help projects Use the General pane to create topic titles and filenames Topic Title Dis...

Page 139: ...topics in RoboHelp by writing XHTML code in the RoboHelp HTML Editor RoboHelp HTML Editor is a text editor for XHTML and HTML tags and text Open RoboHelp HTML Editor 1 Select a topic file from the Pr...

Page 140: ...n another editor while RoboHelp is open When you open a topic in a third party HTML editor RoboHelp functionality is not available You can insert HTML code and elements but you can t insert or edit Ro...

Page 141: ...Set As Default Select Auto Select Editor 3 To change the associations between editor and tag select Auto Select You can change the HTML editor but not the Generator tag You cannot remove the tags eith...

Page 142: ...hoose Format Font Apply color to text 1 Select text 2 In the toolbar click the arrow on the Change Font Color button 3 Click a color swatch or click More Colors to select from additional swatches or t...

Page 143: ...create a font set with Verdana as the first font and then in order Arial and Sans Serif as substitute fonts If users do not have Verdana installed the viewer uses Arial and then Sans Serif 1 Select Fo...

Page 144: ...paragraph 2 Do one of the following In the toolbar click the Decrease Indent or the Increase Indent button in the toolbar Select Format Paragraph Set indents For a left or right margin indent click Up...

Page 145: ...t Snap To Tick Marks More Help topics Create styles for style sheets on page 157 Change the unit of measure for the ruler 1 Select View Show Ruler 2 Right click the ruler 3 Select a unit of measure De...

Page 146: ...line and aligns the text on the next line 1 Open the topic in the Design Editor Click where you want the line break 2 Select Insert Line Break Alternatively press Shift Enter Borders backgrounds colo...

Page 147: ...lines 1 Open the topic in the Design view and click where you want to add the line 2 Select Insert HTML Horizontal Line 3 Select line options To change line length enter a value in Width To change lin...

Page 148: ...ine header rows and columns first or last rows repeatable groups of rows or columns margins within cells and so on Using Table properties you can set margins in a table define width and height of vari...

Page 149: ...le 2 Choose View Toolbars Tables And Borders 3 In the toolbar click the Insert Table button 4 On the table grid drag to determine the columns and rows to add 5 Click to insert the table Insert a custo...

Page 150: ...elect Table Table Properties 3 Set options Set autofit table properties 1 Click a table 2 Select Table Autofit 3 Select a command Autofit To Contents Sets the column width to the width of the column c...

Page 151: ...ft Tab and Tab to decrease and increase indent From the Format menu select Paragraph Type a number in Left or Right Multilevel list On the ruler drag the markers to set the spacing between the number...

Page 152: ...graph Style 4 Type a name for the new style The name can contain letters and numbers only and cannot begin with a number 5 Under Style For Following Paragraph select a style Paragraph styles apply to...

Page 153: ...the start number For an alphabetical list type the numeric equivalent for the start letter For example type 4 for the letter D 5 Click OK Headers footers and page breaks Headers and footers You can c...

Page 154: ...low around a text box If users have Internet Explorer 4 0 or later you can apply Dynamic HTML effects to a paragraph by placing the paragraph in a text box Insert a text box 1 Click where you want to...

Page 155: ...t making information portable and simple to update When you modify a variable or value every occurrence of that variable or value is updated across the project The User Defined Variables pod available...

Page 156: ...able set other than Default Variable Set select the variable set in the Content pane of layout properties 1 Click the Add Edit Variable Set icon 2 Click Add and specify a name for the new variable set...

Page 157: ...ser Defined Variables pod select Default Variable Set 2 Right click a user defined variable and select Delete 3 Select one of the following options Delete Variable And Its References Delete the variab...

Page 158: ...er The exported snippet exists at a global level and is visible to every user Drag a snippet from the Resource Manager pod to the Snippet pod and RoboHelp imports the selected snippet file and its ass...

Page 159: ...the output Inserting variables in snippets Choose a variable from the User Defined Variables pod or right click in a topic and choose Insert User Defined Variable The snippet shows the variable value...

Page 160: ...ormatting Last updated 12 14 2011 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...

Page 161: ...an create styles that use the same formatting as styles in Word templates These styles are saved in style sheets that are attached to the HTML topics If you do not want style sheets translate the Word...

Page 162: ...sheet The new style sheet default css is the default until you create a style sheet or link another style sheet to a new topic 1 Click the Style Sheet button If necessary select View Toolbars Formatt...

Page 163: ...Borders And Shading Use the Borders tab to set border types color line thickness and spacing Use the Shading tab to set background color and image options DHTML Effects Select which dynamic HTML effe...

Page 164: ...oHTML Gallery Tables In addition to the predefined global styles you can copy table styles from a project folder and paste at C Documents and Settings user name Application Data Adobe RoboHTML version...

Page 165: ...al build tags to tables Conditional build tags let you exclude content from output 1 Select a row column table or text in a table 2 Select Format Apply Conditional Build Tags New Multiple 3 Select tag...

Page 166: ...select Edit 2 Select a list level from the Apply Formatting To menu List Preview displays the hierarchical order of the selected level 3 For multilevel lists only Select the paragraph style to apply...

Page 167: ...ths and click OK 4 Select the font for the sequence from the Sequence Font pop up menu and click Add 5 Click the Edit Sequence box and type the sequence that you want For example January February and...

Page 168: ...You cannot use the Undo command to undo changes to a CSS file Edit the CSS file to revert to a previous style Edit a style using the Styles dialog box 1 In the Project Manager pod right click the CSS...

Page 169: ...ct Manager pod right click the CSS file Select Edit 2 Deselect Hide Inherited Styles 3 From Available In select a CSS file 4 In the Styles box select Character 5 Expand Character Style and select a li...

Page 170: ...topics on page 140 Inline styles Apply or edit inline styles 1 In the Design Editor select the block of text to format 2 Do one of the following Select a formatting option from the toolbar From the Fo...

Page 171: ...or the TOC 3 Optional Select Copy Existing Table of Contents and browse for an existing TOC file hhc to create the TOC from an available TOC 4 Click OK RoboHelp opens the Table Of Contents pod 5 In th...

Page 172: ...page icon the linked content appears in the Topic pane You can link to topics websites and so on 1 In the Table Of Contents pod do one of the following Click the New TOC Book button Select Book With L...

Page 173: ...n t affected Rename the TOC page separately if desired 1 In the Table Of Contents pod right click a book or page Select Rename 2 Type the new name Press Enter You can also rename a book or page by cha...

Page 174: ...d pages Choose from these report formats Detailed Includes titles of books and pages names of topics that are linked to them and names of folders in which files are located Overview Includes titles of...

Page 175: ...e tables of contents of the subprojects are available in the master project Move books and pages to TOCs 1 In the Project Manager pod double click tables of contents in the Table Of Contents folder 2...

Page 176: ...x can include multiple levels of keywords and cross references to other keywords Subkeywords can be listed under a main keyword or in a Topics Found window If a main keyword is linked to more than two...

Page 177: ...ndex and the project contains no topic keywords you can sort the keywords in any order When you remove a topic from the project index file keywords remain in the index if other topics use them You can...

Page 178: ...nvert a WinHelp project HPJ file into a RoboHelp project XPJ file the keywords in the WinHelp topics are saved as keywords in the index file More Help topics Create an index automatically on page 177...

Page 179: ...lick the Index tab 3 Click Add Existing On the left a list of all keywords in the project appears On the right a list of all keywords for the current topic appears If the topic is not yet indexed no k...

Page 180: ...ariable For example add the prefix Adobe to the variable RoboHelp 4 From the Topics list select a topic to link this new keyword to 5 Click OK Cross reference index keywords You can cross reference in...

Page 181: ...remains in the index Only the topic you change is updated 1 In the Topic List pod select a topic 2 Click the Properties button 3 Click the Index tab Select a keyword 4 Type the new keyword in the text...

Page 182: ...the Index pod Remove topic references from keywords Note If you remove all topics from the keyword the Index pod displays the keyword in bold text to indicate that it is unreferenced If you select a...

Page 183: ...ary to identify keywords for the paragraph Note This option is applicable for English language only In the Settings area of the Smart Index Settings dialog box you can select options to include as key...

Page 184: ...Select Tools Smart Index Wizard 2 Click Always Ignore 3 Do one of the following To add a word click New and enter text To edit a word select it Click Edit and enter text To delete a word select it Cli...

Page 185: ...lect it Click Edit and enter text To delete a phrase select it Click Delete The list is stored as a PHR file in the project folder You can edit this file in a text editor such as Windows Notepad Note...

Page 186: ...he browse button to navigate to the index 4 Click OK Merge indexes Follow this procedure to merge the indexes within a project 1 In the Project Manager pod open the Index folder 2 Double click an inde...

Page 187: ...es 1 In the Project Manager pod double click a table of contents in the Table Of Contents folder The Table Of Contents pod appears 2 Select View Pods Single Source Layouts 3 Expand the Single Source L...

Page 188: ...s not the left pane focus Folders Instead Of Books Display folder icons instead of book icons Single Click To Open Book Enable books to open with one click Raised Edge or Sunken Edge Create a three di...

Page 189: ...ic is in a subfolder copy the contents of the file into the subfolder before adding the control 1 Open a topic in the Design view 2 Click where you want to add the table of contents 3 Select Insert HT...

Page 190: ...m the topic only links to pop ups More Help topics Link to a pop up on page 192 Automatic indexing with the Smart Index wizard on page 177 Glossaries Create glossary terms 1 In the Project Manager pod...

Page 191: ...y list Click Add To import all terms click Add All 5 Click OK Test and print glossaries Test the glossary in the output 1 Make sure that the Glossary pod is enabled 2 Generate a layout 3 Click View Re...

Page 192: ...To copy an existing glossary select Copy Existing Glossary Click the browse button to navigate to the glossary Click the Start Glossary Hotspot Wizard button in the toolbar to mark existing glossary t...

Page 193: ...lossary Hotspot wizard finds glossary terms within topics and marks them in the topics You can mark all terms to convert to expanding hotspot when you generate or preview output Preview a hotspot by d...

Page 194: ...wizard 1 Select Tools Glossary Hotspot Wizard 2 Select Confirm Adding Definitions For Each Topic 3 Select a folder and status to search 4 From the Select Term menu select the term to remove 5 Click N...

Page 195: ...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 definitions or details Unlike regular pop ups a text only pop...

Page 196: ...s the user can click Installation to go directly to the Installation page Breadcrumbs are displayed in merged projects The breadcrumb trail for a page in a merged project shows the position of the pag...

Page 197: ...s unavailable for linking to topics Display In Auto sizing Popup Displays the destination topic in a pop up window rather than in the viewer or browser The window size adjusts to the content If you ha...

Page 198: ...elect Destination File Or URL select a topic bookmark or frameset 6 Click OK Note A link within a pop up to another pop up doesn t work in the HTML Help viewer or in Internet Explorer Exclude pop ups...

Page 199: ...ect Bookmark bookmark name Properties 2 Edit the name and click OK 3 Unassign and reassign the map ID for the renamed bookmark 4 If the bookmark is used in context sensitive Help edit the map ID Locat...

Page 200: ...button to select Remote Topic Link to external files 1 Choose a link location in the Design Editor 2 Enter text 3 Highlight the text and click the Insert Hyperlink button 4 Click the triangle button n...

Page 201: ...elect the pod workflow pane from which to drag topics Do any of the following To display topics from the Project Manager select View Pods Project Manager To display topics from the TOC Composer select...

Page 202: ...t and press Delete Manage broken links To identify broken links use the Broken Links folder in the Project Manager It displays the names of deleted or missing topics that are referenced in a project S...

Page 203: ...erences for a single topic right click the topic and select Show Topic References To show references for all topics in the project select Tools Edit Topic References On the right select a topic The le...

Page 204: ...When you update a topic make sure that its link controls are up to date Deleting a topic or changing a topic title topic content or filename can affect link controls Link controls function in the fol...

Page 205: ...ition it can be automatically updated in each topic containing the control This means that the control can be copy pasted among associated topics Add Related Topics controls Changes you make to titles...

Page 206: ...pecifies a frame in which to display a topic when the keyword is clicked Custom framesets appear in the list For HTML Help projects using See Also or Keyword Link controls If no topics are associated...

Page 207: ...files Keyword Enter the keyword to reference Type the name exactly as it is used in the CHM file Add Add a keyword to Remote Keywords In Control Delete Remove keyword from Remote Keywords In Control R...

Page 208: ...ear when a user clicks a linked term You can insert a text only pop up anywhere except in topic headers and footers For longer text passages or if you need graphics use a regular pop up More Help topi...

Page 209: ...ailable in Microsoft HTML Help CHM Synonyms Define synonyms to allow for variations in search terms For example you can define cursor pointer and mouse as synonymous terms If the search term is mouse...

Page 210: ...sults these baggage files must be referenced in a topic through a hyperlink Note You must have iFilter for Microsoft and PDF installed on to enable baggage file search Rank search results You can rank...

Page 211: ...ebHelp Pro Select Enable External Content Search FlashHelp and FlashHelp Pro Click Next and select Enable External Content Search Browse sequences Create or edit browse sequences Use browse sequences...

Page 212: ...and click Remove Rename or remove a browse sequence From the Browse Sequence list select the browse sequence To remove it click Remove To rename it click Rename and enter the new name View and test br...

Page 213: ...Test browse sequences in a browser or view 1 Verify that browse sequences are enabled 2 Click the Generate button to generate 3 Click View Result and click through the browse sequence Identify the bro...

Page 214: ...reen resolutions in a single file The program imports these files from WinHelp projects and converts them into GIF images WMF Windows Metafile A vector graphics format intended for Windows systems WMF...

Page 215: ...he toolbar click the Insert Image button 3 Do either of the following Click the Browse button to browse to a file If the image file is in the project select a folder from the Images In Project Folders...

Page 216: ...Select Edit 3 Set options Text Wrapping Select the alignment of the image with the surrounding text Note If text wrapping occurs around an image then the image cannot be aligned If text wrapping is se...

Page 217: ...Hotspot icon 8 To test click the View button in the toolbar Click the hotspot Change an image map 1 In the Design Editor open the topic containing the image map 2 Double click the hotspot 3 In Link T...

Page 218: ...ompt click Yes to copy the file to the project folder 4 Click OK An object in the topic indicates where the file was placed 5 To test the demo click View Edit an Adobe Captivate demo 1 Open the topic...

Page 219: ...wf If you use the multimedia file in other topics add it by dragging the file from the Multimedia folder Note Multimedia content might have dependencies such as Flash or video audio players that you n...

Page 220: ...the following Select text For paragraph based effects click inside the paragraph For positioned boxes select the text box so you see gray boxes on its edges 2 Select DHTML Insert Edit Dynamic HTML Eff...

Page 221: ...cts from the ePub output you can use CBTs More Help topics Apply conditional build tags to content on page 221 Generate output in the ePub format on page 305 Dynamic hotspots About DHTML hotspots DHTM...

Page 222: ...ge Then connect the trigger to a target and assign a DHTML effect When working with triggers and targets keep in mind the following details Triggers and targets must reside in the same topic To indica...

Page 223: ...ent and set marquee properties To set marquee properties first click the marquee destination in the topic Set marquee properties and enter the marquee content Note XHTML does not support Marquees Set...

Page 224: ...out The comment appears in a text pop up note Iframes Use iframes inline frames to insert PDF files or HTML files within an HTML topic If you want to show a PDF file or an accessible URL link in an HT...

Page 225: ...ions for different skill levels are required 2 Determine which conditional build tags to apply to each output type All untagged components are included in the output Determine whether to apply multipl...

Page 226: ...links as described in the following table Conditional build tags Create a conditional build tag 1 Open a topic in Design Editor 2 Select Format Apply Conditional Build Tag New Multiple 3 Click New Typ...

Page 227: ...Level column shows how a tag is applied Topic Applied to a topic Content Applied to topic content Both Applied to both topic and content The File column lists the file containing the tagged informatio...

Page 228: ...s Preview conditional text areas To check the format of a topic with a conditional text area preview it using a conditional build tag expression you have already defined You can also define a conditio...

Page 229: ...expressions An expression is a set of instructions Expressions specify topics to include or exclude from the output You can define a basic expression that excludes tags or a complex expression with Bo...

Page 230: ...utput Desired Result Action All topics to which one tag has been applied Use the tag name For example Tag1 All topics to which multiple tags have been applied Use AND with the tag names For example Ta...

Page 231: ...e with the extension htm It can contain text formatting links images and other features These topics are more detailed than field level topics because they describe the user interface components Users...

Page 232: ...that pairs a topic ID with a map number For example define ID_SetupScreen 101 ID_SetupScreen is the topic ID 101 is the map number ID_SetupScreen 101 is the Map ID Author Developer Writes the Help top...

Page 233: ...avoid using these illegal characters Authors or developers can create the map file If the developer creates the map file the author then imports it Note RoboHelp also supports dynamic context sensiti...

Page 234: ...ile deselect the Locked option 6 Click Close Remove an obsolete map file Obsolete map files sometimes contain map numbers used for updated files These map numbers can dynamically call a wrong topic De...

Page 235: ...nd create a custom map file Map numbers for custom map files are numbered automatically Map Display the map number of the topic ID Map numbers reside in map files h hh hm Topic Display the topic assig...

Page 236: ...value Auto generate a map ID You can generate map IDs using a custom map file or the default map file BSSCDefault h Before you generate map files check with the developer to determine naming conventio...

Page 237: ...keep track of map IDs See Dynamic editing of context sensitive topics on page 232 1 Open the Project Set up pod 2 Expand the Context Sensitive Help folder 3 Expand the Map Files folder 4 Double click...

Page 238: ...oubleshooting Technical authors can readily test whether all dialog boxes are mapped to the correct Help topics When a mismatch is found they can quickly fix it and associate the dialog box with the c...

Page 239: ...e Help system author to export the map files from RoboHelp to Visual Basic 3 Include RoboHelp_CSH vb with your project The function RH_ShowHelp is defined in RoboHelp_CSH vb 4 Add a reference to the M...

Page 240: ...pplication MyHelp chm MyWindow Do not hard code the string variable StrPathAndWindow 7 To call a Help topic call the function RH_ShowHelp with a_pszHelpFile set to StrPathAndWindow uCommand set to HH_...

Page 241: ...rs Prevent RoboHelp_CSH cpp from using precompiled headers Visual Studio 6 1 Select Project Settings 2 Select Robohelp_Csh Cpp 3 On the C C tab change Category to Precompiled Headers 4 Select Not Usin...

Page 242: ...type Description hParent HWND Handle to calling the dialog box HTML Help Only Close the Help dialog box with the calling window a_pszHelpFile const char Help source For Webhelp FlashHelp Path to proj...

Page 243: ...elp MyStartPage htm MyWindow Do not hard code this string Note Export the map files to the location Example To open the topic mapped as number 1 RH_ShowHelp GetSafeHwnd strPathAndWindow HH_HELP_CONTEX...

Page 244: ...XT DWORD 1 2 Run and test the Help call Note If using airplane Help associate the offline Help before making calls Call a context sensitive function for HTML Help 1 Call the function The following exa...

Page 245: ...CELMODE 0 0 TRUE TRUE attempt to cancel capture HWND hWndCapture GetCapture if hWndCapture NULL SendMessage hWndCapture WM_CANCELMODE 0 0 Set the path to server based help CString csOnlineHelpPath _T...

Page 246: ...d offline Help you can map windows to RH_AssociateOfflineHelp Follow this example for Visual Basic strOnline http www mycompany com roboapi asp project myproject RemoteWindow1 strOffline C Program Fil...

Page 247: ...unction RoboHelp_CSH RH_ShowHelp 0 StrPathAndWindow RoboHelp_csh HH_HELP_CONTEXT 1 Where the full path to the RoboHelp server and a dialog box name optional are stored in StrPathAndWindow The project...

Page 248: ...utes defined by the strHelpOptions variable var strHelpOptions location no strHelpOptions toolbar no strHelpOptions menubar yes strHelpOptions status yes strHelpOptions scrollbars yes strHelpOptions r...

Page 249: ...e writer creates the map files ask the writer to export the map files to the location For example To open the topic mapped as number 1 p Click for Help map number 1 p 2 Run the application and test th...

Page 250: ...or C NET to integrate Help systems Context sensitive Help support files for NET Support files for programming context sensitive Help allow you to import code and enter variables instead of writing the...

Page 251: ...5 Copy the RoboHelp_CSH cs file 6 Paste the files to the C NET project 7 Right click the Reference folder Select Add Reference 8 Select Net tab System Web Services Dll 9 Click OK 10 Right click the R...

Page 252: ...NET 4 Copy the RoboHelp_CSH cs file 5 Paste the supporting files to the ASP NET project 6 Right click the Reference folder Select Add Reference 7 Select Net tab System Web Services Dll 8 Click OK 9 A...

Page 253: ...T 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 Righ...

Page 254: ...fline Help systems For ASP NET all information is on a Web server Specify a WebHelp Pro online Help system as a primary Help system and a WebHelp online Help system as a backup Web services provided i...

Page 255: ...nsitive Help for Visual Basic applications Use this information to connect context sensitive WebHelp or WebHelp Pro topics to Visual Basic applications The sample code here uses a function called Show...

Page 256: ...opic unknown context htm End Select ShowHelpContext ShowHelp strTopic bIsLocal End Function Using ShowHelpContext makes maintaining context sensitive Help much easier because if a topic name changes o...

Page 257: ...ailure return hinst HINSTANCE 32 The ShowHelp function requires an explicit filename or URL But for context sensitive Help it is better to code the application to use context IDs rather than explicit...

Page 258: ...te For more information see the HTML Help API Reference at http msdn microsoft com en us library ms670068 VS 85 aspx Window level Help for non Windows platforms Use WebHelp to display context sensitiv...

Page 259: ...orrect map file is used unassign the map ID for the topic Remove the old map file and import the new map file Assign new map IDs Generate and retest Problem Topic is not displayed Error message 1 No m...

Page 260: ...Project_Name chm Cause Wrong map number used in the call Resolution Print the Map IDs report and give it to the developer Use this file to correct map number assignments Problem Topic appears in wron...

Page 261: ...Oracle Help Note This information is for developers who need to connect context sensitive Oracle Help topics to applications The context sensitive Help API and support files let you call built in fun...

Page 262: ...ements ActionListener private Help helpObj private Book bookObj private CSHManager contextManager private MenuItem exitMenu private MenuItem contentsMenu private MenuItem searchMenu private MenuItem i...

Page 263: ...Sample Failed While Creating Help object e printStackTrace System exit 1 Add UI Components MenuBar menubar new MenuBar Menu filemenu new Menu File exitMenu new MenuItem Exit filemenu add exitMenu exit...

Page 264: ...ue true End Add UI Components addWindowListener new WindowAdapter public void windowClosing WindowEvent e setVisible false System exit 0 public void actionPerformed ActionEvent e Object source e getSo...

Page 265: ...What s This Help and Microsoft HTML Help Creating a What s This Help project for Microsoft HTML Help does the following Creates a Context txt file which contains the context sensitive topics Attaches...

Page 266: ...a summary report appears You can view this report copy it to the Windows clipboard and print it 11 When you finish working with the summary report click OK All the components of the dialog boxes and...

Page 267: ...to create a CONTEXT TXT file See Importing What s This Help projects into HTML Help projects Test What s This Help with BugHunter Note BugHunter is for use with Microsoft HTML Help projects only 1 Bef...

Page 268: ...indow Level Help Messages Problem Topic does not appear Error message No message Cause Author did not create a text only topic for a field or control in a dialog Resolution Create a text only topic fo...

Page 269: ...the map file If the developer supplies the map file update the map file For an auto generated map file Open the Context Sensitive Text Only Topics dialog box Select the map number Enter the topic ID C...

Page 270: ...t Create Import Text Only Topic File 4 In File Name enter a name for the topic file If you imported a map file use its name Pizza h and Pizza txt 5 Click Open 6 Select a topic ID for the first topic t...

Page 271: ...the folder with the application EXE file Print a Map IDs report as a checklist for testing dialog boxes Print the text only topics file that matches topic IDs to topics Tips Use BugHunter to test appl...

Page 272: ...ne of the following To test server based Help select Online To test local Help select Offline 3 Do one of the following For server based Help enter the server location and project name by using the fo...

Page 273: ...sages from BugHunter appear in the output window Right click in the pane to copy annotate or save the data To clear the pane right click inside it and select Clear All Data remains in the pane until y...

Page 274: ...t edited topics Context sensitive Help terms ALI file A project file that is automatically created in the project folder when you add update or remove map IDs It shows the topic ID topic match for exa...

Page 275: ...rs to import code and enter variables Each supported language has a corresponding support file with functions to use for calling WebHelp Pro or WebHelp projects and displaying individual topics for co...

Page 276: ...mary layout A primary layout is the default layout that you set for the work environment It lets you generate output without specifying additional options The primary layout contains settings for the...

Page 277: ...e source layout It cannot be the primary layout 2 Select Delete About excluding unreferenced topics from output A project meant for single sourcing can include topics that are not relevant in all type...

Page 278: ...as HTML lists instead of DHTML BMP image files don t appear properly Add or remove search highlights in WebHelp In a WebHelp system search results are highlighted by default in the displayed topics Yo...

Page 279: ...tabs or panes navigation buttons and buttons from design time controls Other elements with alternative text include expanding and drop down text triggers and targets and pop up menus Navigation frame...

Page 280: ...t runtime or when accessing the Help system from a server Window properties Server access accommodates Toolbar Menu Location Bar and Status Bar options To set these tool properties double click a wind...

Page 281: ...the traditional tri pane Help system layout toolbar on top navigation at left content at right It can also generate Help systems in a vertical orientation that minimizes the required screen area by s...

Page 282: ...nd close window controls Layout engine Microsoft Internet Explorer 6 and later supply the required components for HTML Help support HTML Help viewer Displays compiled HTML Help CHM file It uses compon...

Page 283: ...al Errors Errors caused by the HTML Help Workshop program Internal error numbers are 7000 and greater Link TOC books or pages to custom windows Microsoft HTML Help 1 Right click a topic in the TOC pod...

Page 284: ...onents 1 In the Toolbox pod double click Find HTML Help Files or Find HTML Help Components 2 Click Search To rearrange or resize columns drag their headings or separator bars Replace CHM files 1 In th...

Page 285: ...later JavaHelp 1 1 3 or later Generate JavaHelp output Generating JavaHelp saves the source files in the project subfolder JavaHelp default When you generate JavaHelp files RoboHelp can translate Rel...

Page 286: ...pports ActiveX controls DHTML JavaScript startup screens and Visual Basic scripts Style sheets Support for partial cascading style sheets is provided with JavaHelp 1 1 External style sheets work corre...

Page 287: ...ensitive Help calls You can change the topic ID by editing the topic meta tag 1 Open the topic in the HTML Editor 2 In the meta tag area insert the new topic ID in the NewTopicID tag Notes If two topi...

Page 288: ...level of indenting is supported Users can search for keywords in the list As keywords are selected topics are listed in the lower pane Double clicking a topic in the lower pane displays its content in...

Page 289: ...ersion Links Supports links to e mail addresses FTP sites and external files Lists Only simple bulleted or numbered lists appear properly in the Oracle Help viewer Multimedia Supports sound files such...

Page 290: ...layout to generate Help as an Adobe AIR application browser based Help with the theme and skin of an Adobe AIR application or a packaged data file that can be viewed in an AIR Help viewer Adobe AIR i...

Page 291: ...Content Only Generates the Help system as a data file RHA that you can view in a Help viewer Use the Help Viewer wizard in RoboHelp to create a Help viewer To view multiple files in a single view you...

Page 292: ...they want to access from a drop down list Each Help system has its own TOC index browse sequences and search In the Content Categories tab of the Adobe AIR dialog box do the following To create a cont...

Page 293: ...from the output in the Output View pod Exclude Unreferenced Baggage Files From Search Select this option to exclude any topic that exists in the project but is not referenced from the selected TOC or...

Page 294: ...e The following table shows the differences among three types of templates Note Press F11 to show or hide the left and top panes You can choose any of the templates to use in the Help system and previ...

Page 295: ...r picks up the online Help This option is applicable only if you select the output type as Adobe AIR Application or AIR Application And Browser Based Help Note If you select this option make sure that...

Page 296: ...owing options in the New Destination dialog box Descriptive Name Name for the server to publish the Help system to For example if you are publishing a Help system for internal review enter Internal Re...

Page 297: ...e from a certificate authority CA such as Thawte or VeriSign Use the digital certificate to sign the Help system Digital certificates from certificate authorities can be verified through the web They...

Page 298: ...RoboHelp must access all of the files in your project when generating the output If a project consists of thousands of files even a minor delay caused by network traffic compounds as RoboHelp attempts...

Page 299: ...Glossaries on page 184 Variable Set Select a variable set to override the default variable set in the generated Help See User defined variables on page 149 Default Topic The topic that appears when He...

Page 300: ...web page Internet Explorer 6 and later reference this comment to determine the security zone for the page on the user s computer Select this option to avoid having Internet Explorer block the output...

Page 301: ...External Content Search Select to display content from identified URLs outside the Help system For information about how to specify URLs and associate them with search terms see External content sear...

Page 302: ...t option Use the Traditional Style No Skin option Table Of Contents Select a table of contents to display in the generated Help Index Select an index to display in the generated Help Glossary Select a...

Page 303: ...ess is from a website Assumes slower connections uses data in smaller pieces and requires more WebHelp files Local PC or Intranet Internal Network Select if access is from an intranet or a local compu...

Page 304: ...cumentation or contact the Flash developer Set options for generating WebHelp Pro or FlashHelp Pro 1 Set the following options and then click Next Note The order of some options varies according to th...

Page 305: ...individual topics with or without a master page applied to them in the project The CSS and layout of the master page override the CSS and appearance of all the topics If the selected master page does...

Page 306: ...master projects with a copy of the subproject in the subfolder do not select Republish All You then avoid overwriting output files already published to the same location Note If you change the destin...

Page 307: ...or UNIX users or users accessing files on a UNIX server Conditional Build Expression Click Define to specify conditional build expressions Default Topic Click Select to select a topic to display when...

Page 308: ...b Set the following options Name Optional A unique name for the remote view Type Remote view type TOCNavigator KeywordNavigator or SearchNavigator Oracle Help merges views with identical labels and vi...

Page 309: ...ual source files Compressed JavaHelp JAR Generates JAR and HS files Compressed JavaHelp With Source Files Generates JAR and HS files and individual source files Note Generating JavaHelp source files e...

Page 310: ...a and their related display format All DHTML effects are included Table Of Contents Select a table of contents to display in the output Index Select an index to display in the output Glossary Select a...

Page 311: ...he XHTML based content The exported file includes the JPEG thumbnail image that you specify for the cover page of the document see Run the ePub Generator script on page 306 This thumbnail is used to d...

Page 312: ...Description Optional A description of the content ISBN Optional An identifier conforming to the ISBN specification Publish Date The date of publishing the output Follow the format specified in Date an...

Page 313: ...the published location to see the merged system To publish the project click Publish Note If the Publish button is disabled add a destination in the Publish dialog box when generating or editing View...

Page 314: ...ayout pod right click Microsoft HTML Help 2 If prompted click Yes if you want to update the output Otherwise click No Note To see inbound and outbound links by topic select View Pods Link View More He...

Page 315: ...and select Properties 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 the following Select or edi...

Page 316: ...e password for the user ID The network system administrator can provide this information Save Password Saves the password so you do not need to enter it when you publish the files Saving the password...

Page 317: ...ull or relative path of the RoboHelp project b Publish layouts from the command prompt Enter the command in the following format rhcl project path p server name user name password The server name user...

Page 318: ...sting Help content retain the Help title and Help ID of the Help output you configured earlier but update the version number 3 In the Adobe AIR dialog box select the View group and select Enable Auto...

Page 319: ...tion on user systems Let users know which start page HTM file to select to view the Help system Output files in the WebHelp folder Generating WebHelp creates the following output files in subfolders o...

Page 320: ...data whproxy js Framework support whres xml Applet support custom fonts and colors whskin_banner htm For logo dialog box About author skins whskin_blank htm Internal support file same as _blank htm s...

Page 321: ...igation pane width whlstf0 htm Full text search body whlstfl0 htm Level 2 full text search letters whlstg0 htm Glossary terms whlsti0 htm Index terms whlstt0 htm Contents part 2 whlstt1 htm Contents p...

Page 322: ...ll text search keywords XML support whgdata js Loads glossary term definitions whGlossary htm Glossary index data HTML support whGlossary js Glossary index data JavaScript supporting whGlossary htm wh...

Page 323: ...contents to a disc server or local desktop 2 Let users know which start page htm file to select to view the Help system Output files for FlashHelp Output files are created when you use RoboHelp to ge...

Page 324: ...In topic navigation bar whutils js Utility file for common functions whver js Determines browser version File Description whexpbar gif Used to size default navigation pane width whlstf0 htm Body of fu...

Page 325: ...hey are not compiled into the master CHM file DOC PDF XLS If the project includes links to external files distribute the external files They are not compiled into the master CHM file unless they are a...

Page 326: ...r activex_name ocx More Help topics Create a project on page 29 Manage files on page 36 ActiveX controls on page 355 Distribute JavaHelp Distribute the following files and components If the project is...

Page 327: ...e AIR output depends on the output type you select File Description HS HelpSet file Points to a set of map files and defines associated navigational views TOC index and search JAR Compressed Oracle He...

Page 328: ...date according to their preferences Copy the default configuration file from the SSL folder of the project to the location specified in the configuration file path and modify the default settings The...

Page 329: ...ot check for OS specific updatexmllocation attributes logoimage Specifies the location of the image file that will be used to display a logo in AIR Help companytext Specifies the company name that is...

Page 330: ...nd pages at the root level of the printed document begin a new chapter Subbooks and pages that are not at the root level of the printed document continue uninterrupted For books that link to pages the...

Page 331: ...from the document Specify a default title page when you generate the printed documentation The name of the document which appears on the title page is the printed document name you define in the Prin...

Page 332: ...Start Glossary Hotspot wizard icon in the Glossary toolbar in the Glossary pod You can specify whether definitions are converted to inline text and whether inline text appears in the paragraph where...

Page 333: ...e page Location Specify the path for Word documents PDF documents also are saved to this location Creates the printed documentation files under SSL layout name in the project folder Click the Browse b...

Page 334: ...ter Layout column rework it in Word Drag and drop topics from the left to the right The topic icon on the left turns blue to indicate that the topic is added Topics excluded in the General dialog box...

Page 335: ...ating Apply styles to all topic text When using a Word template for printed documentation ensure that all topic text has a style applied from an external style sheet Inline formatting does not map to...

Page 336: ...styles Mapped styles Non mapped styles are formatted as they appear in the Design Editor Style maps are saved in a ZPL file Heading styles For heading mapping to occur a standard HTML heading style mu...

Page 337: ...following styles aren t available for mapping Background Text BODY These style settings are applied inline Heading styles Unmapped styles denoted by Unassigned Use Style In Project in the Print Docum...

Page 338: ...le Description Preview a text description of a style 4 Under Microsoft Word Template Styles select the pop up menu to display template styles Microsoft Word Styles All Displays all styles in the templ...

Page 339: ...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 opt...

Page 340: ...change the appearance of Adobe AIR WebHelp and FlashHelp systems Skins apply to the left side of a window and the toolbar across the top of the output Customize the Help system by changing colors but...

Page 341: ...lder More Help topics Create custom skins for WebHelp and WebHelp Pro projects on page 337 Create custom skins for Adobe AIR projects on page 336 Add skins to the gallery Store or reuse skins across p...

Page 342: ...Skins folder 2 Right click a skin Select Compile Create custom skins for Adobe AIR projects Adobe AIR Help Skin Editor helps you create and edit skins for Adobe AIR projects 1 In the Project Set up p...

Page 343: ...s the same dimensions 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 down list and click Select To edit the curren...

Page 344: ...ick the Edit button to edit the button text or to place an image on the button Search Input Double click to edit the field that appears in the toolbar and the Search pane The button options apply to b...

Page 345: ...kin the next time you generate output To share a skin file SKN with others define all customizable elements of the skin beforehand so that other authors can include or exclude certain elements when th...

Page 346: ...FlashHelp skins from the Skin gallery 1 In the Single Source Layouts pod double click a FlashHelp layout 2 Click Gallery 3 Select a skin Click Preview to view it Then click OK to select it 4 Click Fin...

Page 347: ...ns WebHelp Pro provides the following options In WebHelp Pro and FlashHelp Pro you can view settings after the project is published to the server Buttons Click the up and Down Arrows to change button...

Page 348: ...created browse sequences Button Description Hide Show Opens and closes the navigation pane Back Opens the previous topic Forward Opens the next topic in a pre viewed sequence Stop Stops a web page fo...

Page 349: ...dden behind the open application Nav Pane Width Enter the width in pixels The width to assign depends on the number of window tabs Advanced Properties Specify advanced HTML windows properties on the D...

Page 350: ...EX_CONTROLPARENT Context Help Adds a clickable question mark to the title bar that changes the cursor to a question mark pointer Clicking in a child window then displays a WM_HELP message Window style...

Page 351: ...n pane clear the TOC Index and Search settings If you do not create a TOC or index clear the corresponding settings 1 Click Project 2 Double click the single source layout 3 Set options for the naviga...

Page 352: ...e click a layout that uses WebHelp Pro or HTML Help 3 In the Default Window menu select the custom window Remove a window 1 In the Project Set up pod expand the Windows folder 2 Right click a window S...

Page 353: ...t change or review comment To display the Review toolbar Select View Toolbars Review Enable the Track Changes mode To review a project in Design Editor open the project and edit the contents in the Tr...

Page 354: ...th drag and drop RoboHelp alerts you if you select a topic that is linked to Microsoft Word or FrameMaker document and the content is outdated Note An image map applied in a circle is converted as a h...

Page 355: ...from the selected menu item 1 Choose Comments Show Comment Markup Toolbar 2 Click Pause where you want to add a comment 3 Select the Sticky Note commenting tool and click the slide to add the comment...

Page 356: ...information about each comment or change Icon Displays an icon indicating a comment or the type of change for example inserted text and deleted text Reviewer Displays the reviewer name as configured i...

Page 357: ...Type Topic Path Select None to remove grouping Reply or set a status to a comment To reply to a comment right click the comment and select Reply To Review Comment Note RoboHelp displays the replies as...

Page 358: ...u can enable or disable moderation allow or disallow anonymous comments and choose to work online or offline with the ability to publish comments saved in offline mode Topic rating If you are deliveri...

Page 359: ...erver 9 3 User Launch the AIR Help application Click Show Hide Comments Pod and add comments See Add comments on page 354 and Moderate comments on page 354 Configure preferences for comments Users can...

Page 360: ...s By list Select an author name to filter comments by an author Comments For Current Topic Click to view comments on the current topic only Comments For All Topics Click to view comments on all topics...

Page 361: ...m on user systems ActiveX controls are not included in compiled CHM files For WebHelp and WebHelp Pro projects Internet Explorer 4 0 or later supports ActiveX controls Add design time controls Note Th...

Page 362: ...latest copy of the ActiveX control if it is not on the local system Data Source Provides an address URL that specifies where the ActiveX control searches to find any of its data arguments ID Displays...

Page 363: ...ames for several applets to communicate with each other Alt Text alternate text used if the browser cannot display the applet Parameters Name and value of parameters defining variable elements of an a...

Page 364: ...out the action of the form Method From the Method list select the method to use for sending form data to the server Post Sends the data through an HTTP post transaction Get Appends the arguments to t...

Page 365: ...d Control Identifier Indicates the name to associate with the field Not displayed on the form The CGI program uses it to identify the form element To include a label next to the text field type the te...

Page 366: ...orm of any entries made by the user Plain Button Lets you customize the action the button performs 3 In the Control Identifier box type the button name 4 In the Button Caption box type the button capt...

Page 367: ...bel next to the menu Rows Set how options display For example set to 1 to show one item at a time Allow Multiple Selections Lets users select multiple options 5 Set options on the Options tab New Lets...

Page 368: ...to the frame The selection appears in the Initial File field Design the frame specifying values for the height width frame margins and border color Specify the following options and then click Finish...

Page 369: ...the folder and click the New TOC Book or New TOC Page tool in the TOC toolbar 4 Enter a title to appear in the TOC and select Book With Link 5 Select a frameset from Existing Topics and click OK Link...

Page 370: ...button in the text field Image Inserts a BMP or an ICO file Click the folder button to browse to the file Select the file and copy it into the project Hidden Inserts a control that is not visible in t...

Page 371: ...tents 3 To test the control first generate the project The Table Of Contents control displays the same table of contents as in the final output You can link other contents files in the project Copy th...

Page 372: ...gray button with black text that performs the action Use the existing label or edit the text Image Inserts a custom image BMP or ICO as the button Hidden Inserts a control that is not visible in the...

Page 373: ...ontents tab in the HTML Help viewer users can customize books and pages that appear in the table of contents If you do not assign an information type to a topic the topic appears in the HTML Help view...

Page 374: ...out 1 In the Project Manager pod double click a table of contents in the Table Of Contents folder 2 In the TOC pod right click the book or page and select Properties 3 Click the Advanced tab 4 Select...

Page 375: ...he TOC pod right click the book or page and select Properties 3 Click the Advanced tab 4 From Information Types choose the topic folder 5 Click Remove to remove assignments Remove information types fr...

Page 376: ...nerate EclipseHelp on page 305 ePub Generator Use this script to generate ePub output For a step by step procedure see Generate output in the ePub format on page 305 Image Extension Updater Use this s...

Page 377: ...folder and scripts that display output in another folder Note The sample scripts are stored in the RoboHTML presets scripts folder of your RoboHelp 9 installation Drag folders You can drag folders int...

Page 378: ...hotspot style in the Styles dialog box 2 Expand Character styles to view the Drop down hotspot style 3 Click the Select Twisties Images button 4 Select an image to display closing drop down text and o...

Page 379: ...Task Keyboard shortcut Basic operations Open project CTRL O letter O Save All CTRL S Undo CTRL Z Redo CTRL Y Cut CTRL X Copy CTRL C Paste CTRL V Delete Delete button Close All Ctrl Alt X Select all CT...

Page 380: ...1 point CTRL Styles in Design Editor Apply a style CTRL SHIFT S Apply the Normal style CTRL SHIFT N Apply a Bullets or Numbering style CTRL SHIFT L Apply Heading 1 ALT CTRL 1 Apply Heading 2 ALT CTRL...

Reviews:

No comments