Home » Adobe Manuals » Computer Software » Adobe 65030089 » Manual Viewer

Adobe 65030089 User Manual - Page 250

Information for developers, Program Help for Visual Basic applications

UPC - 883919170626

Add to My Manuals
Save this manual to your list of manuals

Page 250 highlights

USING ROBOHELP HTML 10 244 Context-sensitive Help 7 Click OK. Information for developers The API shares parameters with HTML Help and WinHelp. You can create custom dialog boxes. Note: "Custom dialog boxes" refers to the feature that the projects using these APIs have to create their own dialog boxes based on their requirements. Call your Help projects with the function RH_ShowHelp. The source code for this function is contained in the support files which you import into your development project. Languages supported are Visual Basic, C/C++, JavaScript, and Java. The files are in C:\Program Files\Adobe\Adobe RoboHelp [version]\CSH API. The files are: • CSH API\RoboHelp_CSH.vb (Visual Basic) • CSH API\RoboHelp_CSH.cpp (C/C++, dependent on the .h) • CSH API\RoboHelp_CSH.h (C/C++, dependent on the .cpp) • CSH API\RoboHelp_CSH.js (Web pages - HTML/JavaScript) • CSH API\RoboHelp_CSH.java (Java applications) RH_ShowHelp has four parameters as shown in the following table: Parameter hParent a_pszHelpFile uCommand dwData Description Handle to calling dialog HTML Help Only: This parameter closes the Help dialog when the calling window is closed. Help Source (depends on the Output type) For Webhelp/FlashHelp: "Path to project start page" For Webhelp Pro: "http:///roboapi.asp" For HTML Help: "Path to .CHM file". To specify a dialog, use ">WindowName" at the end of the parameter. Constants: HH_DISPLAY_INDEX Displays Index pane and default topic. HH_DISPLAY_SEARCH Displays Search pane and default topic. HH_DISPLAY_TOC Displays Contents pane and default topic. HH_HELP_CONTEXT Opens topic associated with map ID in dwData parameter. To obtain the map ID, export the map file for the programming language. Use HH_HELP_CONTEXT in the uCommand parameter. Program Help for Visual Basic applications This information is for developers connecting context-sensitive Help topics to Visual Basic applications. 1 Open the project in Visual Basic. 2 If the map files were created in RoboHelp, ask the 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 Microsoft Internet Controls. Last updated 7/13/2012

