Adobe 65030089 User Manual - Page 82

Topic name basics, Completeness of content in the topic, Drop-down text, Style-based pagination

Page 82 highlights

USING ROBOHELP HTML 10 76 Projects Follow these guidelines for paginating a document: Completeness of content in the topic Ensure that the topic generated contains relevant and complete information for the reader. For example, if you set pagination for Heading 3 level paragraph, it is possible that the topic contains only the task information, without the required contextual information 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-down text Ensure that the paragraph format for the drop-down text body is not set for pagination. The paragraphs applied with this format must accompany the drop-down text caption paragraph format. See "Optimizing for online output before conversion" on page 63. Topic name basics When you set heading styles for pagination, the heading text becomes the default filename for the topic file created in RoboHelp. For example, suppose you define Heading 2 for pagination, and the FrameMaker document has two Heading 2 topics, "Introduction" and "Beyond basics." In this case, RoboHelp creates the topics Introduction and Beyound basics with filenames introduction.htm and beyond_basics.htm. Thus, you get intuitively named HTML files that indicate the topic title. RoboHelp supports various ways to customize topic names in the following scenarios: Style-based pagination Topics are named according to the pattern you select in the Other Settings tab of the Conversion Settings dialog box. You can select one of the following or create a topic name pattern using the Topic Name Pattern building blocks provided by RoboHelp. In addition, you can add static text, such as "HelpTopic," followed by to create topics such as HelpTopic 1, HelpTopic 2, and so on. Topic name pattern default - - Description HTML topic generated has the paragraph text as the topic title and the filename. HTML topic generated has the filename consisting of the filename of the FrameMaker document without the .fm extension and the paragraph text, separated by a hyphen. For example, the FrameMaker document named "Chapter.fm" with "1-Introduction" as paragraph text is converted to an HTML topic with the title "Chapter-1-Introduction" and the filename "Chapter-1-Introduction.htm" HTML topic generated has the filename consisting of the filename of the FrameMaker document without the .fm extension and the paragraph number separated by a hyphen. For example, the FrameMaker document "Chapter.fm" is converted to an HTML topic with the title "Chapter-1" and the filename "Chapter-1.htm" HTML topic generated has the filename consisting of the paragraph text of the paragraph format at which pagination is set, without the paragraph number. For example, a heading 1 paragraph "1. Introduction" is converted to an HTML topic with the title "Introduction" and the filename "Introduction.htm" HTML topic generated has the filename consisting of the paragraph text of the paragraph format on which pagination is set. For example, a heading 1 paragraph "Introduction" is converted to an HTML topic with the same title and the filename "Introduction.htm" Marker-based pagination To name topics based on the marker used for pagination, configure each marker in the FrameMaker document and specify the filename and title as marker text in the filename | title format. Note: Both filename and title are optional. If you do not specify a filename (for example, you specify | ), RoboHelp creates a valid filename from the title. If you do not specify a title (for example, you specify ), RoboHelp creates the title from the topic name pattern. If marker text is empty, RoboHelp uses the topic name pattern to create the topic title and a valid filename. Last updated 7/13/2012

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

76
USING ROBOHELP HTML 10
Projects
Last updated 7/13/2012
Follow these guidelines for paginating a document:
Completeness of content in the topic
Ensure that the topic generated contains relevant and complete information for
the reader. For example, if you set pagination for Heading 3 level paragraph, it is possible that the topic contains only
the task information, without the required contextual information 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-down text
Ensure that the paragraph format for the drop-down text body is not set for pagination. The
paragraphs applied with this format must accompany the drop-down text caption paragraph format. See “
Optimizing
for online output before conversion
” on page
63.
Topic name basics
When you set heading styles for pagination, the heading text becomes the default filename for the topic file created in
RoboHelp. For example, suppose you define Heading 2 for pagination, and the FrameMaker document has two
Heading 2 topics, “Introduction” and “Beyond basics.” In this case, RoboHelp creates the topics Introduction and
Beyound basics with filenames introduction.htm and beyond_basics.htm. Thus, you get intuitively named HTML files
that indicate the topic title.
RoboHelp supports various ways to customize topic names in the following scenarios:
Style-based pagination
Topics are named according to the pattern you select in the Other Settings tab of the
Conversion Settings dialog box. You can select one of the following or create a topic name pattern using the Topic
Name Pattern building blocks provided by RoboHelp. In addition, you can add static text, such as “HelpTopic,”
followed by <n> to create topics such as HelpTopic 1, HelpTopic 2, and so on.
Marker-based pagination
To name topics based on the marker used for pagination, configure each marker in the
FrameMaker document and specify the filename and title as marker text in the filename | title format.
Note:
Both filename and title are optional. If you do not specify a filename (for example, you specify | <title>), RoboHelp
creates a valid filename from the title. If you do not specify a title (for example, you specify <filename>), RoboHelp creates
the title from the topic name pattern. If marker text is empty, RoboHelp uses the topic name pattern to create the topic
title and a valid filename.
Topic name pattern
Description
default
HTML topic generated has the paragraph text as the topic title and the filename.
<$filename_no_ext>-<$paratext>
HTML topic generated has the filename consisting of the filename of the FrameMaker
document without the .fm extension and the paragraph text, separated by a hyphen. For
example, the FrameMaker document named “Chapter.fm” with "1-Introduction" as paragraph
text is converted to an HTML topic with the title "Chapter-1-Introduction” and the filename
"Chapter-1-Introduction.htm”
<$filename_no_ext>-<n>
HTML topic generated has the filename consisting of the filename of the FrameMaker
document without the .fm extension and the paragraph number separated by a hyphen. For
example, the FrameMaker document "Chapter.fm" is converted to an HTML topic with the
title “Chapter-1” and the filename "Chapter-1.htm"
<$paratext_no_num>
HTML topic generated has the filename consisting of the paragraph text of the paragraph
format at which pagination is set, without the paragraph number. For example, a heading 1
paragraph "1. Introduction" is converted to an HTML topic with the title “Introduction” and
the filename "Introduction.htm"
<$paratext>
HTML topic generated has the filename consisting of the paragraph text of the paragraph
format on which pagination is set. For example, a heading 1 paragraph "Introduction" is
converted to an HTML topic with the same title and the filename "Introduction.htm"