diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_api_overview.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_api_overview.htm
index a81a49a5eb4..075cfdbf86f 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_api_overview.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_api_overview.htm
@@ -1,12 +1,10 @@
-
+
-
-
-
+
+
Overview of the p2 API
@@ -132,7 +130,7 @@
Queries and Queriables
a query is a collection of all of the IUs that meet the criteria of the query.
Queries can be created in multiple ways.
The simplest way is to create a query using the QueryUtil. The following snippet creates a query that
-searches for all IUs that have the ID "org.eclipse.jdt":
+searches for all IUs that have the ID "org.eclipse.jdt":
A category definition file is an XML file that describes which categories a feature should be listed in.
The category definition file can be edited using the
@@ -38,7 +36,7 @@
The p2.inf file is a properties file that can be used to customize capabilites, properties, and instructions. Information
about this provisional file is available in the section
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_composite_repositories.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_composite_repositories.htm
index c2157963252..0aed96aa4fe 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_composite_repositories.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_composite_repositories.htm
@@ -1,11 +1,10 @@
-
+
in org.eclipse.equinox.p2.publisher. This bundles is
part of the Eclipse SDK.
-
-
Default Attributes
-
The p2.publish.* ant tasks outlined below all support the following attributes:
-
-
metadataRepository
A URL specifying the metadata repository to publish to.
-
artifactRepository
A URL specifying the artifact repository to publish to.
-
repository
Sets both metadataRepository and artifactRepository.
-
metadataRepositoryName
When creating a new metadata repository, sets the name.
-
artifactRepositoryName
When creating a new artifact repository, sets the name.
-
repositoryName
Sets both metadataRepositoryName and artifactRepositoryName.
-
append
Whether to append to the repository. (Default is "true")
-
compress
When creating a new repository, whether or not to compress the metadata. (Default is "false")
-
publishArtifacts
Whether or not to publish the artifacts. (Default is "true")
-
reusePackedFiles
Whether or not to include discovered Pack200 files in the repository. (Default is "false")
-
<contextRepository>
+
+
Default Attributes
+
The p2.publish.* ant tasks outlined below all support the following attributes:
+
+
metadataRepository
A URL specifying the metadata repository to publish to.
+
artifactRepository
A URL specifying the artifact repository to publish to.
+
repository
Sets both metadataRepository and artifactRepository.
+
metadataRepositoryName
When creating a new metadata repository, sets the name.
+
artifactRepositoryName
When creating a new artifact repository, sets the name.
+
repositoryName
Sets both metadataRepositoryName and artifactRepositoryName.
+
append
Whether to append to the repository. (Default is "true")
+
compress
When creating a new repository, whether or not to compress the metadata. (Default is "false")
+
publishArtifacts
Whether or not to publish the artifacts. (Default is "true")
+
reusePackedFiles
Whether or not to include discovered Pack200 files in the repository. (Default is "false")
+
<contextRepository>
Nested elements specifying context repositories, supports the following attributes:
-
-
location
A URL specifying the location of the repository.
-
artifact
"true" or "false": whether or not there is an artifact repository at this location.
-
metadata
"true" or "false": whether or not there is a metadata repository at this location.
+
+
location
A URL specifying the location of the repository.
+
artifact
"true" or "false": whether or not there is an artifact repository at this location.
+
metadata
"true" or "false": whether or not there is a metadata repository at this location.
If a given context repository contains metadata for one of the features or bundles that are being published, then that metadata
will be re-used instead of generating new metadata.
@@ -42,34 +51,34 @@
Ant Tasks for Publishing p2 Metadata
-
-
p2.publish.featuresAndBundles
+
+
p2.publish.featuresAndBundles
This task will publish metadata for pre-existing binary features and plug-ins.
This task supports the following attributes and elements:
-
-
source
A folder containing plugins and features subfolders to publish.
-
<features>
A nested fileset element specifying the locations of binary features to publish.
-
<bundles>
A nested fileset element specifying the locations of binary plug-ins to publish.
+
+
source
A folder containing plugins and features subfolders to publish.
+
<features>
A nested fileset element specifying the locations of binary features to publish.
+
<bundles>
A nested fileset element specifying the locations of binary plug-ins to publish.
-
-
p2.publish.product
+
+
p2.publish.product
Publish a .product file. This task assumes everything included in the product already exists in the repository. (That is, all features and bundles have been previously published.)
This task supports the following attributes:
-
-
flavor
Set the flavor for the p2 metadata, default is "tooling". Products should consider using a unique flavor if they have special requirements for bundle start levels.
-
productFile
The location of the .product file describing the product.
-
executables
The location of the executables feature. This is the feature that is used for branding and publishing the executables.
-
<config>
Nested elements specifying configurations supported by this product. Config elements specify ws, os and arch:
-
<config ws="gtk" os="linux" arch="x86"/>
- Use <config ws="ANY" os="ANY" arch="ANY"/> if the product can support any platform.
+
+
flavor
Set the flavor for the p2 metadata, default is "tooling". Products should consider using a unique flavor if they have special requirements for bundle start levels.
+
productFile
The location of the .product file describing the product.
+
executables
The location of the executables feature. This is the feature that is used for branding and publishing the executables.
+
<config>
Nested elements specifying configurations supported by this product. Config elements specify ws, os and arch:
+
<config ws="gtk" os="linux" arch="x86"/>
+ Use <config ws="ANY" os="ANY" arch="ANY"/> if the product can support any platform.
-
<advice>
Nested elements specifying specifying additional advice to use when creating the product. Currently the accepted kinds of advice are "featureVersions" and "pluginVersions".
-
- PDE/Build will generate these version properties files when the builder sets the property generateVersionsLists".
+
<advice>
Nested elements specifying specifying additional advice to use when creating the product. Currently the accepted kinds of advice are "featureVersions" and "pluginVersions".
+
A <source> element nested in the ant
task. This element is an ant fileset, with additional
location and kind attributes.
@@ -59,8 +65,8 @@
attributes are ignored.
- kind: Either "metadata" or
- "artifact". If not set, the repository is both
+ kind: Either "metadata" or
+ "artifact". If not set, the repository is both
metadata and artifacts.
Some p2 tasks allow specifying installable units to work with. This
- is done with nested <iu> elements which support the
+ is done with nested <iu> elements which support the
following attributes:
-
+
- id
+ id
@@ -203,7 +206,7 @@
- version
+ version
The version of the IU to match. If not specified, the highest
@@ -213,21 +216,21 @@
- query
+ query
Matches all IUs satisfying the query. Currently only "property"
queries are supported. The format of the query attribute is
intended to be "xpath-like". Eg:
In this case, the update is not truly "headless," since a progress indicator is shown while searching for updates.
The user may cancel the update, but otherwise cannot intervene with the update. If no updates are found, the user is notified.
-
+
In this configuration, the p2 UI class libraries bundle (org.eclipse.equinox.p2.ui) is not needed at all.
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_ui.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_ui.htm
index fab6aeabbfc..ccd0e6444f2 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_ui.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/p2_ui.htm
@@ -1,12 +1,9 @@
-
+
and their corresponding pages. This list can be initialized from information in the preferences service
without running any plug-in code.
-
+
The "Readme Example" preference is added to the top level of the
preference tree on the left. Why? Because a preference page contribution will be added as a root of the tree unless a
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prefs_fieldeditors.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prefs_fieldeditors.htm
index 5ae9c707cf1..30ecc10f1ac 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prefs_fieldeditors.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prefs_fieldeditors.htm
@@ -1,12 +1,9 @@
-
+
Most of the code in this method is concerned with creating and laying out the controls, so we won't dissect it here.
Here is what the corresponding page looks like:
-
+
The other primary responsibility of a preference page is to react to the performOk message. Typically, this
method updates and stores the user preferences and, if necessary, updates any other plug-in objects to reflect the
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prop_contribute.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prop_contribute.htm
index 4a99dc656df..b3a7cc2f3ce 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prop_contribute.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/preferences_prop_contribute.htm
@@ -1,12 +1,9 @@
-
+
Property pages look a lot like preference pages, except there is no hierarchy or categorization of property pages. In the dialog below, both readme property pages appear in the main list of pages.
The upper part of the about dialog shows product level information while the
lower part details the features (if any) and plug-ins installed. The
feature details (branding if you will) are supplied using about.ini, about.properties and about.html
@@ -76,7 +73,7 @@
The preferenceCustomization property can be used to specify a file containing
default preference values for the product.
@@ -89,9 +86,9 @@
Preferences Defaults
refer to preferences that are used by plug-ins but not defined formally in the
API.
-
Dialog Settings Defaults
+
Dialog Settings Defaults
-
If the custom preferences file is used as described above, setting the org.eclipse.ui/default_dialog_settings_rootUrl
+
If the custom preferences file is used as described above, setting the org.eclipse.ui/default_dialog_settings_rootUrl
property in that file allows to specify a folder containing default dialog settings values for product plug-ins.
The property value must be a valid URL.
The preference can be set using the following URL schemes.
@@ -103,15 +100,15 @@
Dialog Settings Defaults
The directory specified by this URL must contain folders with
-dialog_settings.xml files for every plug-in to be customized,
+dialog_settings.xml files for every plug-in to be customized,
each directory with the symbolic name of concrete plug-in,
-such as such as dialog_settings/org.eclipse.ui.ide/dialog_settings.xml, dialog_settings/org.eclipse.ui.navigator/dialog_sttings.xml, dialog_settings/my.company.bundle/dialog_settings.xml...
-Those dialog_settings.xml files for each bundle can be retrieved from a running instance of the Eclipse Platform, under the folder ${workspace}/.metadata/.plugins. You can simply copy-paste those existing files into the directory set as value for the org.eclipse.ui/default_dialog_settings_rootUrl preference.
+such as such as dialog_settings/org.eclipse.ui.ide/dialog_settings.xml, dialog_settings/org.eclipse.ui.navigator/dialog_sttings.xml, dialog_settings/my.company.bundle/dialog_settings.xml...
+Those dialog_settings.xml files for each bundle can be retrieved from a running instance of the Eclipse Platform, under the folder ${workspace}/.metadata/.plugins. You can simply copy-paste those existing files into the directory set as value for the org.eclipse.ui/default_dialog_settings_rootUrl preference.
Splash Screens
-
The product splash screen is specified in the config.ini which is
- located underneath the product's configuration directory. The osgi.splashPath property
+
The product splash screen is specified in the config.ini which is
+ located underneath the product's configuration directory. The osgi.splashPath property
in this file describes places to search for a file called splash.bmp.
The osgi.splashLocation property identifes a complete and
exact path to the splash screen file to use. Specifying a splash path allows
@@ -119,7 +116,7 @@
Splash Screens
indicate several plug-ins or fragments to search as well as $nl$ style paths.
See the
platform
- SDK's config.ini file
+ SDK's config.ini file
for a complete description of properties that can be configured in this file.
The image should be supplied in 24-bit color BMP format (RGB format) and should
be approximately 500x330 pixels in size.
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def.htm
index 80f005b6228..c60cb950ca5 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def.htm
@@ -1,12 +1,9 @@
-
+
-
-
-
-
+
Products and features
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_extpt.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_extpt.htm
index 28cea1d39ef..0355bc237e5 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_extpt.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_extpt.htm
@@ -1,12 +1,9 @@
-
+
-
-
-
-
+
Products extension point
@@ -73,7 +70,6 @@
Products Extension Point
IProductConstants.
See the javadoc for a complete description of these properties and their values. We'll look at these
further in Customizing a product.
-
Product customization properties are also used by other platform services such as to
configure the Universal Welcome/Intro.
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_feature.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_feature.htm
index 3c4d050a29c..02cba1ac27c 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_feature.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_feature.htm
@@ -1,12 +1,9 @@
-
+
It is important to understand which mechanism is used to access any given
file that must be translated so that you'll know what to name the file and where
to put it in the file system relative to the plug-in.
The platform core defines a directory structure that uses locale-specific
subdirectories for files that differ by locale. Translated files are
placed in a directory called nl under the plug-in. For example, the
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_plugins.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_plugins.htm
index 62423f71ebd..6974da8ea0e 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_plugins.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/product_def_plugins.htm
@@ -1,12 +1,9 @@
-
+
Implementing
particular search implementation depends on your plug-in's function, but it is
typical to open a results viewer in this method using
the NewSearchUI
-method activateSearchResultView().
+method activateSearchResultView().
Your plug-in is responsible for
showing its results in the search result view.
"com.abc" could use the node "abc" under the node "com" under
the root node. As in Preference's, the path to such node can be described as "/com/abc".
-
+
-
Picture 1. How the data is organized.
+
Picture 1. How the data is organized.
The data is stored under the node as a key-value pair. The data can be stored in an encrypted form or as
a clear text. The ability to store clear-text data is provided so that logically related information (such as
@@ -56,9 +54,9 @@
Secure Storage Architecture
On the back end, secure storage can be thought of as a keyring. Each entry is associated with a password
provider; only this password provider can be used in the future to decrypt the entry.
-
+
-
Picture 2. Relationship between entries and password providers.
+
Picture 2. Relationship between entries and password providers.
Secure storage has provisions to obtain the master password from various sources described by
password providers. Even more importantly for developers, the set of password providers is open and
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/secure_storage_dev.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/secure_storage_dev.htm
index b665f63a4f0..cb791fdcfee 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/secure_storage_dev.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/secure_storage_dev.htm
@@ -1,12 +1,9 @@
-
+
SecurePreferencesFactory#getDefault() method will return default secure preference root node.
If you prefer your secure storage to be isolated from the rest of the application, you can use
-
+SecurePreferencesFactory#open(URL location, Map options) method to open a secure storage corresponding to
the location of your choice. This method also takes a map of optional hints that can be used to influence
the behavior of this instance of secure storage.
diff --git a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/secure_storage_providers.htm b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/secure_storage_providers.htm
index d530164f9f9..06e943e57e7 100644
--- a/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/secure_storage_providers.htm
+++ b/eclipse.platform.common/bundles/org.eclipse.platform.doc.isv/guide/secure_storage_providers.htm
@@ -1,12 +1,9 @@
-
+
-
-
-
-
+
Creating Password Providers
@@ -70,18 +67,18 @@
Implementing a Password Provider
PasswordProvider class. The central point of that class is the
-
+getPassword() method that returns the master password for the provider for the current user. The method
receives hints when a new password is expected to be created (as opposing to retrieving previously generated
master password).
If your password provider has user interaction or has alternative paths to obtain the master password, you might
consider overriding the
-
+PasswordProvider#retryOnError() method to inform the secure storage that the provider might
be able to obtain a "better" password. For example, consider a password provider with the master password
entered by the user. If the password entered was invalid, then the
-
+PasswordProvider#retryOnError() method will be consulted to see if the password provider can
obtain a correct password.
RTL depending on its content and according to the Unicode Bidirectional Algorithm.
(In the examples, "@" represents an LRM, "&" represents an RLM.)
-
Comma-delimited List (comma)
+
Comma-delimited List (comma)
Pattern
[first list item]
,[second list item]
@@ -62,7 +59,7 @@
Detailed Design
Display (without LRM): CBA,ED,HGF
-
Name or Path of File or Directory
+
Name or Path of File or Directory
Patterns
Windows full path:[drive letter]:\[sub-path]\
@@ -114,7 +111,7 @@
Detailed Design
Display (without LRM): c:\1RID\2RID\ELIFYM.ext
-
Java Code
+
Java Code
Requirement
We can classify elements of a Java program as:
@@ -151,7 +148,7 @@
Detailed Design
Display (without LRM): A = /*C+B*/ D;
-
Regular Expression
+
Regular Expression
Requirement
Preserve the relative order of the regular expression components identical to
the order in which they appear when exclusively Latin characters are used.
+
+
+
+