Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: b17633afa22c1b72a802bb9a3c749434d18292c4 (plain) (blame)
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
#####################
# Layout of help view
#####################

# Location of the banner page to display in the top frame.
# Example: banner=/org.eclipse.help.webapp/advanced/banner.html
banner=

# Height of the banner frame
# Example: banner_height=60
banner_height=

# Location of the footer page to display in the bottom frame.
# Example: footer=/org.eclipse.help.webapp/advanced/banner.html
footer=

# Height of the footer frame
# Example: footer_height=60
footer_height=

# The page to show in the content area when opening help.
# Specify your html page as /pluginId/path/to/home.html.
# Currently, the default home is /org.eclipse.help/doc/help_home.html.
help_home=/org.eclipse.help.base/doc/help_home.html

# The page to show in the content area when a topic file cannot be opened
# If this variable is not specified the browser will show it's default 404 error page
page_not_found=/org.eclipse.help.base/doc/page_not_found.html

##############################
# css/presentation
##############################

# The css files below can each contain zero or more comma separated paths of the form /plugin/path
# If the string contains ${os} then that will be replaced with the name of the OS
# Any other parameters of the form ${parameter} are reserved for future use

# The css file to include in every non navigation page served by the help system 
topic_css=

# The css file to include in every navigation page generated by the help system 
nav_css=/PRODUCT_PLUGIN/book.css

# The css file to include in every page displayed in the help view or help tray 
narrow_css=/PRODUCT_PLUGIN/narrow_book.css,/PRODUCT_PLUGIN/${os}_narrow_book.css

# The css file to include in every disabled page served by help system 
disabled_css=/PRODUCT_PLUGIN/disabled_book.css

# Set to true or false to control the visibility of the index view.
indexView=true

# Set to true or false to control the visibility of the bookmarks view.
# Note: this option has no effect in the infocenter.
bookmarksView=true

# Set to true or false to control the title of the browser window.
# If true, the title will have a form "Help - <PRODUCT_NAME>",
# otherwise the title will be "<PRODUCT_NAME>", where <PRODUCT_NAME>
# is the name of Eclipse product set in the primary feature.
windowTitlePrefix=true

##############################
# Style of help view
##############################

# Directory containing images used in the help view.
# Images must have the same name as those in the org.eclipse.help.webapp
# plug-in.
# Use the /pluginID/directory format.
imagesDirectory=images

showBreadcrumbs=true

# CSS background for toolbars.
# Value is used in browsers that display advanced help UI.
advanced.toolbarBackground=ButtonFace

# CSS background for navigation views.
# Value is used in browsers that display advanced help UI.
advanced.viewBackground=

# CSS font for toolbars.
# Value is used in browsers that display advanced help UI.
advanced.toolbarFont=icon

# CSS font for navigation views.
# Value is used in browsers that display advanced help UI.
advanced.viewFont=icon

# Initial value for whether toc is synchronized with contents
advanced.syncDefault=true

# Background color for toolbars.
# Value is used in browsers displaying basic help UI.
basic.toolbarBackground=#D4D0C8

# Background color for navigation views.
# Value is used in browsers displaying basic help UI.
basic.viewBackground=#FFFFFF

######################
# Infocenter languages
######################

# List of locales that infocenter will recognize and provide a customized
# content for; if locales (or languages) accepted by client browser are not
# matched with any locales in this list, the browser will be served content for
# default locale - the server locale, or locale specified by eclipse -nl command
# line option; if list is not specified, the browser will be served contents
# for its preferred locale;  note: not providing this option may result in a
# large memory and disk space requirements as navigations and indexes will be
# created for each distinct preferred locale among browsers accessing the
# infocenter.
# Example: locales=en ja zh_CN zh_TW
locales=

###############################
# Pre-built documentation index
###############################

# If pre-built documentation index is provided with the product, the ID of
# the plug-in delivering the index must be specified to the help system here.
#productIndex=com.my.plugin

######################
# Browsers
######################
# Use embedded when possible (on Windows or Linux), or always external.  Setting
# to true will force use of external browser.  Option has no effect if embedded
# browser is not available on a given platform.
#always_external_browser=

# Default external browser.  ID of one of the external web browsers contributed
# to org.eclipse.help.base.browser extension point that help system will use.
# The browser's adapter available() method must return true on the current
# system.
#default_browser=

# Executable path for custom browser
#custom_browser_path=

######################
# Display of topics from disabled capabilities
######################
# Help system filters topics from disabled capabilities.  This option controls
# this behavior and existence of  Show All Topics button.
# 
# Accepted values: never, off, on, always
#  never - topic from disabled capabilities are not shown
#  off - user can choose to show all topics, disabled topics initially hidden
#  on - user can choose to show all topics, all topics initially shown
#  always - topic from disabled capabilities are shown (filtering disabled)
showDisabledActivityTopics=off

######################
# Active (live) help disabling
######################
# Allows enabling and disabling execution of active help
# The option has no effect in the infocenter setup, where active help is
# disabled.
# Accepted values:
#  true - default active help actions enabled
#  false - active help framework disabled
activeHelp=true

#########################
# Remote help
#########################
remoteHelpOn=false
remoteHelpName=
remoteHelpHost=
remoteHelpPath=
remoteHelpUseDefaultPort=
remoteHelpPort=
remoteHelpICEnabled=
#########################
# Internal
#########################

indexInstruction=true
indexButton=true
indexPlusMinus=true
indexExpandAll=false
highlight-on=true

#########################
# Infocenter Security
#########################
# Increases security  by preventing urls referencing external sites from being passed
# in as the topic parameter. 
restrictTopicParameter=true

########################
# Properties defined for Quick Print
########################
# Max connection numbers for concurrent print(print selected topic and all subtopics)
# Assign a value no greater than Integer.MAX_VALUE
# Assign nothing to accept the default settings of the application
# Example: maxConnections=
maxConnections=10

# Max topic numbers allowed for print in one request
# Assign a value no greater than Integer.MAX_VALUE
# Assign nothing to accept the default settings of the application
# Example: maxTopics=
maxTopics=500

Back to the top