blob: e08873e0d873a46e4638fc3dd5536d729a0ba3ff [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html lang="en">
<head>
<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
<link rel="STYLESHEET" href="../book.css" charset="ISO-8859-1" type="text/css">
<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"></script>
<title>Adding the preference page</title>
</head>
<body>
<h2>Adding the preference page</h2>
<p>
The combination of product properties and default preference values can fully
configure the Universal Welcome if no further customization is desired. For
products that want to allow users to customize Welcome, a preference page is
available. The following code should be added to the product's plugin.xml:
</p>
<pre>
&lt;extension
point="org.eclipse.ui.preferencePages"&gt;
&lt;page
category="org.eclipse.ui.preferencePages.Workbench"
class="org.eclipse.ui.intro.universal.ExtensionFactory:welcomeCustomization"
id="com.example.intro.introCustomization"
name="%introCustomizationPreference.name"&gt;
&lt;keywordReference id="org.eclipse.ui.ide.appearance"/&gt;
&lt;/page&gt;
&lt;/extension&gt;
</pre>
<p>
This code will add the Welcome customization preference page. The page allows users
to select the presentation theme. The original choice is provided by the theme
preference in the plugin_customization.ini file. In addition, users can choose from
the list of available root pages. Checking the root page causes the related tab to
appear at the top of the dialog.
</p>
<p>
When saved, this preference page will prefix the variables with
the product id so that it does not interfere with the settings made for other
products in the same workbench. Alternatively, selecting the checkbox above will
not prefix the variables, making the stored settings visible to all the
products.
</p>
</body>
</html>