-
Notifications
You must be signed in to change notification settings - Fork 0
/
eclipse_preferences.html
297 lines (280 loc) · 14.7 KB
/
eclipse_preferences.html
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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- This is a generated file. Do not edit. -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="">
<meta name="title" content="Setting Preferences for Plugin">
<title>Setting Preferences for Plugin</title>
<link href="css/knopflerfish2.3.2.css" type="text/css" rel="stylesheet">
<link rel="shortcut icon" href="images/favicon.png">
<script type="text/javascript" src="scripts/google-analytics.js"></script>
<script type="text/javascript" src="scripts/menu.js"></script>
<script type="text/javascript" src="scripts/current_release.js"></script>
</head>
<body>
<div id="main">
<a name="top"></a>
<div id="header">
<div id="header_logo">
<a href="index.html"><img src="images/kf300_black.png" border="0" alt="knopflerfish logo"></a>
</div>
<div id="header_ad">
<div class="header_stylish">
Open Source OSGi Service Platform Maintained by<br>
<a href="http://www.makewave.com">
<img style="margin-top: 4px;" src="images/makewave_logo.png" alt="Makewave" border="0">
</a>
</div>
</div>
<div class="break"></div>
<div id="header_menu">
<a class="button_closed" href="index.html">Home</a>
<a class="button_closed" href="news.html">News</a>
<a class="button_closed" href="download.html">Download</a>
<a class="button_open" href="documentation.html">Documentation</a>
<a class="button_closed" href="about.html">About</a>
</div>
</div>
<div id="leftmenu">
<form style="padding-left: 0px;" class="searchform" method="GET" action="http://www.google.com/search">
<input type="hidden" name="ie" value="UTF-8">
<input type="hidden" name="oe" value="UTF-8">
<input type="hidden" name="domains" value="www.knopflerfish.org">
<input type="hidden" name="sitesearch" value="www.knopflerfish.org">
<input TYPE="text" value="Search site" name="q" size="20" maxlength="255"
onFocus="clearText(this)" onBlur="clearText(this)"
class="searchfield">
</form>
<div id="menu_news"><div class="nrow">
<img src="images/arrow_closed.gif" alt="" onclick="setMenuById(this.parentNode.parentNode.id, 'toggle')">
<a class="nrow_closed" href="news.html">News</a></div>
<div class="nrow1_closed"><a href="news_archive.html">Archive</a></div>
<!-- <div class="nrow1_closed"><a href="http://www.knopflerfish.org/mailman/listinfo">Mailing lists</a></div> -->
<div class="nrow1_off_closed">Mailing lists</div>
</div>
<div id="menu_download"><div class="nrow"><img src="images/arrow_closed.gif" alt="" onclick="setMenuById(this.parentNode.parentNode.id, 'toggle')"><a class="nrow_closed" href="download.html">Download</a></div>
<div class="nrow1_closed"><a href="license.html">License</a></div>
<!--
<div class="nrow1_closed"><a href="/snapshots/">Nightly builds</a></div>
<div class="nrow1_closed"><a href="/snapshots/current_trunk/junit_grunt/index.xml">Nightly tests</a></div>
-->
<div class="nrow1_off_closed">Nightly builds (off)</div>
<div class="nrow1_off_closed">Nightly tests (off)</div>
<!-- <div class="nrow1_closed"><a href="/releases/current/osgi/jars/index.xml">Bundle repository</a></div> -->
<div class="nrow1_closed"><a href="/releases/current/osgi/jars/index.html"
onclick="currentReleasePath(this, '/osgi/jars/index.xml')"> Bundle repository</a></div>
<div class="nrow1_closed"><a href="git_info.html">Source code (git)</a></div>
<div class="nrow1_closed"><a href="archive.html">Archived releases</a></div>
<div class="nrow1_closed"><a href="maven.html">Maven repository</a></div>
</div>
<div id="menu_docs"><div class="nrow"><img src="images/arrow_open.gif" alt="" onclick="setMenuById(this.parentNode.parentNode.id, 'toggle')"><a class="nrow_open" href="documentation.html">Documentation</a></div>
<div class="nrow1_open"><a href="kf6_osgi_r6.html">About Knopflerfish 6</a></div>
<div class="nrow1_open"><a href="kf5_osgi_r5.html">About Knopflerfish 5</a></div>
<div class="nrow1_open"><a href="kf4_osgi_r4_v4.3.html">About Knopflerfish 4</a></div>
<div class="nrow1_open"><a href="kf3_osgi_r4_v4.2.html">About Knopflerfish 3</a></div>
<div class="nrow1_open"><a href="osgi_java_compatibility_guide.html">Java Compatability</a></div>
<!-- <div class="nrow1_open"><a href="/releases/current/docs/index.html">Manual (KF 6.0.0)</a></div> -->
<div class="nrow1_open"><a href="/releases/current/docs/index.html"
onclick="currentReleasePath(this, '/docs/index.html')">Manual (KF 6.0.0)</a></div>
<!--
<div class="nrow1_label_open">Shortcuts</div>
<div class="nrow1_indent_open"><a href="/releases/current/docs/installing.html">Installing</a></div>
<div class="nrow1_indent_open"><a href="/releases/current/docs/running.html">Running</a></div>
<div class="nrow1_indent_open"><a href="/releases/current/docs/building.html">Building</a></div>
<div class="nrow1_indent_open"><a href="/releases/current/docs/programming.html">Programming</a></div>
<div class="nrow1_indent_open"><a href="/releases/current/docs/testing.html">Testing</a></div>
-->
<!-- <div class="nrow1_open"><a href="/snapshots_trunk/current_trunk/docs/index.html">Manual (snapshot)</a></div> -->
<div class="nrow1_off_open">Manual (snapshot) (off)</a></div>
<div class="nrow1_open"><a href="tutorials.html">Tutorials</a></div>
<div class="nrow1_open"><a href="eclipse_plugin.html">Eclipse plugin</a></div>
</div>
<div id="menu_about"><div class="nrow"><img src="images/arrow_closed.gif" alt="" onclick="setMenuById(this.parentNode.parentNode.id, 'toggle')"><a class="nrow_closed" href="about.html">About</a></div>
<div class="nrow1_closed"><a href="history.html">History</a></div>
<div class="nrow1_closed"><a href="contacts.html">Contacts</a></div>
<div class="nrow1_closed"><a href="osgi-links.html">OSGi related links</a></div>
<div class="nrow1_closed"><a href="merchandise.html">T-shirt and stuff</a></div>
</div>
<div class="nrow"> </div>
<div class="nrow"><a href="https://github.com/knopflerfish/knopflerfish.org/issues">Issue Tracker <img border="0" alt="" src="images/extlink.gif"></a></div>
<!--
<div class="nrow"><a href="https://sourceforge.net/forum/forum.php?forum_id=328005">
Forum <img border="0" src="images/extlink.gif"alt="">
</a></div-->
<div class="nrow"><a href="http://knopflerfish.blogspot.com/">
Knopflerfish Blog <img border="0" src="images/extlink.gif"alt="">
</a></div>
<div class="makewave">
Maintained by<br>
<a href="http://www.makewave.com"><img src="images/makewave_logo_126x16.gif" alt="Makewave" border="0"></a><br>
<div class="makewave_2">
<a href="http://www.makewave.com/site.en/products/knopflerfish_pro_osgi.shtml">
Knopflerfish Pro<img border="0" alt="" src="images/extlink.gif"></a><br>
<a href="http://www.makewave.com/site.en/products/osgi_training.shtml">
OSGi Training<img border="0" alt="" src="images/extlink.gif"></a><br>
<a href="http://www.makewave.com/site.en/products/osgi_expert.shtml">
Professional Services<img border="0" alt="" src="images/extlink.gif"></a><br>
</div>
</div>
<div class="makewave">
Checkout Knopflerfish<br>
<a href="http://github.com/knopflerfish"><img src="images/github/GitHub_Logo-80px.png"
alt="Knopflerfish on GitHub" border="0"/></a>
</div>
<div class="makewave">
<a href="http://www.twitter.com/knopflerfish"><img src="http://twitter-badges.s3.amazonaws.com/follow_us-b.png" alt="Follow knopflerfish on Twitter" border="0"/></a>
</div>
</div>
<div id="mainblock">
<h2>Setting preferences</h2>
<p>
After the plug-in is installed or a new workspace is created the preferences used
by the plug-in must be set in order for it to work properly. The preferences can
be set in two ways, either by setting them in the
<a href="#preference_dialog">preferences dialog</a> or by
<a href="#import_preferences">importing</a> previously <a href="#export_preferences">exported settings</a>.
</p>
<a name="preference_dialog"></a>
<h3>The preference dialog</h3>
<p>
The preference dialog is shown by selecting 'Window->Preferences...'.
Selecting 'OSGi' in the left-hand list shows the preferences used by the plug-in.
</p>
<img src="images/eclipse_prefs_1.gif"/>
<h4>Frameworks</h4>
<p>
In the framework preferences you specify the frameworks that the plug-in
should be able to use. The specified frameworks are used by the plug-in when
debugging and building bundle projects, where the checked framework is used by
default.
</p>
<img src="images/eclipse_prefs_frameworks_list.gif"/>
<br>
<p>
When you select to add or edit a framework a dialog is shown where you specify a name,
type of framework and where framework is installed. The name needs to be unique and is
later used to identify the framework.
</p>
<img src="images/eclipse_prefs_frameworks_add.gif"/>
<p>
The framework types supported are:
<ul>
<li>Knopflerfish 1.3</li>
<li>Oscar 1.0</li>
<li>Eclipse 3.1</li>
</ul>
After selecting framework type you select the directory where the framework is stored.
For all frameworks types it works to point to the top level directory of the framework.
For Knopflerfish you can also point to the <code>knopflerish.org</code> or the
<code>knopflerish.org/osgi</code> directories, which can be useful if you work against
subversion. If you select an invalid directory for the specified framework type you will
get an error message at the bottom of the dialog box. If the checkbox 'Use default settings'
is checked and the directory is valid, the main class, the runtime libraries needed to
launch the framework and bundles accompanying the framework distribution will automatically
be listed.
</p>
<p>
You can override the default settings by unchecking 'Use default settings'. This will allow
you to change the main class, the runtime libraries and the bundles. For instance if you have
embedded the framework into a launcher you will want to add the launcher libraries to the
runtime libraries and also change the main class which is invoked on launch. Or maybe you
want to add or remove some bundles from the framework. The bundles listed here can later be
used through bundle repositories when building and running bundle projects. All user defined
changes that are made are shown in <b>bold</b> text in the list.
</p>
<p>
If you have made a lot of changes to customize a framework and need to install a new framework,
for example to upgrade to a later version, you can select to import user settings from the
existing preferences to the new framework. You add the new framework, uncheck the 'Use default
settings' button and then use the 'Import Libraries...' function at the bottom right. In the
dialog shown, you select an existing framework to take settings from and what to import.
</p>
<h4>Execution environments</h4>
<p>
In the environments preferences you specify which execution environments that bundle projects
can be built against. By default three environments are available:
<ul>
<li>Default JRE</li>
<li>CDC-1.0/Foundation-1.0</li>
<li>OSGi/Minimum-1.0</li>
</ul>
When default JRE is selected the bundle projects are built against the libraries of the default
JRE selected in the Java->Installed JREs preferences. When CDC-1.0/Foundation-1.0 or
OSGi/Minimum-1.0 is selected the bundle projects are built against the respective profiles
specified by OSGi.
</p>
<img src="images/eclipse_prefs_environments_list.gif"/>
<br>
<p>
When you select to add or edit an execution environment a dialog is shown where you specify an
environment name and the libraries the environment consists of. You can also attach source to
the added libraries, which can be useful if you later want to step into the code when
debugging.
</p>
<img src="images/eclipse_prefs_environments_add.gif"/>
<h4>Bundle repositories</h4>
<p>
Bundle repositories are used when searching for bundles. The plug-in searches for bundles
to find packages available for import by bundle projects, to find bundles to add to a
bundle projects build path and to find bundles to add to launch configurations. In order to
have any bundles available you need to set up at least one repository. The repositories
are searched in the order they are listed. Only repositories which are checked, i.e.
marked as active, are searched.
</p>
<img src="images/eclipse_prefs_repositories_list.gif"/>
<br>
<p>
When you select to add or edit a bundle repository a dialog is shown where you specify a name,
type of repository and repository configuration. The name needs to be unique and is later used
to identify the repository.
</p>
<img src="images/eclipse_prefs_repositories_add.gif"/>
<p>
The repository types supported are:
<ul>
<li>Framework Repository</li>
<li>OBR Reposistory - Not Yet Implemented</li>
</ul>
<p>
Framework repositories are used for bundles that are part of an installed framework distribution.
The repository configuration for this type is the name of the framework as specified under the
Frameworks section. The configuration dropdown box will contain the framework names of the
frameworks that have been configured. If a framework name is missing in the dropdown, a possible
reason is that the framework has not yet been saved, which is not done until you close the
preference window.
</p>
<p>
OBR repositories are used for bundles published using
<a href="http://oscar-osgi.sourceforge.net/">Oscar Bundle Repository</a>. The repository
configuration for this type is the URL of the repository XML file. OBR repositories have not
yet been implemented in the plug-in.
</p>
<a name="export_preferences"></a>
<h3>Exporting preferences</h3>
<p>
You can export the OSGi preferences by selecting 'File->Export...'. In the dialog shown
you select 'Preferences'. A new dialog will be shown where you specify which preferences
to export. Here you can select 'OSGi settings', which will include all OSGi preferences made.
The preferences are exported to a file. The file can be used to share preferences in a team or,
if you have created a new workspace you can use it to avoid setting up all the preferences again.
</p>
<img src="images/eclipse_prefs_export.gif"/>
<a name="import_preferences"></a>
<h3>Importing preferences</h3>
<p>
You can import previously exported preferences by selecting 'File->Import...'. In the dialog shown
you select 'Preferences'. A new dialog will be shown where you specify the file to import
the preferences from.
</p>
<img src="images/eclipse_prefs_import.gif"/>
</div>
<div class="break"></div>
<div id="footer">
<div id="copyright">
Copyright © 2008-2016. The Knopflerfish Project. All rights reserved.
</div>
</div>
</div>
</body>
</html>