Section	Page
Legal notices	2
Contents	3
Chapter 1: Getting started	7
Basic workflow	7
Activation and registration	8
Install the software	8
Help with installation	8
License activation	8
Register	8
Adobe Product Improvement Program	8
Help and support	9
Adobe Community Help	9
Services, downloads, and extras	10
Adobe Exchange	10
Adobe downloads	10
Adobe Labs	10
Adobe forums	10
Adobe TV	10
RoboHelp sample projects and output	11
RoboHelp Developer Center	11
Previous RoboHelp Help	11
What’s new in RoboHelp 10	11
Authoring enhancements	11
Import and linking enhancements	12
Review and collaboration features	13
Publishing features	13
Usability and productivity features	17
About RoboHelp Server	18
Chapter 2: Exploring the workspace	20
Workspace overview	20
Working with pods	21
View a pod	21
Arrange pods	21
Types of pods	21
Starter pod	21
Project Manager pod	22
Project Set-up pod	22
Snippets pod	22
Styles And Formatting pod	23
User Defined Variables pod	23
Error List pod	23
Output View pod	23
Toolbox pod	23
Resource Manager pod	24
RoboHelp Server pod	24
Environments	24
Create and save an environment	24
Load an environment	24
Restore the default environment	25
Delete an environment	25
Menus and toolbars	25
Customize menus	25
Customize toolbars	25
Enable and disable smart menus	26
Create or remove keyboard shortcuts	26
Create keyboard shortcuts	26
Remove or reset keyboard shortcuts	26
Configure general settings	27
Set the default language and other preferences	27
Enable or disable confirmation	27
Enable, disable, or reset notifications	28
Chapter 3: Projects	29
Project basics	29
About projects	29
Help project components	29
Files in a project	30
Main project file (XPJ)	30
Folder files (FPJ)	30
Single-source layout files (SSL)	30
Auxiliary project files (APJ)	30
Other types of files	31
About output types	31
End-user viewer requirements	32
Create and manage projects	32
Create a project	32
Create a project by importing documents	34
Save projects	35
Disable auto-save	35
Opening a project	35
Open a project when starting RoboHelp	35
Open a project after starting RoboHelp	36
Upgrading a project	36
Pin a project to the list of recently opened projects	36
Change project settings	36
Rename a project	38
Viewing projects	38
Define chapter layout	39
Manage files	39
List topics by title or filename	39
Using the To Do list	39
Edit the list of recently opened projects	40
Add files to the Baggage folder	40
Remove files from the Baggage folder	41
Map file types	41
Remove topics from projects	41
Manage folders	42
Create folders	42
Project Manager folders	42
Rename folders	43
Move folders	43
Remove custom folders	43
File and folder icons	43
Authoring content in multiple languages	45
Support for multiple languages	46
Translation workflows	47
Compare content in different languages	48
Select a different language for translating a project file	48
Create a project with a different language	48
Customizing text for localization	48
Edit the LNG (language) file	49
Change the default project language	49
Language support for associated dictionaries	50
Index localized text	50
Universal character sets	50
Support for Unicode text encoding standards	50
Set up input languages on Windows	51
Upgrade localized projects	51
Import PDF files	52
Create a project by importing a PDF file	52
Import PDF files into a project	53
Importing and linking Word and FrameMaker documents	53
Importing and linking Microsoft Word documents	54
Linking versus importing Word documents	54
Optimizing Word documents for online output	55
Linking options for Word documents	56
Link and import Word documents	56
Create a project by importing a Word document	57
Link a Word document to a RoboHelp project	57
Import a Word document into a RoboHelp project	57
Importing a Word TOC, index, and glossary	58
Convert headers and footers in Word documents	59
Converting Word styles to RoboHelp styles	59
Select CSS for style mapping	59
Convert Word paragraph styles to RoboHelp styles	60
Convert Word character styles to RoboHelp styles	60
List mapping	61
Create custom HTML tags	61
Convert Word table styles to RoboHelp table styles	61
Convert Word references to hyperlinks	62
Create RoboHelp styles from inline formatting	62
Pagination and topic naming in converted Word files	62
Set pagination for online Help topics	62
Convert context-sensitive Help markers in Word to map IDs	63
Define the topic name pattern for generated topics	63
Synchronizing linked Word documents with RoboHelp projects	64
Word document synchronization status indicators	65
Generate topics from linked Word documents	65
Update topics generated from linked Word documents	65
Preserve changes to a topic during an update	66
Delete a generated topic	66
Regenerate a deleted topic	67
Edit a linked Word document	67
Delete a linked Word document	67
Restore a link to a missing or renamed Word document	67
Word conversion settings	67
Export conversion settings	68
Import conversion settings to a project	68
Word document components converted to RoboHelp	68
Importing FrameMaker documents	69
Optimizing for online output before conversion	69
Preparing FrameMaker documents for conversion to Help	70
Importing FrameMaker documents	71
Create a RoboHelp project by importing FrameMaker books or documents	71
Import a FrameMaker book into a new RoboHelp project	71
Import FrameMaker documents into an existing RoboHelp project	71
FrameMaker document components converted to RoboHelp	72
Conversion basics	74
Convert a FrameMaker TOC	74
Import FrameMaker index entries	74
Import glossary definitions	75
Apply conditions from a Ditaval file	75
Converting FrameMaker formats to RoboHelp styles	75
Select a FrameMaker template for conversion	75
Select the CSS for style mapping	76
Automap	76
Upgrading from RoboHelp 7 to RoboHelp 10	78
Hierarchical structure in a FrameMaker 9 book	79
Convert FrameMaker cross-reference formats to RoboHelp styles	80
Content reference	80
Conversion settings	80
Setting pagination and topic names	81
Convert context-sensitive Help markers from FrameMaker documents	83
Apply FrameMaker conditional text build expressions	83
Converting FrameMaker content	84
Convert FrameMaker paragraph formats to RoboHelp styles	84
Convert FrameMaker character formats to RoboHelp styles	84
Exclude a FrameMaker paragraph format from Help topics	85
Custom HTML tags	85
Autonumber style mapping	85
List-mapping scenarios	85
Convert FrameMaker table formats to RoboHelp table styles	87
Image conversion settings	87
Preserve converted images	88
Create alternate text for images	89
Import a DITA map file	89
Import XML files	90
Import Microsoft HTML Help projects	92
Import WinHelp projects	92
Import WinHelp Project settings	92
WinHelp folder import options	93
Folder for HTML files	93
Folders for images	93
File options	93
WinHelp formatting import options	93
WinHelp general import options	94
Navigation pane	94
Default pane	94
Advanced	94
HLP and HPJ files	95
HTML projects from WinHelp: Frequently asked questions	95
Import a WinHelp HLP file into an HTML project	96
HTML limitations with HLP files	97
Tips for creating HTML projects with HLP files	98
Import a WinHelp HPJ file into an HTML project	98
Tips for creating HTML projects with HPJ files	99
Adding projects to version control	99
About version control	99
Apply version control	100
Version control FAQs	101
Add a RoboHelp project to version control	102
File checkin/checkout	102
Version control with Microsoft SharePoint	103
Configure RoboHelp settings for SharePoint	103
Configure SharePoint document library settings	103
Add a project to a SharePoint document library	104
Merging Help projects	104
About merged Help projects	104
Create a master project	105
Publish child projects	106
View merged Help projects	107
Remove merged child projects	107
Customize merged WebHelp/FlashHelp Pro projects	108
FAQs about merging projects	108
Reports	110
Export project reports	110
Print reports	111
Send reports	111
Generate and customize reports	111
Broken links report	111
Conditional Build Tag report	111
See Also report	112
Index report	112
Duplicate Map IDs report	112
External Topics report	112
Glossary report	113
Images report	113
Map IDs report	113
Project Status report	113
Snippets report	113
Style Sheets report	114
Table Of Contents report	114
Topic Properties report	114
Topic References report	114
Topics By Priority report	114
Unreferenced Topics report	115
Unused files report	115
Unused index keywords report	115
Used Files report	115
Missing topics report	115
Variables report	116
Reference	116
URL Properties dialog box	116
Delete Old Project dialog box	116
Move File Into Project dialog box	116
Help to HTML style options	116
HTML Help Advanced Settings tri-pane	117
Buttons	117
Navigation pane	117
Font	117
HTML Help Advanced Settings TOC tab	117
Chapter 4: Working with topics	118
Create, save, and open topics	118
Create a topic	118
Save topics	119
Save a topic	119
Enable or disable Save	119
Rename topic files	119
Open topics	119
Support for multiple document interfaces	120
Author in XHTML	120
Convert XHTML to HTML	120
Validate XHTML	121
Import and copy topics	121
Import topics	121
Copy topics into a project	121
View topics and design elements	122
Preview topics	122
Define a conditional build expression	122
View design elements	123
Master pages	123
Create a master page	124
Create a master page from a topic	124
Formatting master pages	125
Edit a master page	125
Change the CSS associated with a master page	125
Insert a placeholder	125
Format and edit placeholders	126
Importing master pages	126
Applying master pages	126
Apply a master page to a topic	126
Apply a master page to multiple topics	126
Applying a master page or CSS at the time of generation	127
Manage topics	127
Rename a topic	127
Update topic references	128
Add underscores to filenames	128
Change topic properties	128
Find a topic	129
Assign a default topic	130
Track topic status	130
View and manage topic details in the Topics List pod	131
Work with the Tag list	131
Managing resources	131
About Resource Manager	131
Configure Resource Manager settings	132
Manage shared resources in the Resource Manager pod	133
Add a shared location	133
Add a category	133
Show or hide contents in the Resource Manager pod	133
Maintain shared resources	133
Manage linked resources	134
Check spelling and find and replace	135
Check spelling in the TOC, index, see also list, or glossary	135
Specify spelling options	136
Check spelling in topics or projects	136
Customize a dictionary	137
Use the thesaurus	138
Find and replace text in a topic	138
Find options	139
Find and replace options	139
Find and replace text in files	140
Set Find and Replace options	140
Viewing Find results	141
W3C compliance	142
Reference	142
General pane for Oracle projects	142
Chapter 5: Editing and formatting	143
RoboHelp editors	143
RoboHelp Design Editor	143
RoboHelp HTML Editor	143
Open RoboHelp HTML Editor	143
Undo a change	143
View line numbers	143
Add keyword expansions	143
Change code color	144
Third-party HTML editors	144
Using RoboHelp with other HTML editors	144
Add an HTML editor	144
Remove or rename an HTML editor	145
Auto-select an HTML editor or set a default	145
Specify an editor for new topics	146
Character formatting and fonts	146
Apply or remove character formatting	146
Apply color to text	146
Define advanced font options	146
Change character spacing	147
Change font size	147
Create a font set	147
Apply a font set to text	147
Change font sets	147
Remove font sets	147
Insert symbols and special characters	148
Insert a non-breaking space	148
Format paragraphs	148
Align paragraphs	148
Indent paragraphs	148
Indent text lines	148
Change margins	149
Change the unit of measure for the ruler	149
Define a language for a paragraph	149
Apply text wrapping	149
Adjust line spacing	150
Add line breaks to paragraphs	150
Borders, backgrounds, color, and sound	150
Add or edit borders and backgrounds in topics	150
Add borders to images	150
Remove borders or backgrounds	151
Add or delete horizontal lines	151
Add a horizontal line	151
Delete a horizontal line	151
Modify colors	151
Remove colors	152
Add sound to topics	152
Tables	152
About tables	152
Workflow for creating a table	153
Insert tables	153
Insert a basic table	153
Insert a custom table	153
Inserting tables within tables	153
Copy and paste tables	153
Edit tables	154
Insert table rows or columns	154
Edit table properties	154
Set autofit table properties	154
Edit cell properties	154
Edit spacing within cells	154
Merge or split table cells	155
Lists	155
Indent lists	155
Apply bullet styles	155
Match bullet color to text	156
Remove bullets and numbering	156
Apply a numbering format	156
Add a paragraph within a list	157
Restart or continue numbering or lettering	157
Headers, footers, and page breaks	157
Headers and footers	157
Create or edit headers and footers	157
Remove headers and footers	158
Insert page breaks	158
Text boxes	158
Insert text boxes in topics	158
Layer positioned text boxes	158
Change text box properties	159
Remove text boxes from a topic	159
User-defined variables	159
Create a user-defined variable	159
Create a variable set	160
Edit a user-defined variable	160
Format a user-defined variable	160
Insert a user-defined variable	161
View properties of a user-defined variable	161
Delete a user-defined variable	161
Rename a user-defined variable	161
Single-source with snippets	162
Create and manage snippets	162
Insert a snippet in a topic	163
Insert a snippet in a drop-down text editor	163
Applying conditional build tags to a snippet	163
Inserting variables in snippets	163
Convert a snippet to text	163
Delete a snippet	163
Reference	164
META tags default editor	164
Chapter 6: Styles and style sheets	165
Style types	165
Media rules and attributes in styles	165
Define media-specific styles in a style sheet	165
Add a media rule in topic styles	166
Link media-specific CSSs to a topic and add media attributes in HTML	166
Map styles in Word/FrameMaker content to media-specific styles	166
View content in media-specific styles in Design view	166
Delete a media-specific style	166
Media queries	167
Manage media queries for screen profiles	167
Manage style sheets	167
Link a style sheet to topics or master pages	167
Unlink a style sheet from topics or master pages	168
Create a style sheet	168
Create a style sheet and topic simultaneously	168
Export a style sheet	168
Create styles for style sheets	169
Create a style in the Styles dialog box	169
Create a style using the Styles And Formatting pod	169
Create a style using the Design Editor	169
Table styles	170
Global table styles	170
Apply table styles	170
Create and manage table styles	170
Create table styles	170
Apply conditional build tags to tables	171
List styles	171
About list styles	171
Create HTML lists	172
Create multilevel lists	172
Create an autonumbering style	172
Create a sequencing prefix	173
Edit a sequencing prefix	173
Delete a custom sequence	173
HTML styles	173
Create styles based on Div, Hyperlink, and Image styles	174
Edit Div styles	174
Edit Hyperlink styles	174
Edit Image styles	175
Apply styles	175
Edit styles in CSS files	175
Edit a style using the Styles dialog box	175
Edit a style using the Styles And Formatting pod	176
Delete styles from style sheets	176
Use color and images	176
Change text and link colors in a style sheet	176
Add or edit borders or backgrounds in style sheets	177
Inline styles	177
Apply or edit inline styles	177
Remove inline styles from text	177
Reset styles	178
Clear formatting	178
Chapter 7: TOCs, indexes, glossaries	179
TOCs	179
TOC basics	179
About TOCs	179
Create TOCs	179
Print TOCs	179
Create TOC books and pages	180
Create TOC books	180
Create TOC books and pages with targeted links	180
Create TOC books from pages	180
Create TOC pages by dragging	180
Create TOC books and pages with user-defined variables	181

