FAQ - Coding and link adjustments

Author: vogella

docs/FAQ/FAQ_How_do_I_configure_an_Eclipse_Java_project_to_use_SWT.md

@@ -7,26 +7,26 @@ The easiest way to configure a Java project in Eclipse to use SWT is as follows:
 
 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.
 
-    ![Swt web page.png](https://raw.githubusercontent.com/eclipse/gef-classic/master/docs/images/Swt_web_page.png)
+    ![Swt web page.png](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQimages/Swt_web_page.png)
 
 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.
 3.  Inside Eclipse, select Import / Existing Projects into Workspace, as shown below.
 
-    ![Import wizard1.png](https://raw.githubusercontent.com/eclipse/gef-classic/master/docs/images/Import_wizard1.png)
+    ![Import wizard1.png](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQimages/Import_wizard1.png)
 
 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.
 
-    ![Import wizard2.png](https://raw.githubusercontent.com/eclipse/gef-classic/master/docs/images/Import_wizard2.png)
+    ![Import wizard2.png](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQimages/Import_wizard2.png)
 
 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.
 6.  Select the project that will be used to develop SWT programs (for example, "MyProject) and select Project / Properties / Java Build Path.
 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.
 
-    ![Required project selection.png](https://raw.githubusercontent.com/eclipse/gef-classic/master/docs/images/Required_project_selection.png)
+    ![Required project selection.png](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQimages/Required_project_selection.png)
 
 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.
 
-    ![Myproject build path.png](https://raw.githubusercontent.com/eclipse/gef-classic/master/docs/images/Myproject_build_path.png)
+    ![Myproject build path.png](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQimages/Myproject_build_path.png)
 
 
 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_create_an_application.md

@@ -5,25 +5,25 @@ FAQ How do I create an application?
 
 To create an application, you need a plug-in that adds an extension to the org.eclipse.core.runtime.applications extension point. An example application definition from a plugin.xml file is as follows:
 
-   <extension id="helloworld" point="org.eclipse.core.runtime.applications">
-      <application>
-         <run class="org.eclipse.faq.HelloWorld"/>
-      </application>
-   </extension>
+      <extension id="helloworld" point="org.eclipse.core.runtime.applications">
+         <application>
+            <run class="org.eclipse.faq.HelloWorld"/>
+         </application>
+      </extension>
 
 
 The class attribute of the run element must specify a class that implements org.eclipse.core.boot.IPlatformRunnable. Here is the source of a trivial application:
 
-   public class HelloWorld implements IPlatformRunnable {
-      public Object run(Object args) throws Exception {
-         System.out.println("Hello from Eclipse application");
-         return EXIT_OK;
+      public class HelloWorld implements IPlatformRunnable {
+         public Object run(Object args) throws Exception {
+            System.out.println("Hello from Eclipse application");
+            return EXIT_OK;
+         }
       }
-   }
 
 To run the application, you need to specify the fully qualified ID of your application extension definition, using the application command-line argument when launching Eclipse:
 
-   eclipse -application org.eclipse.faq.helloworld.helloworld
+      eclipse -application org.eclipse.faq.helloworld.helloworld
 
 The fully qualified extension ID is computed by prepending the plug-in ID to the simple extension ID from the plugin.xml file. In this example, the plug-in ID is org.eclipse.faq.helloworld, and the simple extension ID is helloworld.
 

docs/FAQ/FAQ_How_do_I_create_an_external_tool_builder.md

@@ -11,13 +11,13 @@ An external tool builder is an external tool that runs every time the projects i
 
 As with ordinary external tools, you can define your own type of external tool builder by creating a new launch configuration type. In your launch configuration declaration, you must specify the category for external tool builder launch configurations:
 
-   <launchConfigurationType
-      name="%AntBuild"
-      delegate="com.xyz.MyLaunchDelegate"
-      '''category="org.eclipse.ui.externaltools.builder"'''
-      modes="run"
-      id="com.xyz.MyLaunchType">
-   </launchConfigurationType>
+      <launchConfigurationType
+         name="%AntBuild"
+         delegate="com.xyz.MyLaunchDelegate"
+         '''category="org.eclipse.ui.externaltools.builder"'''
+         modes="run"
+         id="com.xyz.MyLaunchType">
+      </launchConfigurationType>
 
 See Also:
 ---------

docs/FAQ/FAQ_How_do_I_create_an_image_registry_for_my_plug-in.md

@@ -5,18 +5,18 @@ FAQ How do I create an image registry for my plug-in?
 
 If you're writing a plug-in with UI components, it should be a subclass of AbstractUIPlugin. This superclass already provides you with an empty image registry accessible by calling getImageRegistry. When the registry is first accessed, the hook method initializeImageRegistry will be called. You should override this method to populate your image registry with the image descriptors you need. You don't have to use this registry if you don't need it, and because it is created lazily on first access, there is no performance overhead if you never use it. Here is an example of a plug-in that adds a sample.gif image to its image registry:
 
-   public class ExamplesPlugin extends AbstractUIPlugin {
-      public static final String PLUGIN_ID = "org.eclipse.faq.examples";
-      public static final String IMAGE_ID = "sample.image";
-      ...
-      protected void initializeImageRegistry(ImageRegistry registry) {
-         Bundle bundle = Platform.getBundle(PLUGIN_ID);
-         IPath path = new Path("icons/sample.gif");
-         URL url = FileLocator.find(bundle, path, null);
-         ImageDescriptor desc = ImageDescriptor.createFromURL(url);
-         registry.put(IMAGE_ID, desc);
+      public class ExamplesPlugin extends AbstractUIPlugin {
+         public static final String PLUGIN_ID = "org.eclipse.faq.examples";
+         public static final String IMAGE_ID = "sample.image";
+         ...
+         protected void initializeImageRegistry(ImageRegistry registry) {
+            Bundle bundle = Platform.getBundle(PLUGIN_ID);
+            IPath path = new Path("icons/sample.gif");
+            URL url = FileLocator.find(bundle, path, null);
+            ImageDescriptor desc = ImageDescriptor.createFromURL(url);
+            registry.put(IMAGE_ID, desc);
+         }
       }
-   }
 
 
 

docs/FAQ/FAQ_How_do_I_create_an_update_site_(site.md

@@ -12,23 +12,23 @@ First create a new plugin project
 
 New -> Plug-in Development -> Plug-in Project
 
-![Plugin.jpg](https://raw.githubusercontent.com/eclipse/gef-classic/master/docs/images/Plugin.jpg)
+![Plugin.jpg](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQimages/Plugin.jpg)
 
 You can select a template for creating your project or even just create a blank one in case you know how things work.
 
 Now you have to create your feature project.
 
 New -> Plug-in Development -> Feature Project
 
-![Feature.jpg](https://raw.githubusercontent.com/eclipse/gef-classic/master/docs/images/Feature.jpg)
+![Feature.jpg](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQimages/Feature.jpg)
 
 Here is the point where you link your Plugin project with your Feature Project.
 
 Open the feature.xml file on your Feature project.
 
 On plugins tab click on add and select your project then save the file.
 
-![Feature-plugin.jpg](https://raw.githubusercontent.com/eclipse/gef-classic/master/docs/images/Feature-plugin.jpg)
+![Feature-plugin.jpg](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQimages/Feature-plugin.jpg)
 
 The last piece is the Update site project. See below
 
@@ -39,15 +39,15 @@ To create it go to
 
 New -> Plug-in Development -> Update Site Project
 
-![Site.jpg](https://raw.githubusercontent.com/eclipse/gef-classic/master/docs/images/Site.jpg)
+![Site.jpg](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQimages/Site.jpg)
 
 Now we just have to link the Feature project with the Update site, and you're good to go.
 
 To do that, open the site.xml file on your Site project.
 
 Add Feature -> Select your project.
 
-![Site-feature.jpg](https://raw.githubusercontent.com/eclipse/gef-classic/master/docs/images/Site-feature.jpg)
+![Site-feature.jpg](https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQimages/Site-feature.jpg)
 
 In case you want to add a category for your feature, just click on New Category,
 

docs/FAQ/FAQ_How_do_I_get_a_Display_instance.md

@@ -7,13 +7,13 @@ Most users deploy Eclipse as one top-level window and manage their code in persp
 
 If you call Display.getCurrent, it returns the display that was created in that thread, if any. Here is an example:
 
-   public static Display getDisplay() {
-      Display display = Display.getCurrent();
-      //may be null if outside the UI thread
-      if (display == null)
-         display = Display.getDefault();
-      return display;		
-   }
+      public static Display getDisplay() {
+         Display display = Display.getCurrent();
+         //may be null if outside the UI thread
+         if (display == null)
+            display = Display.getDefault();
+         return display;		
+      }
 
 A calling thread that does not have an active display will return null. Therefore, this method is useful only when you are absolutely certain that you are in the thread that created the display. This brings us to the second way you can obtain a display instance: Display.getDefault(). It will return the first display that was created. If your application has only one display, this is an acceptable way of obtaining the display.
 

docs/FAQ/FAQ_How_do_I_get_started_with_creating_a_custom_text_editor.md

@@ -23,18 +23,18 @@ The FAQs in this chapter will use a running example of a simple HTML editor. We
 
 Here is the skeleton of the HTMLEditor class, showing the customization entry points:
 
-public class HTMLEditor extends AbstractTextEditor {
-   public HTMLEditor() {
-      //install the source configuration
-      setSourceViewerConfiguration(new HTMLConfiguration());
-      //install the document provider
-      setDocumentProvider(new HTMLDocumentProvider());
+   public class HTMLEditor extends AbstractTextEditor {
+      public HTMLEditor() {
+         //install the source configuration
+         setSourceViewerConfiguration(new HTMLConfiguration());
+         //install the document provider
+         setDocumentProvider(new HTMLDocumentProvider());
+      }
+      protected void createActions() {
+         super.createActions();
+         //... add other editor actions here
+      }
    }
-   protected void createActions() {
-      super.createActions();
-      //... add other editor actions here
-   }
-}
 
 See Also:
 ---------

docs/FAQ/FAQ_How_do_I_handle_setup_problems_for_a_given_builder.md

@@ -5,9 +5,9 @@ FAQ How do I handle setup problems for a given builder?
 
 When running a build in a runtime workbench, you might get the following message:
 
-    !MESSAGE Skipping builder com.xyz.builder for project P.
-    Either the builder is missing from the install, or it
-    belongs to a project nature that is missing or disabled.
+     !MESSAGE Skipping builder com.xyz.builder for project P.
+        Either the builder is missing from the install, or it
+        belongs to a project nature that is missing or disabled.
 
 This message means that something is wrong with the builder plug-in or with the attribution of the builder specification in the .project file. The builder plug-in might load fine but still be broken, perhaps because it is missing an ID in the extension point declaration.
 

docs/FAQ/FAQ_How_do_I_hook_into_global_actions,_such_as_Copy_and_Delete.md

@@ -7,10 +7,10 @@ Certain standard toolbar and menu entries can be shared among several views and
 
 A view typically registers its global action handlers in the createPartControl method:
 
-   IActionBars actionBars= getViewSite().getActionBars();
-   actionBars.setGlobalActionHandler(
-      ActionFactory.COPY.getId(),
-      copyAction);	
+      IActionBars actionBars= getViewSite().getActionBars();
+      actionBars.setGlobalActionHandler(
+         ActionFactory.COPY.getId(),
+         copyAction);	
 
 You have to do this only once for each view that is created. The platform remembers your action handler and retargets the action each time the view becomes active. To unregister from a global action, simply invoke setGlobalActionHandler again and pass in a null value for the handler.
 

docs/FAQ/FAQ_How_do_I_hook_my_editor_to_the_Back_and_Forward_buttons.md

@@ -16,15 +16,15 @@ A navigation location can also choose to support persistence. When an editor clo
 
 Now we know how to create and restore editor locations, but how are entries added to the navigation history in the first place? Anyone can mark an interesting location in an open editor by calling the markLocation method on INavigationHistory. Code that causes the cursor or selection to jump to another location in an editor should call this method both before and after performing the jump. As mentioned, implementations of restoreLocation should also mark the current location before restoring an old one. Regardless of whether the specific editor has any support for navigation history, markLocation will work. If the editor doesn't implement INavigationLocationProvider, a history entry will be added, allowing the user to jump back to that editor but without returning to any particular location. The following snippet shows an action that is added to the sample HTML editor. When the action is invoked, it will add the current cursor position to the navigation history:
 
-   public class MarkLocationAction extends Action {
-      private IEditorPart editor;
-      public MarkLocationAction(IEditorPart editor) {
-         super("Mark Location in History", null);
-         this.editor = editor;
+      public class MarkLocationAction extends Action {
+         private IEditorPart editor;
+         public MarkLocationAction(IEditorPart editor) {
+            super("Mark Location in History", null);
+            this.editor = editor;
+         }
+         public void run() {
+            IWorkbenchPage page = editor.getSite().getPage();
+            page.getNavigationHistory().markLocation(editor);
+         }
       }
-      public void run() {
-         IWorkbenchPage page = editor.getSite().getPage();
-         page.getNavigationHistory().markLocation(editor);
-      }
-   }