Correct formating of markdown documentation

API_Tools, FAQ, User_Guide
eclipse-pde · Feb 29, 2024 · f3e1d8f · f3e1d8f
1 parent d89028d
commit f3e1d8f
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 73 deletions.
diff --git a/docs/API_Tools.md b/docs/API_Tools.md
@@ -193,7 +193,7 @@ Running an API use scan (IDE)
 In the IDE API use scans can be run from the External tools dialog. 
 The benefits of providing the scanning as an external tool are many, the foremost being: 1. you can create as many different configurations as you want for scanning different distributions of your products and 2. each configuration can have its own persisted settings.
 
-[![The external tools dialog showing a use scan configuration](/images/4/4e/Usescan-ext-dialog.png)](/File:Usescan-ext-dialog.png "The external tools dialog showing a use scan configuration")
+![The external tools dialog showing a use scan configuration](https://raw.githubusercontent.com/eclipse-pde/eclipse.pde/master/docs/images/Usescan-ext-dialog.png)
 
 ### Creating a new scan configuration
 
@@ -361,11 +361,11 @@ It can be found by using the Generate Javadoc command located in the Project mai
 
 Once the wizard starts you will have to locate the Javadoc executable (if not already specified) and select the bundles you wish to generate Javadoc for.
 
-[![The first page of the Generate Javadoc wizard](/images/6/69/Jdoc_wizard_p1.png)](/File:Jdoc_wizard_p1.png "The first page of the Generate Javadoc wizard")
+![The first page of the Generate Javadoc wizard](https://raw.githubusercontent.com/eclipse-pde/eclipse.pde/master/docs/images/Jdoc_wizard_p1.png)
 
 On the next page, you can configure additional options.
 
-[![The second page of the Generate Javadoc wizard](/images/0/09/Jdoc_wizard_p2.png)](/File:Jdoc_wizard_p2.png "The second page of the Generate Javadoc wizard")
+![The second page of the Generate Javadoc wizard](https://raw.githubusercontent.com/eclipse-pde/eclipse.pde/master/docs/images/Jdoc_wizard_p2.png)
 
 On the last page is where we need to tell the wizard about the custom API tools tags. 
 In the `Extra Javadoc options` area you will want to enter the following tag definitions:
@@ -382,11 +382,11 @@ In the `Extra Javadoc options` area you will want to enter the following tag def
 
 The wizard will then look like the following:
 
-[![The third page of the Generate Javadoc wizard](/images/f/f4/Jdoc_wizard_p3.png)](/File:Jdoc_wizard_p3.png "The third page of the Generate Javadoc wizard")
+![The third page of the Generate Javadoc wizard](https://raw.githubusercontent.com/eclipse-pde/eclipse.pde/master/docs/images/Jdoc_wizard_p3.png)
 
 Once you press finish and the Javadoc tool completes you should see API tools tag restrictions appearing in your documentation like the following example:
 
-[![How the API tools tags look in the HTML documentation](/images/4/4d/Doc_example.png)](/File:Doc_example.png "How the API tools tags look in the HTML documentation")
+![How the API tools tags look in the HTML documentation](https://raw.githubusercontent.com/eclipse-pde/eclipse.pde/master/docs/images/Doc_example.png)
 
 ### Using the Commandline
 

diff --git a/docs/FAQ.md b/docs/FAQ.md
@@ -15,21 +15,21 @@ Contents
 *   [3 Target Management](#Target-Management)
     *   [3.1 Why do I get an popup dialog saying I have selected a target with a newer version than your current Eclipse installation?](#Why-do-I-get-an-popup-dialog-saying-I-have-selected-a-target-with-a-newer-version-than-your-current-Eclipse-installation.3F)
 *   [4 Products](#Products)
-    *   [4.1 Why doesn't my JRE get included in a headless build?](#Why-doesn.27t-my-JRE-get-included-in-a-headless-build.3F)
+    *   [4.1 Why doesn't my JRE get included in a headless build?](#Why-doesnt-my-JRE-get-included-in-a-headless-build)
 *   [5 Classpath](#Classpath)
-    *   [5.1 How do I find a plug-in (bundle) given a class](#How-do-I-find-a-plug-in-.28bundle.29-given-a-class)
-    *   [5.2 How do I get access to a plug-in (bundle) in my workspace or target](#How-do-I-get-access-to-a-plug-in-.28bundle.29-in-my-workspace-or-target)
-    *   [5.3 I have an error that says some package (e.g., com.sun.misc) isn't accessible but it's on my classpath](#I-have-an-error-that-says-some-package-.28e.g..2C-com.sun.misc.29-isn.27t-accessible-but-it.27s-on-my-classpath)
+    *   [5.1 How do I find a plug-in (bundle) given a class](#How-do-I-find-a-plug-in-bundle-given-a-class)
+    *   [5.2 How do I get access to a plug-in (bundle) in my workspace or target](#How-do-I-get-access-to-a-plug-in-bundle-in-my-workspace-or-target)
+    *   [5.3 I have an error that says some package (e.g., com.sun.misc) isn't accessible but it's on my classpath](#i-have-an-error-that-says-some-package-eg-comsunmisc-isnt-accessible-but-its-on-my-classpath)
 *   [6 API Tooling](#API-Tooling)
     *   [6.1 How do I enable API Tooling for my projects](#How-do-I-enable-API-Tooling-for-my-projects)
     *   [6.2 How do I enable API Tooling for headless builds](#How-do-I-enable-API-Tooling-for-headless-builds)
 *   [7 Build and Deployment Errors](#Build-and-Deployment-Errors)
     *   [7.1 My product fails to start](#My-product-fails-to-start)
-    *   [7.2 My bundles aren't loading](#My-bundles-aren.27t-loading)
-    *   [7.3 Why aren't my launcher icons being found?](#Why-aren.27t-my-launcher-icons-being-found.3F)
-    *   [7.4 Why aren't my class files being bundled?](#Why-aren.27t-my-class-files-being-bundled.3F)
-    *   [7.5 Why aren't my class files being resolved? (ClassNotFoundException and NoClassDefFoundError)](#Why-aren.27t-my-class-files-being-resolved.3F-.28ClassNotFoundException-and-NoClassDefFoundError.29)
-    *   [7.6 Why am I getting a "package uses conflict"?](#Why-am-I-getting-a-.22package-uses-conflict.22.3F)
+    *   [7.2 My bundles aren't loading](#My-bundles-arent-loading)
+    *   [7.3 Why aren't my launcher icons being found?](#Why-arent-my-launcher-icons-being-found)
+    *   [7.4 Why aren't my class files being bundled?](#Why-arent-my-class-files-being-bundled)
+    *   [7.5 Why aren't my class files being resolved? (ClassNotFoundException and NoClassDefFoundError)](#why-arent-my-class-files-being-resolved-classnotfoundexception-and-noclassdeffounderror)
+    *   [7.6 Why am I getting a "package uses conflict"?](#Why-am-I-getting-a-package-uses-conflict)
 *   [8 Misc](#Misc)
     *   [8.1 How do I add my own template to the New Plug-in Project Wizard](#How-do-I-add-my-own-template-to-the-New-Plug-in-Project-Wizard)
     *   [8.2 How do I know if my project is a plug-in project](#How-do-I-know-if-my-project-is-a-plug-in-project)

diff --git a/docs/User_Guide.md b/docs/User_Guide.md
@@ -58,7 +58,7 @@ Contents
     *   [4.12 Extension Points Reference](#Extension-Points-Reference)
     *   [4.13 Other Reference Information](#Other-Reference-Information)
     *   [4.14 Defining API Restrictions](#Defining-API-Restrictions)
-    *   [4.15 Javadoc @since Tag Management](#Javadoc-.40since-Tag-Management)
+    *   [4.15 Javadoc @since Tag Management](#Javadoc-since-Tag-Management)
 *   [5 Tips and Tricks](#Tips-and-Tricks)
     *   [5.1 Creating a Rich Client Application](#Creating-a-Rich-Client-Application)
     *   [5.2 Creating an Eclipse Plug-in](#Creating-an-Eclipse-Plug-in)
@@ -250,26 +250,26 @@ The second step in setting up a build is to copy the template build.properties f
 
 **Overview of the directory structure**
 
-<buildDirectory>/
- plugins/
-  pluginToBuildA
-  pluginToBuildB
- myProduct.product
-  ...
- features/
-  featureToBuild
-  ...
-<buildConfiguration>/
- build.properties
-<baseLocation>
- plugins/
-  org.eclipse.core.runtime
-  org.eclipse.ui
-   ...
- features/
-  org.eclipse.rcp
-  org.eclipse.platform.launchers
-  ...
+		<buildDirectory>/
+		 plugins/
+		  pluginToBuildA
+		  pluginToBuildB
+		 myProduct.product
+		  ...
+		 features/
+		  featureToBuild
+		  ...
+		<buildConfiguration>/
+		 build.properties
+		<baseLocation>
+		 plugins/
+		  org.eclipse.core.runtime
+		  org.eclipse.ui
+		   ...
+		 features/
+		  org.eclipse.rcp
+		  org.eclipse.platform.launchers
+		  ...
 
 **Running the build**
 
@@ -280,10 +280,10 @@ To run the build you will use the org.elipse.ant.core.antRunner application. Whe
 
 Run the antRunner application using the following command:
 
-java -jar eclipseInstall/plugins/org.eclipse.equinox.launcher_version.jar
- -application org.eclipse.ant.core.antRunner
- -buildfile eclipseInstall/plugins/org.eclipse.pde.build_version/scripts/productBuild/productBuild.xml
- -Dbuilder=path to the build configuration folder
+		java -jar eclipseInstall/plugins/org.eclipse.equinox.launcher_version.jar
+		 -application org.eclipse.ant.core.antRunner
+		 -buildfile eclipseInstall/plugins/org.eclipse.pde.build_version/scripts/productBuild/productBuild.xml
+		 -Dbuilder=path to the build configuration folder
 
 **Advanced Scenarios**
 
@@ -330,10 +330,10 @@ To run the build you will use the org.elipse.ant.core.antRunner application. Whe
 
 Run the antRunner application using the following command:
 
-java -jar <eclipseInstall>/plugins/org.eclipse.equinox.launcher_<version>.jar 
- -application org.eclipse.ant.core.antRunner 
- -buildfile <<eclipseInstall>/plugins/org.eclipse.pde.build_<version>/scripts/build.xml> 
- -Dbuilder=<path to the build configuration folder>
+		java -jar <eclipseInstall>/plugins/org.eclipse.equinox.launcher_<version>.jar 
+		 -application org.eclipse.ant.core.antRunner 
+		 -buildfile <<eclipseInstall>/plugins/org.eclipse.pde.build_<version>/scripts/build.xml> 
+		 -Dbuilder=<path to the build configuration folder>
 
 Once the build is complete, you can get the result in the build directory in the folder named I.TestBuild (this name can be configured by setting the buildLabel property).
 
@@ -349,22 +349,22 @@ A feature used to drive a plug-in build is a standard feature. What makes it dif
 
 Example:
 
-build.properties:  topLevelElementId = acme.build.feature
-customTargets.xml : 
-	<target name="preSetup">
-		<eclipse.generateFeature
-			featureId="acme.build.feature"
-			buildDirectory="${buildDirectory}"
-			baseLocation="${baseLocation}"
-			productFile="${product}"
-			verify="false"
-			pluginPath="${pluginPath}"
-			configInfo="${configs}"
-			pluginList="acme.plugin.A,acme.plugin.B"
-			featureList="${featureList}"
-			includeLaunchers="false"
-		/>
-	</target>
+		build.properties:  topLevelElementId = acme.build.feature
+		customTargets.xml : 
+			<target name="preSetup">
+				<eclipse.generateFeature
+					featureId="acme.build.feature"
+					buildDirectory="${buildDirectory}"
+					baseLocation="${baseLocation}"
+					productFile="${product}"
+					verify="false"
+					pluginPath="${pluginPath}"
+					configInfo="${configs}"
+					pluginList="acme.plugin.A,acme.plugin.B"
+					featureList="${featureList}"
+					includeLaunchers="false"
+				/>
+			</target>
 
 Once you have created the feature to drive the build, follow the instructions on building features.
 
@@ -475,22 +475,22 @@ Ant scripts are typically generated using the Plug-in Development Environment (P
 
 The pluginList, featureList, and fragmentList arguments of the eclipse.generateFeature task all support attributes. These arguments all take the form:
 
-List = <element-id>\[;<attribute>=<value>\]* \[,<element-id>\[;<attribute>=<value>\]*\]*
+		List = <element-id>\[;<attribute>=<value>\]* \[,<element-id>\[;<attribute>=<value>\]*\]*
 
 Each attribute=value pair will be inserted into the generated xml corresponding to the given element. Example:
 
-featureList = org.eclipse.feature;optional=true
-pluginList = org.eclipse.plugin.A;unpack=true
-fragmentList=org.eclipse.fragment.a;os=win32,org.eclipse.fragment.b;os=linux;ws=gtk;arch=x86
- <feature ...>
-  ...
-   <includes id="org.eclipse.feature" version="0.0.0" optional="true" />
-    ...
-    <plugin id="org.eclipse.plugin.A" version="0.0.0" unpack="true" />
-    <plugin id="org.eclipse.fragment.a" version="0.0.0" os="win32" fragment="true" />
-    <plugin id="org.eclipse.fragment.b" version="0.0.0" os="linux" ws="gtk" arch="x86" fragment="true" />
-    ...
- </feature>
+		featureList = org.eclipse.feature;optional=true
+		pluginList = org.eclipse.plugin.A;unpack=true
+		fragmentList=org.eclipse.fragment.a;os=win32,org.eclipse.fragment.b;os=linux;ws=gtk;arch=x86
+		 <feature ...>
+		  ...
+		   <includes id="org.eclipse.feature" version="0.0.0" optional="true" />
+		    ...
+		    <plugin id="org.eclipse.plugin.A" version="0.0.0" unpack="true" />
+		    <plugin id="org.eclipse.fragment.a" version="0.0.0" os="win32" fragment="true" />
+		    <plugin id="org.eclipse.fragment.b" version="0.0.0" os="linux" ws="gtk" arch="x86" fragment="true" />
+		    ...
+		 </feature>
 
 **Directory file format**
 
@@ -500,7 +500,7 @@ Directory files are used to indicate where the plug-ins and features can be obta
 
 The tasks previously described only work if Eclipse is running. In the particular scenario of executing Ant scripts using Eclipse tasks,the scripts must be run using the Eclipse Ant Runner application. The command line for this particular case is the following:
 
-java -jar plugins/org.eclipse.equinox.launcher_<version>.jar -application org.eclipse.ant.core.antRunner -buildfile build.xml
+		java -jar plugins/org.eclipse.equinox.launcher_<version>.jar -application org.eclipse.ant.core.antRunner -buildfile build.xml
 
 Note that the parameters appearing after the application are the parameters that are passed to Ant.