Skip to content

Commit f88d2cf

Browse files
jnerlichvogella
authored andcommitted
More link corrections on FAQ markdown pages
1 parent 04a8187 commit f88d2cf

15 files changed

+82
-54
lines changed

docs/FAQ/FAQ_How_do_I_configure_an_Eclipse_Java_project_to_use_SWT.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,30 @@
1-
2-
31
FAQ How do I configure an Eclipse Java project to use SWT?
42
==========================================================
53

64
The easiest way to configure a Java project in Eclipse to use SWT is as follows:
75

86
1. Download the SWT stable release for your Eclipse version and your operating system from [Eclipse SWT Project Page](https://www.eclipse.org/swt). For example, for Eclipse version 3.3 and Windows, select the Windows link under Releases / Stable, as shown in the screenshot below.
97

10-
![Swt web page.png](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQimages/Swt_web_page.png)
8+
![Swt web page.png](https://raw.githubusercontent.com/eclipse-platform/eclipse.platform/master/docs/FAQ/images/Swt_web_page.png)
119

1210
2. This will download a zip file that contains our org.eclipes.swt project. (For example, for Eclipse 3.3 and Windows, the file is called swt-3.3.1.1-win32-win32-x86.zip.) Do not unzip this file. Just download it and note the directory where you saved it.
1311
3. Inside Eclipse, select Import / Existing Projects into Workspace, as shown below.
1412

15-
![Import wizard1.png](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQimages/Import_wizard1.png)
13+
![Import wizard1.png](https://raw.githubusercontent.com/eclipse-platform/eclipse.platform/master/docs/FAQ/images/Import_wizard1.png)
1614

1715
4. Press Next and select the option Select archive file. Browse to the zip file you just downloaded. A project called org.eclipse.swt will display in the Projects list. Make sure it is checked, as shown below, and press Finish.
1816

19-
![Import wizard2.png](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQimages/Import_wizard2.png)
17+
![Import wizard2.png](https://raw.githubusercontent.com/eclipse-platform/eclipse.platform/master/docs/FAQ/images/Import_wizard2.png)
2018

2119
5. Eclipse will create the project org.eclipse.swt in your workspace. This project already has the required SWT JAR file, including source code for the SWT classes.
2220
6. Select the project that will be used to develop SWT programs (for example, "MyProject) and select Project / Properties / Java Build Path.
2321
7. Select the Projects tab. Press Add. The org.eclipse.swt project will display in the Select projects to add: list. Select this project by checking the box. The screen should display as shown below.
2422

25-
![Required project selection.png](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQimages/Required_project_selection.png)
23+
![Required project selection.png](https://raw.githubusercontent.com/eclipse-platform/eclipse.platform/master/docs/FAQ/images/Required_project_selection.png)
2624

2725
8. Press OK to return to the Projects tab of the Java Build Path dialog. The screen should show the org.eclipse.swt project as shown below.
2826

29-
![Myproject build path.png](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQimages/Myproject_build_path.png)
27+
![Myproject build path.png](https://raw.githubusercontent.com/eclipse-platform/eclipse.platform/master/docs/FAQ/images/Myproject_build_path.png)
3028

3129

3230
At this point, your project has access to all of the SWT packages and to the SWT source code.

docs/FAQ/FAQ_How_do_I_display_a_Web_page_in_SWT.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
1-
2-
31
FAQ How do I display a Web page in SWT?
42
=======================================
53

64
In Eclipse 3.0, SWT introduced a browser widget for displaying a native HTML renderer inside an SWT control. Prior to the introduction of this browser, it was necessary to invoke an external Web browser program for displaying rendered HTML. The browser can be instructed to render either a URL or a supplied string containing HTML content. The browser widget does not include the usual controls for navigation, bookmarks, and all the usual bells and whistles associated with a Web browser. As such, it can be used for highly controlled applications, such as displaying help text or even for showing decorated and interactive text inside a view or an editor.
75

86
The browser has API for programmatically manipulating the content, such as browsing forward or back in the navigation history, refreshing the content, or halting a rendering in process. You can install listeners on the browser to be notified when the location is changing or when the title changes or to receive progress notification as a page loads. It is fairly straightforward to implement basic Web browser functionality around this browser widget. For more details, take a look at BrowserAction in the org.eclipse.faq.examples plug-in. This action implements a fully functional Web browser in fewer than 60 lines of code!
97

10-
11-
For a richer example, look at the org.eclipse.ui.examples.browser project in the Eclipse repository (dev.eclipse.org). This project implements a Web browser as a stand-alone Eclipse RCP application. As a quick example, here is a stand-alone SWT snippet that opens a browser shell on this book's Web site.
8+
As a quick example, here is a stand-alone SWT snippet that opens a browser shell on this book's Web site.
129

1310
A title listener is added to the browser in order to update the shell title with the name of the Web page being displayed:
1411

@@ -32,6 +29,18 @@ A title listener is added to the browser in order to update the shell title with
3229

3330
Figure 7.1 shows the resulting browser inside a simple shell. The browser widget is not yet available on all platforms as not all platforms that SWT supports have an appropriate native control that can be exploited. For Eclipse 3.0, the browser will at least be available on Windows, Linux, QNX, and MacOS. For platforms that do not have a browser widget available, the Browser constructor will throw an SWT error, allowing you to catch the condition and fall back to an alternative, such as a user-specified external browser.
3431

32+
How can I invoke the eclipse default web browser in my own plugin?
33+
------------------------------------------------------------------
34+
35+
> > I want to invoke the eclipse default web browser which is specified in
36+
> > "Preferences" -> "General" -> "Web Browser" in my own plugin, giving it
37+
> > a URL and make it visit that URL. How can I do this? Thanks.
38+
39+
I think you want something like...
40+
41+
IWorkbenchBrowserSupport support =
42+
PlatformUI.getWorkbench().getBrowserSupport();
43+
IWebBrowser browser = support.createBrowser("someId");
44+
browser.openURL(new URL("https://www.eclipse.org"));
3545

36-
See also [How can I invoke the eclipse default web browser in my own plugin?](/How_can_I_invoke_the_eclipse_default_web_browser_in_my_own_plugin%3F "How can I invoke the eclipse default web browser in my own plugin?").
3746

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
FAQ How do I increase the permgen size available to Eclipse?
2+
============================================================
3+
4+
Note: Oracle Java 8 does not have a separate permanent generation space any more. The -XX:(Max)PermSize option makes no difference (the JVM will ignore it, so it can still be present).
5+
6+
If you see `java.lang.OutOfMemoryError: PermGen space` errors, you need to increase the permanent generation space available to Eclipse.
7+
8+
PermGen is the permanent generation of objects in the VM (Class names, internalized strings, objects that will never get garbage-collected). An easy, if somewhat memory-hungry fix is to enlarge the maximum space for these objects by adding
9+
10+
-XX:MaxPermSize=128M
11+
12+
as an argument to the JVM when starting Eclipse.
13+
The recommended way to do this is via your `eclipse.ini` file.
14+
15+
Alternatively, you can invoke the Eclipse executable with command-line arguments directly, as in
16+
17+
eclipse [normal arguments] -vmargs -XX:PermSize=64M -XX:MaxPermSize=128M [more VM args]
18+
19+
Note: The arguments after -vmargs are directly passed to the VM. Run java -X for the list of options your VM accepts. Options starting with -X are implementation-specific and may not be applicable to all JVMs (although they do work with the Sun/Oracle JVMs).
20+
21+
Eclipse and Sun VMs on Windows
22+
------------------------------
23+
24+
Eclipse 3.3 and above supports an argument to the launcher: --launcher.XXMaxPermSize. On Windows, Eclipse ships with the following lines in the `eclipse.ini` file:
25+
26+
--launcher.XXMaxPermSize
27+
256m
28+
29+
With the above arguments, if the VM being used is a Sun VM and there is not already a -XX:MaxPermSize= VM argument, then the launcher will automatically add -XX:MaxPermSize=256m to the list of VM arguments being used. The Eclipse launcher is only capable of identifying Sun VMs on Windows.
30+
31+
The option --launcher.XXMaxPermSize is something that the launcher reads (not the JVM); it tells the launcher to automatically size the JVM's perm gen if it (the launcher) detects a Sun JVM that supports that option. This alleviates the need to put it under -vmargs (where non-Sun JVM's could fail because they don't understand that option).
32+
33+
Note: Eclipse 3.6 and below on Windows has a bug with Oracle/Sun JDK 1.6.0_21 (July 2010) where the launcher cannot detect a Oracle/Sun VM, and therefore does not use the correct PermGen size. If you are using either of this version, add the -XX flag to the eclipse.ini as described above.
34+
35+
Note: Eclipse 3.3.1 has a bug where the launcher cannot detect a Sun VM, and therefore does not use the correct PermGen size. It seems this may have been a known bug on Mac OS X for 3.3.0 as well. If you are using either of these platform combinations, add the -XX flag to the eclipse.ini as described above.
36+
37+
See Also:
38+
---------
39+
40+
[FAQ How do I run Eclipse?](./FAQ_How_do_I_run_Eclipse.md)

docs/FAQ/FAQ_How_do_I_prevent_my_plug-in_from_being_broken_when_I_update_Eclipse.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,4 @@ Eclipse makes a careful distinction between published APIs and internal implemen
77

88
In the Eclipse Platform, the API of a plug-in includes all public classes and interfaces that do not have the word _internal_ in their package names and all public and protected methods in those classes and interfaces. The API also includes all extension points that are not explicitly described as for internal use only in their documentation; there is only a small handful of such internal extension points.
99

10-
See Also:
11-
---------
12-
13-
* [Eclipse online article "How to Use the Eclipse API"](https://www.eclipse.org/articles/Article-API%20use/eclipse-api-usage-rules.html)
14-
* [EclipseCon 2004 technical track presentation, "Eclipse APIs: Lines in the Sand"](http://www.eclipsecon.org/2004/EclipseCon_2004_TechnicalTrackPresentations/02_des_Rivieres.pdf)
1510

docs/FAQ/FAQ_How_to_create_a_context_menu_&_add_actions_to_the_same.md renamed to docs/FAQ/FAQ_How_to_create_a_context_menu_and_add_actions_to_the_same.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22

3-
FAQ How to create a context menu & add actions to the same?
4-
===========================================================
3+
FAQ How to create a context menu and add actions to the same?
4+
=============================================================
55

66
**To create a Context Menu for your View or Editor do the following :**
77

docs/FAQ/FAQ_Pages_parts_sites_windows_What_is_all_this_stuff.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The main body of a workbench window is represented by the _workbench page_, whic
1313

1414
Parts interact with the rest of the window via their _site_. The site is not a visible entity but simply an API mechanism to separate the methods that operate on the view from the methods that operate on controls and services outside the view. This allows the workbench implementers to add new features to the sites without breaking all the plug-ins that implement the parts. Figure 9.1 Spider graph shows how a view (ContentOutline) and an editor (WelcomeEditor) each has its own site, which is hosted by a page, inside a workbench window, owned by the workbench.
1515

16-
![FAQ views.png](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQimages./FAQ_views.png).md
16+
![FAQ views.png](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQ/images./FAQ_views.png).md
1717
**Figure 9.1**  Spider diagram of site parts
1818

1919
In addition, sites bring together that functionality that different parts of the workbench had in common but could not be expressed well in a single inheritance hierarchy.

docs/FAQ/FAQ_What_Eclipse_newsgroups_are_available.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,8 @@ FAQ What Eclipse newsgroups are available?
33

44
As with most technologies, Eclipse started out with a single newsgroup. Now, all major, and some smaller, Eclipse projects have their own newsgroups. Some are more active than others. Some have a very specific scope, and others are more broad in their coverage of discussion topics. The Eclipse newsgroup page has a complete index of the current Eclipse newsgroups and a description of their focus areas.
55

6-
The most [active newsgroup](news://news.eclipse.org/eclipse.platform) has around 1,500 postings per month. Before you post a question to any newsgroup, it makes a lot of sense to search the platform newsgroup for an answer. Chances are that the question has been asked before, and the answer can be found there quickly.
6+
The most active newsgroup has around 1,500 postings per month. Before you post a question to any newsgroup, it makes a lot of sense to search the platform newsgroup for an answer. Chances are that the question has been asked before, and the answer can be found there quickly.
77

88
The newsgroups are archived at the Eclipse Web site, and the [search engine](https://eclipse.org/search/search.cgi) at the Eclipse Web site can search them quite efficiently.
99

10-
See Also
11-
--------
12-
13-
* [Eclipse Newsgroups](https://www.eclipse.org/newsgroups/)
1410

docs/FAQ/FAQ_What_books_have_been_written_on_Eclipse.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,36 +7,36 @@ In June 2004, books on Eclipse, other than this one, included the following:
77

88
* Frank Budinsky et al., _Eclipse Modeling Framework_, Addison-Wesley, 2004
99

10-
* Berthold Daum, _Eclipse 2 for Java Developers_, [Wiley](http://www.wileyeurope.com), 2003
10+
* Berthold Daum, _Eclipse 2 for Java Developers_, [Wiley](https://www.wiley-vch.de/de/), 2003
1111

12-
* Berthold Daum, _Java-Entwicklung mit Eclipse 2_ (German), [DPunkt](http://www.dpunkt.de), 2003
12+
* Berthold Daum, _Java-Entwicklung mit Eclipse 2_ (German), [DPunkt](https://dpunkt.de/), 2003
1313

14-
* Berthold Daum, Stefan Franke, and Marcel Tilly, _Web-Entwicklung mit Eclipse 3_ (German), [DPunkt](http://www.dpunkt.de), 2004
14+
* Berthold Daum, Stefan Franke, and Marcel Tilly, _Web-Entwicklung mit Eclipse 3_ (German), [DPunkt](https://dpunkt.de/), 2004
1515

1616
* Eric Clayberg and Dan Rubel, _Eclipse: Building Commercial-Quality Plug-Ins_, Addison-Wesley, 2004
1717

1818
* Bill Dudney, _Eclipse Live_, SourceBeat, 2003
1919

20-
* David Gallardo, Ed Burnette, and Robert McGovern, _Eclipse in Action: A Guide for the Java Developer_, [Manning](http://www.manning.com), 2003
20+
* David Gallardo, Ed Burnette, and Robert McGovern, _Eclipse in Action: A Guide for the Java Developer_, [Manning](https://www.manning.com), 2003
2121

2222

2323
* Wonjin Heo and Jiwon Jun, _Total Eclipse (Korean)_, Youngjin Publishing, 2003
2424

25-
* Steven Holzner, _Eclipse: A Java Developer's Guide_, [O'Reilly](http://www.oreilly.com), 2004
25+
* Steven Holzner, _Eclipse: A Java Developer's Guide_, [O'Reilly](https://www.oreilly.com), 2004
2626

2727
* Junya Ishikawa et al., _The Complete Eclipse Guidebook: From Installation to Plug-In Development_ (Japanese), ASCII, 2003
2828

2929
* Shinji Miyamoto, Shinichi IIda, and Yu Aoki, _Java Developers Guide to Adopting Eclipse_ (Japanese), SoftBank Publishing, 2003
3030

31-
* William Moore et al., _Eclipse Development using the Graphical Editing Framework and the Eclipse Modeling Framework_, [IBM RedBooks](http://www.redbooks.ibm.com), 2003
31+
* William Moore et al., _Eclipse Development using the Graphical Editing Framework and the Eclipse Modeling Framework_, [IBM RedBooks](https://www.redbooks.ibm.com), 2003
3232

33-
* Stanford Ng, Stephen Holder, and Matt Scarpino, _JFace/SWT in Action_, [Manning](http://www.manning.com), 2003
33+
* Stanford Ng, Stephen Holder, and Matt Scarpino, _JFace/SWT in Action_, [Manning](https://www.manning.com), 2003
3434

35-
* Joe Pluta, _Eclipse: Step by Step_, [MC Press](http://www.mc-store.com), 2003
35+
* Joe Pluta, _Eclipse: Step by Step_, [MC Press](https://www.mc-store.com), 2003
3636

3737
* Carlos Valcarcel, _Eclipse Kick Start_, Sams Publishing, 2004
3838

39-
* Rob Warner and Robert Harris, _The Definitive Guide to SWT and JFace_, [Apress](http://www.apress.com), 2004
39+
* Rob Warner and Robert Harris, _The Definitive Guide to SWT and JFace_, [Apress](https://www.apress.com), 2004
4040

4141
* Seongjun Yun, Sang-Min Cho, and Jeong Il Song, _Eclipse: Reinforcing the Java world_ (Korean), Hybird, 2003
4242

docs/FAQ/FAQ_What_is_a_JDOM.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
FAQ What is a JDOM?
22
===================
33

4-
![Warning2.png](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQimages/Warning2.png)
4+
![Warning2.png](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQ/images/Warning2.png)
55

66
**JDT's JDOM has been superseded by the [DOM/AST](https://help.eclipse.org/topic/org.eclipse.jdt.doc.isv/reference/api/org/eclipse/jdt/core/dom/AST.html), and should no longer be used.**
77

docs/FAQ/FAQ_What_is_a_Quick_Fix.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ Quick Fixes can be used to make typing much faster. Let's assume that you are us
99

1010
The JDT can detect syntax errors but is also smart enough to guess what you could do to correct the problem. As can be seen in Figure 3.2, the JDT can create the class for us with a single mouse click.
1111

12-
![](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQimages/120px-Quickfix1.jpg)
12+
![](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQ/images/120px-Quickfix1.jpg)
1313

1414

1515
A major tenet of Extreme Programming is to write test cases first. In other words, use cases are specified first; then the implementation is provided. Quick Fixes help in this process. For instance, we start using our Rook class as if it has a move method. Of course, the editor will complain and place a marker next to the reference to the nonexistent method. However, the editor also guesses what we want to do with the method (Figure 3.3).
1616

17-
![](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQimages/120px-Quickguess1.jpg)
17+
![](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQ/images/120px-Quickguess1.jpg)
1818

1919

2020
In a similar fashion, Quick Fixes can be used to add fields to classes, add parameters to methods, help with unhandled exceptions, and generate local variable declarations. Quick Fixes are designed to allow you to continue the creative process of designing API while using it, a major component of Extreme Programming.

0 commit comments

Comments
 (0)