Skip to content

Commit 04a8187

Browse files
jnerlichvogella
authored andcommitted
Continue to work on link correction of FAQ after migration to markdown
1 parent 79e698a commit 04a8187

22 files changed

+39
-128
lines changed
Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,15 @@
1-
2-
31
FAQ Are there any special Eclipse UI guidelines?
42
================================================
53

64

7-
8-
95
A wealth of Eclipse UI guidelines exists. Mentioning any in this single FAQ would seem to do no justice to Nick Edgar, Kevin Haaland, Jin Li, and Kimberley Peter. Please refer to their online Eclipse article Eclipse User Interface Guidelines. In their seminal work, they brush on such topics as icon sizes and color palettes, wizards, editors, dialogs, commands, views, perspectives, windows, properties, widgets, navigators, tasks, preferences, outlines, properties, bookmarks, text editors, the flat-look design, accelerators, best practices, and a checklist for developers.
106

117
In fact, the 100-page article is a great source of inspiration for any plug-in developer. Study it before you create any Eclipse plug-in with a visual representation to avoid mistakes made by others and to learn from the experts how to design high-quality UI designs.
128

139
See Also:
1410
---------
1511

16-
Online article on UI Guidelines ([https://eclipse.org/articles](https://eclipse.org/articles)).
12+
Online article on [UI Guidelines](https://eclipse.org/articles).
1713

1814
There is a partly obsolete article with eclipse [2.1 UI Guidelines](https://www.eclipse.org/articles/Article-UI-Guidelines/Index.html)
1915

docs/FAQ/FAQ_Can_I_get_my_documentation_in_PDF_form_please.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
2-
31
FAQ Can I get my documentation in PDF form, please?
42
===================================================
53

@@ -12,6 +10,6 @@ Converting HTML to PDF form is somewhat labor-intensive. Although tools are avai
1210
See Also:
1311
---------
1412

15-
* HTMLDOC by Easy Software Products ([http://www.easysw.com/htmldoc](http://www.easysw.com/htmldoc))
16-
* eclipse.org documentation page ([https://www.eclipse.org/documentation](https://www.eclipse.org/documentation))
13+
* [HTMLDOC](http://www.easysw.com/htmldoc) by Easy Software Products
14+
* eclipse.org [documentation page](https://www.eclipse.org/documentation)
1715

docs/FAQ/FAQ_Does_Eclipse_run_on_any_Linux_distribution.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
2-
31
FAQ Does Eclipse run on any Linux distribution?
42
===============================================
53

@@ -13,7 +11,7 @@ The latest releases should normally work fine on any recent Linux distribution.
1311

1412
Portability of Eclipse is defined mainly by the underlying Java runtime (Eclipse 4.6 and later needs a Java 8 runtime) and by what platform SWT runs on, as all graphical UI in Eclipse are based on SWT.
1513

16-
For historical interest, earlier versions of Eclipse have also been compiled with gcj ([http://www.klomp.org/mark/classpath/eclipse-gnome-gij.png](http://www.klomp.org/mark/classpath/eclipse-gnome-gij.png)) and even made to run on .Net, using IKVM on the CLR or Mono through the amazing work of Jeroen Frijters.
14+
For historical interest, earlier versions of Eclipse have also been compiled with gcj [gcj](http://www.klomp.org/mark/classpath/eclipse-gnome-gij.png) and even made to run on .Net, using IKVM on the CLR or Mono through the amazing work of Jeroen Frijters.
1715

1816
See Also:
1917
---------
Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
2-
31
FAQ How do I create a graphical editor?
42
=======================================
53

@@ -8,5 +6,5 @@ The Eclipse Platform and SDK do not have support for creating graphical editors.
86
See Also:
97
---------
108

11-
The GEF Web page ([https://eclipse.org/gef](https://eclipse.org/gef))
9+
The [GEF Web page](https://eclipse.org/gef)
1210

docs/FAQ/FAQ_How_do_I_create_an_Outline_view_for_my_own_language_editor.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
2-
31
FAQ How do I create an Outline view for my own language editor?
42
===============================================================
53

@@ -53,7 +51,7 @@ You will want to update the selection in your Outline view when the cursor is mo
5351
When the user selects a node in the Outline view, the editor should change selection to the selected element and make it visible.
5452

5553

56-
When [https://bugs.eclipse.org/bugs/show_bug.cgi?id=507205](https://bugs.eclipse.org/bugs/show_bug.cgi?id=507205) is fixed, a recommended way would be to rely on the Common Navigator Framework in order to implement Tree-based navigation outline pages. For the moment, you can already write your own outline view consuming the CommonViewer class.
54+
When [Bug 507205](https://bugs.eclipse.org/bugs/show_bug.cgi?id=507205) is fixed, a recommended way would be to rely on the Common Navigator Framework in order to implement Tree-based navigation outline pages. For the moment, you can already write your own outline view consuming the CommonViewer class.
5755

5856

5957

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
2-
31
FAQ How do I get access to Eclipse newsgroups?
42
==============================================
53

6-
The Eclipse newsgroups are password-protected to protect them from spam and trolls. Visit [https://eclipse.org/newsgroups/index.html](https://eclipse.org/newsgroups/index.html) and request a free password to access the newsgroups. The same password can be used to browse the Eclipse mailing list archives.
4+
The Eclipse newsgroups are password-protected to protect them from spam and trolls.
5+
Visit [Eclipse Newsgroups](https://eclipse.org/newsgroups/index.html) and request a free password to access the newsgroups. The same password can be used to browse the Eclipse mailing list archives.
76

docs/FAQ/FAQ_How_do_I_get_started_with_creating_a_custom_text_editor.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
1-
2-
31
FAQ How do I get started with creating a custom text editor?
42
============================================================
53

64
Contributing to Generic and Extensible editor
75
---------------------------------------------
86

9-
Since Eclipse 4.7.M3, you can consider simply adding extensions to the Generic Editor: [https://www.eclipse.org/eclipse/news/4.7/M3/#generic-editor](https://www.eclipse.org/eclipse/news/4.7/M3/#generic-editor) . This will allow you to write support for textual edition of a language with less boiler plate.
7+
Since Eclipse 4.7.M3, you can consider simply adding extensions to the [Generic Editor](https://www.eclipse.org/eclipse/news/4.7/M3/#generic-editor) . This will allow you to write support for textual edition of a language with less boiler plate.
108

119
Create a custom text editor
1210
---------------------------
Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
1-
2-
31
FAQ How do I profile my Java program?
42
=====================================
53

64
Eclipse has built-in support for launching applications and for debugging Java applications but no inherent support for profiling. However, support for profilers can be implemented by using a special launch configuration. Commercial products, such as WebSphere Studio Application Developer, do this by adding profiling support to their set of plug-ins. Much of this work is being standardized and moved down into the open source Eclipse subproject called Hyades.
75

86
A couple of individual profiler projects and products are under way. The Eclipse Colorer profiler with elaborate reporting views may be of interest to people who want to experiment with profiling Java code from Eclipse. This profiler can be downloaded under the CPL from SourceForge.
97

10-
See [FAQ\_When\_do\_I\_use\_a\_launch_delegate?](./FAQ_When_do_I_use_a_launch_delegate.md "FAQ When do I use a launch delegate?") for a discussion of how profilers are implemented.
8+
See [FAQ When do I use a launch delegate?](./FAQ_When_do_I_use_a_launch_delegate.md "FAQ When do I use a launch delegate?") for a discussion of how profilers are implemented.
119

1210

1311

1412
See Also:
1513
---------
1614

17-
[FAQ\_When\_do\_I\_use\_a\_launch_delegate?](./FAQ_When_do_I_use_a_launch_delegate.md "FAQ When do I use a launch delegate?")
15+
[FAQ When do I use a launch delegate?](./FAQ_When_do_I_use_a_launch_delegate.md "FAQ When do I use a launch delegate?")
1816

1917

20-
Eclipse Profiler ([http://eclipsecolorer.sourceforge.net/index_profiler.html](http://eclipsecolorer.sourceforge.net/index_profiler.html))
18+
[Eclipse Profiler](http://eclipsecolorer.sourceforge.net/index_profiler.html)
2119

docs/FAQ/FAQ_How_do_I_propose_my_own_project.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
2-
31
FAQ How do I propose my own project?
42
====================================
53

6-
Please see the Project Development Process pages on the eclipse.org Website: [https://www.eclipse.org/projects/dev_process/pre-proposal-phase.php](https://www.eclipse.org/projects/dev_process/pre-proposal-phase.php)
4+
Please see the Project Development Process pages on the eclipse.org [Website](https://www.eclipse.org/projects/dev_process/pre-proposal-phase.php)
75

86

97

docs/FAQ/FAQ_How_do_I_upgrade_Eclipse.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
2-
31
FAQ How do I upgrade Eclipse IDE?
42
=================================
53

@@ -28,7 +26,7 @@ To upgrade Eclipse IDE to the next major release
2826
1. You first need to [add the new release's repository](https://help.eclipse.org/latest/index.jsp?topic=%2Forg.eclipse.platform.doc.user%2Ftasks%2Ftasks-128.htm) as follows:
2927
1. Window > Preferences > Install/Update > Available Software Sites
3028
2. Click 'Add'
31-
3. Enter the URL of the new repository (for example, [https://download.eclipse.org/releases/2021-12/](https://download.eclipse.org/releases/2021-12/) ).
29+
3. Enter the URL of the new repository for example, https://download.eclipse.org/releases/2021-12/
3230
4. Click 'Ok'
3331
2. [Help > Check for Updates](https://help.eclipse.org/latest/index.jsp?topic=%2Forg.eclipse.platform.doc.user%2Ftasks%2Ftasks-120.htm)
3432
3. If updates are found, proceed through the install wizard and restart the IDE when prompted. Otherwise, read carefully the error message to find out which component is conflicting and establish your resolution strategy.
@@ -40,7 +38,7 @@ Always enable major upgrades
4038
To always enable major upgrades of your IDE once and for all:
4139

4240
1. Open the _Available Software Sites_ preference page
43-
2. Enable the _Latest Eclipse release [https://download.eclipse.org/releases/latest](https://download.eclipse.org/releases/latest)_ repository by ticking the checkbox.
41+
2. Enable the [Latest Eclipse release](https://download.eclipse.org/releases/latest) repository by ticking the checkbox.
4442
3. Apply and Close
4543
4. Check for updates
4644

@@ -52,15 +50,15 @@ Beta-testing milestones and release candidates
5250
The same process as above can be used to enable update to milestones or release candidates of the Eclipse IDE (which have already been partially tested before being published, but might still contain unknown issues for you to [report to Bugzilla](https://bugs.eclipse.org/bugs/enter_bug.cgi)). The only difference is that you should add the 2 following URLs as [Available sites](https://help.eclipse.org/2018-12/index.jsp?topic=%2Forg.eclipse.platform.doc.user%2Ftasks%2Ftasks-128.htm) before running [Check for updates](https://help.eclipse.org/2018-12/index.jsp?topic=%2Forg.eclipse.platform.doc.user%2Ftasks%2Ftasks-120.htm) in order to let Eclipse IDE locate the milestones/release-candidates:
5351

5452
* Assuming next release name is _2021-12_
55-
* [https://download.eclipse.org/staging/2021-12/](https://download.eclipse.org/staging/2021-12/)
56-
* [https://download.eclipse.org/releases/2021-12/](https://download.eclipse.org/releases/2021-12/) (this is the same URL that will be used for release)
53+
* https://download.eclipse.org/staging/2021-12/
54+
* https://download.eclipse.org/releases/2021-12/ (this is the same URL that will be used for release)
5755

5856
Fresh install
5957
-------------
6058

6159
If you prefer not performing an update (for example because some 3rd-party content is not ready for the current release of Eclipse IDE and the update reports conflicts), you can still download a fresh install of the Eclipse IDE and install it in another location on your filesystem, and use it together with the previous version.
6260

63-
To do so, download a new build from the Eclipse download website ([https://www.eclipse.org/downloads/eclipse-packages/](https://www.eclipse.org/downloads/eclipse-packages/)) and run the installer or unzip the archive in a new directory. We strongly recommend against installing/unzipping over your existing version of Eclipse IDE as it may corrupt your installation.
61+
To do so, download a new build from the [Eclipse download website](https://www.eclipse.org/downloads/eclipse-packages/) and run the installer or unzip the archive in a new directory. We strongly recommend against installing/unzipping over your existing version of Eclipse IDE as it may corrupt your installation.
6462

6563
When you start a new version of Eclipse IDE, you can use the same existing workspace folder that you were using with the older version. The workspace will be migrated to a newer version and the Eclipse IDE will reuse all configurations. The workspace is forward compatible, but might not be backward compatible.
6664

0 commit comments

Comments
 (0)