System Summary Sections

Identifier:
org.eclipse.ui.systemSummarySections

Since:
3.0

Description:
The Eclipse UI provides an AboutDialog that can be branded and reused by client product plugins. This dialog includes a SystemSummary dialog that contains configuration details. By extending the org.eclipse.ui.systemSummarySections extension point clients are able to put their own information into the log.

Configuration Markup:

<!ELEMENT extension (section+)>

<!ATTLIST extension

point CDATA #REQUIRED
id    CDATA #IMPLIED
name  CDATA #IMPLIED>

point - a fully qualified identifier of the target extension point
id - an optional identifier of the extension instance
name - an optional name of the extension instance

<!ELEMENT section EMPTY>

<!ATTLIST section

class        CDATA #REQUIRED
sectionTitle CDATA #REQUIRED
id           CDATA #IMPLIED>

class - The fully qualified name of a class the implements org.eclipse.ui.about.ISystemSummarySection. The class must provide a default constructor.
sectionTitle - a translatable name that will be displayed as the title of this section in the system summary
id - an optional, unique name that will be used to identify this system summary section

Examples:
Following is an example of a systemSummarySections extension:
<extension
 point=
"org.eclipse.ui.systemSummarySections"
>
 <section
  sectionTitle=
"Cookie Manager Plugin"

  class=
"org.eclipse.ui.examples.rcp.browser.ConfigDetails"

  id=
"RCPBrowser.ConfigDetails"
>
 </section>
</extension>
API Information:
The class specified in the section element must be a concrete subclass of org.eclipse.ui.about.ISystemSummarySection.

Supplied Implementation:
The Workbench uses this extension point to provide the following sections in the system summary dialog: - System properties: The contents of the table returned by java.lang.System.getProperties. - Features: The id of all features found by eclipse. - Plug-in Registry: The id of all plugins found by eclipse. - User Preferences: The contents of the Eclipse PreferencesService. - Error Log: The contents of the platform's error log.

Copyright (c) 2004 IBM Corporation and others.
All rights reserved. This program and the accompanying materials are made available under the terms of the Common Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/cpl-v10.html