Adobe 65030089 Scripting Guide - Page 17

autoCreateBrowseSequence, importHtmlFile

Page 17 highlights

Parameter name bodyFooter Data type String Optional Yes xslFile String Yes indexShow Boolean Yes autoCreateBrowseSequence Description Creates browse sequences based on a specified TOC. Returns Boolean Syntax autoCreateBrowseSequence (TOC object, level) Parameters Parameter name TOC object Data type TOC Optional Yes level Integer Yes importHtmlFile Description Imports an HTML file into the current project. Returns Boolean Syntax importHtmlFile (filePath,folderName) Parameters Parameter name filePath folderName Data type String String Optional No No ROBOHELP 8 SCRIPTING GUIDE 13 Classes Description Full path to the file containing XHTML to place in the body running-footer area of the output file. Full path to the XSL file that is used instead of the default XSL file to transform topics to XHTML Use this option to show or hide index entries Description A TOC object on which the browse sequences will be based. If not specified, the default TOC of the project is used. Creates a separate sequence for each book down to this level. If not specified, the last set value is used. Description Absolute path of the HTML file to import Relative path of the folder in the current project in which the HTML file is to be imported

  • 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

13
ROBOHELP 8 SCRIPTING GUIDE
Classes
autoCreateBrowseSequence
Description
Creates browse sequences based on a specified TOC.
Returns
Boolean
Syntax
autoCreateBrowseSequence (TOC object, level)
Parameters
importHtmlFile
Description
Imports an HTML file into the current project.
Returns
Boolean
Syntax
importHtmlFile (filePath,folderName)
Parameters
bodyFooter
String
Yes
Full pat
h
to t
h
e file containing XHTML to place
in t
h
e body running-footer area of t
h
e output
file.
xslFile
String
Yes
Full pat
h
to t
h
e XSL file t
h
at is used instead of
t
h
e default XSL file to transform topics to
XHTML
indexShow
Boolean
Yes
Use t
h
is option to s
h
ow or
h
ide index entries
Parameter name
Data type
Optional
Description
TOC object
TOC
Yes
A TOC object on w
h
ic
h
t
h
e browse sequences
will be based. If not specified, t
h
e default TOC
of t
h
e project is used.
level
Integer
Yes
Creates a separate sequence for eac
h
book
down to t
h
is level. If not specified, t
h
e last set
value is used.
Parameter name
Data type
Optional
Description
filePath
String
No
Absolute pat
h
of t
h
e HTML file to import
folderName
String
No
Relative pat
h
of t
h
e folder in t
h
e current
project in w
h
ic
h
t
h
e HTML file is to be
imported
Parameter name
Data type
Optional
Description