Adobe 65030089 User Guide - Page 232

Author and developer roles in creating context- sensitive Help, Map files and map IDs

Page 232 highlights

USING ROBOHELP HTML 9 226 Context-sensitive Help Author and developer roles in creating contextsensitive Help Author Developer Writes the Help topics that describe how to use application components such as windows, dialog boxes, fields, and controls. Builds the components (windows, dialogs, fields, controls) that make up the application. Imports map files and assigns map IDs to each context-sensitive Help topic. Communicates to the developer any unclear assignments or changes in assignments. or Creates map files and assigns map IDs to each context-sensitive Help topic. Exports map files to the development environment when complete and notifies the developer of any changes. Generates the map files that contain the map IDs and gives them to the author. or Obtains map files that contain the map IDs from the author. Generates the project to include the context-sensitive Help topics with the output. Writes code that calls the correct Help topics from within the application (based on map IDs included in the map files). Tests the context-sensitive topics in the application. Repairs errors in Notifies the author when changes are made to the application (or map the Help system. files) so that the Help project can be updated and regenerated. Repairs errors in the application code. On the Authoring home page of Peter Grainge's website, you can find information about four methods of calling WebHelp: • Using URLs • Using map IDs • Using map IDs in merged WebHelp • Using topic IDs Map files and map IDs About map numbers, map files, and map IDs Map number A numeric value associated with a topic ID. Map numbers and topic IDs are saved in map files. Map numbers are used with applications to specify a topic for calling context-sensitive Help. Whether application developers use map numbers, topics IDs, or both depends on the programming language they use. Map file A text file containing topic IDs and map numbers. You associate map IDs and map files with topics. As author, if you receive a map file from your developer, assign a map ID from the map file. If you manually create a map file, either auto-generate or manually create the map ID. A project can include multiple map files. Map files use the extensions .h, .hh, and .hm. The default map file is BSSCDefault.h. Map ID A string 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. Last updated 12/14/2011

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253
  • 254
  • 255
  • 256
  • 257
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276
  • 277
  • 278
  • 279
  • 280
  • 281
  • 282
  • 283
  • 284
  • 285
  • 286
  • 287
  • 288
  • 289
  • 290
  • 291
  • 292
  • 293
  • 294
  • 295
  • 296
  • 297
  • 298
  • 299
  • 300
  • 301
  • 302
  • 303
  • 304
  • 305
  • 306
  • 307
  • 308
  • 309
  • 310
  • 311
  • 312
  • 313
  • 314
  • 315
  • 316
  • 317
  • 318
  • 319
  • 320
  • 321
  • 322
  • 323
  • 324
  • 325
  • 326
  • 327
  • 328
  • 329
  • 330
  • 331
  • 332
  • 333
  • 334
  • 335
  • 336
  • 337
  • 338
  • 339
  • 340
  • 341
  • 342
  • 343
  • 344
  • 345
  • 346
  • 347
  • 348
  • 349
  • 350
  • 351
  • 352
  • 353
  • 354
  • 355
  • 356
  • 357
  • 358
  • 359
  • 360
  • 361
  • 362
  • 363
  • 364
  • 365
  • 366
  • 367
  • 368
  • 369
  • 370
  • 371
  • 372
  • 373
  • 374
  • 375
  • 376
  • 377
  • 378
  • 379
  • 380

226
USING ROBOHELP HTML 9
Context-sensitive Help
Last updated 12/14/2011
Author and developer roles in creating context-
sensitive Help
On the
Authoring home page of Peter Grainge’s website
, you can find information about four methods of calling
WebHelp:
Using URLs
Using map IDs
Using map IDs in merged WebHelp
Using topic IDs
Map files and map IDs
About map numbers, map files, and map IDs
Map number
A numeric value associated with a topic ID. Map numbers and topic IDs are saved in map files. Map
numbers are used with applications to specify a topic for calling context-sensitive Help. Whether application
developers use map numbers, topics IDs, or both depends on the programming language they use.
Map file
A text file containing topic IDs and map numbers. You associate map IDs and map files with topics. As
author, if you receive a map file from your developer, assign a map ID from the map file. If you manually create a map
file, either auto-generate or manually create the map ID. A project can include multiple map files. Map files use the
extensions .h, .hh, and .hm. The default map file is BSSCDefault.h.
Map ID
A string 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 topics that describe how to use application
components such as windows, dialog boxes, fields, and controls.
Builds the components (windows, dialogs, fields, controls) that make
up the application.
Imports map files and assigns map IDs to each context-sensitive Help
topic. Communicates to the developer any unclear assignments or
changes in assignments.
or
Creates map files and assigns map IDs to each context-sensitive Help
topic. Exports map files to the development environment when
complete and notifies the developer of any changes.
Generates the map files that contain the map IDs and gives them to
the author.
or
Obtains map files that contain the map IDs from the author.
Generates the project to include the context-sensitive Help topics
with the output.
Writes code that calls the correct Help topics from within the
application (based on map IDs included in the map files).
Tests the context-sensitive topics in the application. Repairs errors in
the Help system.
Notifies the author when changes are made to the application (or map
files) so that the Help project can be updated and regenerated. Repairs
errors in the application code.