Skip to content

Commit

Permalink
Continue to work on link correction of FAQ after migration to markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
jnerlich authored and vogella committed Feb 15, 2024
1 parent 79e698a commit 04a8187
Show file tree
Hide file tree
Showing 22 changed files with 39 additions and 128 deletions.
6 changes: 1 addition & 5 deletions docs/FAQ/FAQ_Are_there_any_special_Eclipse_UI_guidelines.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,15 @@


FAQ Are there any special Eclipse UI guidelines?
================================================




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.

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.

See Also:
---------

Online article on UI Guidelines ([https://eclipse.org/articles](https://eclipse.org/articles)).
Online article on [UI Guidelines](https://eclipse.org/articles).

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

6 changes: 2 additions & 4 deletions docs/FAQ/FAQ_Can_I_get_my_documentation_in_PDF_form_please.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


FAQ Can I get my documentation in PDF form, please?
===================================================

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

* HTMLDOC by Easy Software Products ([http://www.easysw.com/htmldoc](http://www.easysw.com/htmldoc))
* eclipse.org documentation page ([https://www.eclipse.org/documentation](https://www.eclipse.org/documentation))
* [HTMLDOC](http://www.easysw.com/htmldoc) by Easy Software Products
* eclipse.org [documentation page](https://www.eclipse.org/documentation)

4 changes: 1 addition & 3 deletions docs/FAQ/FAQ_Does_Eclipse_run_on_any_Linux_distribution.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


FAQ Does Eclipse run on any Linux distribution?
===============================================

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

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.

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.
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.

See Also:
---------
Expand Down
4 changes: 1 addition & 3 deletions docs/FAQ/FAQ_How_do_I_create_a_graphical_editor.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


FAQ How do I create a graphical editor?
=======================================

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

The GEF Web page ([https://eclipse.org/gef](https://eclipse.org/gef))
The [GEF Web page](https://eclipse.org/gef)

Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


FAQ How do I create an Outline view for my own language editor?
===============================================================

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


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.
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.



Expand Down
5 changes: 2 additions & 3 deletions docs/FAQ/FAQ_How_do_I_get_access_to_Eclipse_newsgroups.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@


FAQ How do I get access to Eclipse newsgroups?
==============================================

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.
The Eclipse newsgroups are password-protected to protect them from spam and trolls.
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.

Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@


FAQ How do I get started with creating a custom text editor?
============================================================

Contributing to Generic and Extensible editor
---------------------------------------------

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.
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.

Create a custom text editor
---------------------------
Expand Down
8 changes: 3 additions & 5 deletions docs/FAQ/FAQ_How_do_I_profile_my_Java_program.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,19 @@


FAQ How do I profile my Java program?
=====================================

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.

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.

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.
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.



See Also:
---------

[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?")
[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?")


Eclipse Profiler ([http://eclipsecolorer.sourceforge.net/index_profiler.html](http://eclipsecolorer.sourceforge.net/index_profiler.html))
[Eclipse Profiler](http://eclipsecolorer.sourceforge.net/index_profiler.html)

4 changes: 1 addition & 3 deletions docs/FAQ/FAQ_How_do_I_propose_my_own_project.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@


FAQ How do I propose my own project?
====================================

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)
Please see the Project Development Process pages on the eclipse.org [Website](https://www.eclipse.org/projects/dev_process/pre-proposal-phase.php)



Expand Down
12 changes: 5 additions & 7 deletions docs/FAQ/FAQ_How_do_I_upgrade_Eclipse.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


FAQ How do I upgrade Eclipse IDE?
=================================

Expand Down Expand Up @@ -28,7 +26,7 @@ To upgrade Eclipse IDE to the next major release
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:
1. Window > Preferences > Install/Update > Available Software Sites
2. Click 'Add'
3. Enter the URL of the new repository (for example, [https://download.eclipse.org/releases/2021-12/](https://download.eclipse.org/releases/2021-12/) ).
3. Enter the URL of the new repository for example, https://download.eclipse.org/releases/2021-12/
4. Click 'Ok'
2. [Help > Check for Updates](https://help.eclipse.org/latest/index.jsp?topic=%2Forg.eclipse.platform.doc.user%2Ftasks%2Ftasks-120.htm)
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.
Expand All @@ -40,7 +38,7 @@ Always enable major upgrades
To always enable major upgrades of your IDE once and for all:

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

Expand All @@ -52,15 +50,15 @@ Beta-testing milestones and release candidates
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:

* Assuming next release name is _2021-12_
* [https://download.eclipse.org/staging/2021-12/](https://download.eclipse.org/staging/2021-12/)
* [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)
* https://download.eclipse.org/staging/2021-12/
* https://download.eclipse.org/releases/2021-12/ (this is the same URL that will be used for release)

Fresh install
-------------

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.

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.
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.

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.

Expand Down
4 changes: 1 addition & 3 deletions docs/FAQ/FAQ_How_do_I_write_an_editor_for_my_own_language.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@


FAQ How do I write an editor for my own language?
=================================================

Contributing to Generic and Extensible editor
---------------------------------------------

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.
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.

Implementing your own editor
----------------------------
Expand Down
8 changes: 1 addition & 7 deletions docs/FAQ/FAQ_How_is_Eclipse_licensed.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@


FAQ How is Eclipse licensed?
============================

Please see the Eclipse Legal Resources pages on the Eclipse.org website: [https://www.eclipse.org/legal/](https://www.eclipse.org/legal/)




Please see the Eclipse Legal Resources pages on the Eclipse.org [website](https://www.eclipse.org/legal/)

See Also:
---------
Expand Down
8 changes: 3 additions & 5 deletions docs/FAQ/FAQ_What_Eclipse_newsgroups_are_available.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@


FAQ What Eclipse newsgroups are available?
==========================================

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.

The most active newsgroup is [news://news.eclipse.org/eclipse.platform](news://news.eclipse.org/eclipse.platform), with 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.
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.

The newsgroups are archived at the Eclipse Web site, and the search engine at the Eclipse Web site ([https://eclipse.org/search/search.cgi](https://eclipse.org/search/search.cgi)) can search them quite efficiently.
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.

See Also
--------

* Eclipse Newsgroups ([https://www.eclipse.org/newsgroups/](https://www.eclipse.org/newsgroups/))
* [Eclipse Newsgroups](https://www.eclipse.org/newsgroups/)

14 changes: 2 additions & 12 deletions docs/FAQ/FAQ_What_Java_refactoring_support_is_available.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,17 @@


FAQ What Java refactoring support is available?
===============================================

In the Java perspective, a menu called **Refactor** is enabled. It contains all possible refactoring operations currently implemented by the JDT. All operations are listed, even though they may not be applicable to the current selection. When a given element is selected in the Java editor, the context menu will show the refactoring operations that are specifically applicable to the selection. Refer to the **Help > Help Contents >** Java Development User Guide > Refactoring support **for a comprehensive** discussion on what refactoring techniques are available, how to preview a refactoring, and how to undo/redo refactorings.



It is important to realize the existence of the underlying mechanisms that allow for refactoring. For instance, when a given method is being renamed, all source files that have a reference to the method will have to be visited and their reference to the renamed method changed. The only way to do these kinds of refactorings in a scalable and manageable way is by using an underlying model of the Java source being refactored. Such a model is commonly referred to as a Document Object Model (DOM).



Frequent refactorings for which you may want to remember the keyboard shortcuts are **rename** with shortcut Alt+Shift+R and **extract method** with shortcut Alt+Shift+M. You can create or change key bindings for all refactorings from the **Workbench > Keys** preference page.





See Also:
---------

[FAQ\_How\_do\_I\_support\_refactoring\_for\_my\_own_language?](./FAQ_How_do_I_support_refactoring_for_my_own_language.md "FAQ How do I support refactoring for my own language?")
[FAQ How do I support refactoring for my own language?](./FAQ_How_do_I_support_refactoring_for_my_own_language.md "FAQ How do I support refactoring for my own language?")


IBM developerWorks article on refactoring ([http://ibm.com/developerworks](http://ibm.com/developerworks))
IBM developerWorks article on [refactoring](http://ibm.com/developerworks)

4 changes: 1 addition & 3 deletions docs/FAQ/FAQ_What_articles_on_Eclipse_have_been_written.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


FAQ What articles on Eclipse have been written?
===============================================

Expand All @@ -12,5 +10,5 @@ In addition to the online Eclipse articles, a wealth of Eclipse experience is re
See Also:
---------

* The Eclipse articles page ([https://eclipse.org/articles](https://eclipse.org/articles))
* The [Eclipse articles page](https://eclipse.org/articles)

4 changes: 1 addition & 3 deletions docs/FAQ/FAQ_What_is_a_JDOM.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


FAQ What is a JDOM?
===================

Expand All @@ -10,7 +8,7 @@ FAQ What is a JDOM?

A JDOM is a Java document object model. DOM is a commonly used term for an object-oriented representation of the structure of a file. A Google definition search turned up this Web definition: _Document Object Model: DOM is a platform- and language-neutral interface, that provides a standard model of how the objects in an XML object are put together, and a standard interface for accessing and manipulating these objects and their interrelationships._

-[http://www.google.com/search?q=define:Document+Object+Model](http://www.google.com/search?q=define:Document+Object+Model)
-[Google search for define:Document Object Model](http://www.google.com/search?q=define:Document+Object+Model)

In the context of JDT, the JDOM represents a hierarchical, in-memory representation of a single Java file (compilation unit). The DOM can be traversed to view the elements that make up that compilation unit, including types, methods, package declarations, import statements, and so on. The main purpose of the JDOM API is manipulating Java code, allowing you to add and delete methods and fields, for example. All this manipulation occurs on the in-memory object model, so it does not affect the Java file on disk until the DOM is saved. However, the DOM allows you to access only the _principal structure_ of the compilation unit, so you cannot easily modify document elements, such as javadoc comments and method bodies.

Expand Down
4 changes: 1 addition & 3 deletions docs/FAQ/FAQ_What_is_hot_code_replace.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@


FAQ What is hot code replace?
=============================

Expand All @@ -12,5 +10,5 @@ If HCR does not work for you even in a simple Java application and you have conf
See Also:
---------

The WSDD Web site ([http://ibm.com/software/wireless/wsdd/](http://ibm.com/software/wireless/wsdd/))
The [WSDD Web site] (http://ibm.com/software/wireless/wsdd/)

0 comments on commit 04a8187

Please sign in to comment.