Match case Limit results 1 per page

244

USING ROBOHELP HTML 10

Context-sensitive Help

Last updated 7/13/2012

Click OK.

Information for developers

The API shares parameters with HTML Help and WinHelp. You can create custom dialog boxes.

Note:

"Custom dialog boxes" refers to the feature that the projects using these APIs have to create their own dialog boxes

based on their requirements.

Call your Help projects with the function

RH_ShowHelp

. The source code for this function is contained in the support

files which you import into your development project. Languages supported are Visual Basic, C/C++, JavaScript, and

Java. The files are in C:\Program Files\Adobe\Adobe RoboHelp

[version]

\CSH API. The files are:

•

CSH API\RoboHelp_CSH.vb (Visual Basic)

•

CSH API\RoboHelp_CSH.cpp (C/C++, dependent on the .h)

•

CSH API\RoboHelp_CSH.h (C/C++, dependent on the .cpp)

•

CSH API\RoboHelp_CSH.js (Web pages - HTML/JavaScript)

•

CSH API\RoboHelp_CSH.java (Java applications)

RH_ShowHelp has four parameters as shown in the following table:

Program Help for Visual Basic applications

This information is for developers connecting context-sensitive Help topics to Visual Basic applications.

Open the project in Visual Basic.

If the map files were created in RoboHelp, ask the Help system author to export the map files from RoboHelp to

Visual Basic.

Include RoboHelp_CSH.vb with your project. The function

RH_ShowHelp

is defined in RoboHelp_CSH.vb.

Add a reference to the Microsoft Internet Controls.

Parameter

Description

hParent

Handle to calling dialog HTML Help Only: This parameter closes the Help dialog when the calling window is

closed.

a_pszHelpFile

Help Source (depends on the Output type)

For Webhelp/FlashHelp: "Path to project start page"

For Webhelp Pro: "http://<ServerName>/roboapi.asp"

For HTML Help: "Path to .CHM file". To specify a dialog, use ">WindowName" at the end of the parameter.

uCommand

Constants:

HH_DISPLAY_INDEX

Displays Index pane and default topic.

HH_DISPLAY_SEARCH

Displays Search pane and default topic.

HH_DISPLAY_TOC

Displays Contents pane and default topic.

HH_HELP_CONTEXT

Opens topic associated with map ID in

dwData

parameter.

dwData

To obtain the map ID, export the map file for the programming language. Use

HH_HELP_CONTEXT

in the

uCommand

parameter.