public class HelpIndexBuilder extends Object
org.eclipse.help.toc
extensions in the provided manifest file.
Search index is only created if index path is specified in the extension.
Index will contain data for all the topics listed in all the TOCs declared in
the plug-in.
If the index is created for a fragment, the manifest must point at the referenced fragment plug-in, while the destination should be the fragment itself.
Starting from the provided destination directory, index for each locale will be placed in a directory with the following path:
destination/nl/country/ or destination/nl/country/language/
The relative directory specified in the index
element of the
org.eclipse.help.toc
extention will be created in each of the
locale-specific paths (one per locale).
An instance of HelpIndexBuilder
can be cached and used
multiple times for different manifest and destination values.
Constructor and Description |
---|
HelpIndexBuilder()
Creates a new instance of the help index builder.
|
Modifier and Type | Method and Description |
---|---|
void |
execute(IProgressMonitor monitor)
Creates the plug-in search index by parsing the provided plugin.xml file,
looking for TOC extensions.
|
File |
getDestination()
Returns the destination directory where index should be created.
|
File |
getManifest()
Returns the manifest file for this builder.
|
void |
setDestination(File destination)
Sets the destination directory where index should be created.
|
void |
setManifest(File manifest)
Sets the new manifest file (plugin.xml) to be used by this builder.
|
public HelpIndexBuilder()
public File getManifest()
plugin.xml
file. If the target
is a fragment, it is the absolute path of plugin.xml
of
the fragment plug-in.public void setManifest(File manifest)
plugin.xml
file. If the target is a fragment, it is the
absolute path of plugin.xml
of the fragment plug-in.manifest
- the file that contains TOC extensionspublic File getDestination()
public void setDestination(File destination)
destination
- the directory where index should be createdpublic void execute(IProgressMonitor monitor) throws CoreException
index
element, all topics listed in all the TOCs in the
plug-in will be indexed and stored in the path specified by the
index
element.monitor
- the monitor to track index creation progressCoreException
- if there are problems during index creation.
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.