Merge pull request #860 from laeubi/move_docs_to_pde

Move docs to pde
eclipse-pde · Nov 24, 2023 · 4a64a11 · 4a64a11
2 parents eeffb96 + 9a8bb1d
commit 4a64a11
Show file tree

Hide file tree

Showing 577 changed files with 24,959 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -11,7 +11,7 @@ Snap.*
 *.class
 
 # maven
-/*/*/target/
+target/
 .DS_Store
 .polyglot.*
 pom.tycho
diff --git a/org.eclipse.pde.doc.user/.classpath b/org.eclipse.pde.doc.user/.classpath
@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+    <classpathentry kind="src" path=""/>
+    <classpathentry kind="output" path="bin"/>
+</classpath>
diff --git a/org.eclipse.pde.doc.user/.project b/org.eclipse.pde.doc.user/.project
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>org.eclipse.pde.doc.user</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.pde.ManifestBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>org.eclipse.pde.SchemaBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.pde.PluginNature</nature>
+	</natures>
+</projectDescription>
diff --git a/org.eclipse.pde.doc.user/.settings/org.eclipse.core.resources.prefs b/org.eclipse.pde.doc.user/.settings/org.eclipse.core.resources.prefs
@@ -0,0 +1,2 @@
+eclipse.preferences.version=1
+encoding/<project>=UTF-8
diff --git a/org.eclipse.pde.doc.user/.settings/org.eclipse.core.runtime.prefs b/org.eclipse.pde.doc.user/.settings/org.eclipse.core.runtime.prefs
@@ -0,0 +1,2 @@
+eclipse.preferences.version=1
+line.separator=\n
diff --git a/org.eclipse.pde.doc.user/META-INF/MANIFEST.MF b/org.eclipse.pde.doc.user/META-INF/MANIFEST.MF
@@ -0,0 +1,8 @@
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-Name: %pluginName
+Bundle-SymbolicName: org.eclipse.pde.doc.user; singleton:=true
+Bundle-Version: 3.15.0.qualifier
+Bundle-Vendor: %providerName
+Bundle-Localization: plugin
+Require-Bundle: org.eclipse.help;bundle-version="[3.2.0,4.0.0)"
diff --git a/org.eclipse.pde.doc.user/aaa-how-to-add-things.txt b/org.eclipse.pde.doc.user/aaa-how-to-add-things.txt
@@ -0,0 +1,10 @@
+The information that was here has been moved to:
+
+http://wiki.eclipse.org/index.php/How_to_add_things_to_the_Eclipse_doc
+
+
+Differences for pde.doc.isv:
+
+- platformOptions.txt    -> pdeOptions.txt
+
+- overview-platform.html -> /reference/misc/overview-pde.html
diff --git a/org.eclipse.pde.doc.user/about.html b/org.eclipse.pde.doc.user/about.html
@@ -0,0 +1,29 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta name="copyright" content="Copyright (c) IBM Corporation and others 2001, 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page."/>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
+<title>About</title>
+</head>
+<body lang="EN-US">
+<h2>About This Content</h2>
+
+<p>June 2, 2006</p>
+<h3>License</h3>
+
+<p>The Eclipse Foundation makes available all content in this plug-in (&quot;Content&quot;).  Unless otherwise
+indicated below, the Content is provided to you under the terms and conditions of the
+Eclipse Public License Version 1.0 (&quot;EPL&quot;).  A copy of the EPL is available
+at <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>.
+For purposes of the EPL, &quot;Program&quot; will mean the Content.</p>
+
+<p>If you did not receive this Content directly from the Eclipse Foundation, the Content is
+being redistributed by another party (&quot;Redistributor&quot;) and different terms and conditions may
+apply to your use of any object code in the Content.  Check the Redistributor's license that was
+provided with the Content.  If no such license exists, contact the Redistributor.  Unless otherwise
+indicated below, the terms and conditions of the EPL still apply to any source code in the Content
+and such source code may be obtained at <a href="http://www.eclipse.org">http://www.eclipse.org</a>.</p>
+
+</body>
+</html>
diff --git a/org.eclipse.pde.doc.user/apache_style.css b/org.eclipse.pde.doc.user/apache_style.css
@@ -0,0 +1,70 @@
+/*
+ *  Licensed to the Apache Software Foundation (ASF) under one or more
+ *  contributor license agreements.  See the NOTICE file distributed with
+ *  this work for additional information regarding copyright ownership.
+ *  The ASF licenses this file to You under the Apache License, Version 2.0
+ *  (the "License"); you may not use this file except in compliance with
+ *  the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ *
+ */
+h2 {
+  font-size: 200%;  
+  background-color: #ffffff;
+}
+
+h3 {
+  font-size: 130%;
+  color:     #ffffff;
+  background-color: #525D76;
+}
+
+h4 {
+  color:  #ffffff;
+  background-color: #828DA6;
+}
+
+td {
+   background-color: #eeeeee;
+   color:            #000000;
+}
+
+/* first row */
+table tr:first-child td {
+   background-color: #cccccc;
+   color:            #000000;
+}
+
+/* or th as first row */
+table th {
+   background-color: #cccccc;
+   color:            #000000;
+}
+
+pre {
+   background-color: #efefef;
+}
+
+/* code snippets in examples and tutorials */
+.code { 
+   background: #EFEFEF; 
+   margin-top: 
+}
+
+/* highlight console output */
+.output { 
+   color: #FFFFFF; 
+   background: #837A67; 
+}
+
+div.c4 {text-align: left;}
+pre.c3 {margin-left: 40px}
+span.c2 {color: #0000FF}
+span.c1 {color: #008000}
diff --git a/org.eclipse.pde.doc.user/api_contexts.xml b/org.eclipse.pde.doc.user/api_contexts.xml
@@ -0,0 +1,135 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+     Copyright (c) 2005, 2017 IBM Corporation and others.
+     All rights reserved. This program and the accompanying materials
+     are made available under the terms of the Eclipse Public License v1.0
+     which accompanies this distribution, and is available at
+     http://www.eclipse.org/legal/epl-v10.html
+
+     Contributors:
+         IBM Corporation - initial API and implementation
+ -->
+
+<contexts>
+   <context id="apiprofiles_preference_page" title="API Baselines">
+      <description>This page allows you to manage API baselines and set the problem severity for a missing baseline. An API baseline is used when analyzing APIs for compatibility with a previous release. The checked baseline is used when analyzing workspace plug-ins.</description>
+      <topic href="reference/api-tooling/preferences/ref-baselines.htm" label="API Baseline Preferences"/>
+      <topic href="tasks/api_tooling_baseline.htm" label="Adding API Baselines"/>
+      <topic href="reference/api-tooling/quickfixes/ref-api-missing-baseline-qf.htm" label="Add API Baseline Quick Fix"/>
+      <topic href="reference/api-tooling/wizards/ref-api-baseline-wizard.htm" label="API Baseline Wizard"/>
+   </context>
+   <context id="api_tooling_setup_wizard_page" title="API Tools Setup">
+      <description>This wizard is used to configure plug-in projects for API analysis.</description>
+      <topic href="reference/api-tooling/wizards/ref-api-setup-wizard.htm" label="API Tools Setup Wizard"/>
+      <topic href="tasks/api_tooling_setup.htm" label="Setting Up API Tools"/>
+      <topic href="reference/api-tooling/actions/ref-apitooling-setup-action.htm" label="API Tools Setup Command"/>
+      <topic href="reference/api-tooling/api_javadoc_tags.htm" label="Defining API Restrictions"/>
+   </context>
+   <context id="apitools_error_warning_preference_page" title="API Errors/Warnings">
+      <description>This page allows you to configure default workspace settings for problem severities related to API compatibility and use. You can also create project specific settings via project properties.</description>
+      <topic href="reference/api-tooling/api_javadoc_tags.htm" label="Defining API Restrictions"/>
+      <topic href="reference/api-tooling/preferences/ref-errorswarnings.htm" label="API Error and Warning Preferences"/>
+      <topic href="http://wiki.eclipse.org/Execution_Environments" label="Execution Environments"/>
+      <topic href="tasks/api_tooling_options.htm" label="Changing API Options"/>
+   </context>
+   <context id="apitools_error_warning_explain_incompatibility_field_addition_class" title="'Field Addition to Class' Incompatibility">
+      <description>Adding an API field to an API class is considered a breaking change for two reasons:
+1) Potential name clash
+2) Potential linkage error
+However, field additions can be acceptable with proper precautions.
+See the "'Add API field' incompatibility" link below for details.</description>
+      <topic href="https://wiki.eclipse.org/Evolving_Java-based_APIs_2#add-api-field" label="'Add API field' incompatibility"/>
+   </context>
+   <context id="apitools_error_warning_prop_page" title="API Errors/Warnings">
+      <description>This page allows you to configure project specific settings for problem severities related to API compatibility and use.</description>
+      <topic href="reference/api-tooling/preferences/ref-errorswarnings.htm" label="API Error and Warning Preferences"/>
+      <topic href="reference/api-tooling/api_javadoc_tags.htm" label="Defining API Restrictions"/>
+      <topic href="tasks/api_tooling_options.htm" label="Changing API Options"/>
+   </context>
+   <context id="project_specific_settings_selection_dialog" title="Project Specific Configuration">
+      <description>This dialog allows you to select a project to create project specific API problem severity settings.</description>
+      <topic href="reference/api-tooling/preferences/ref-errorswarnings.htm" label="API Error and Warning Preferences"/>
+      <topic href="tasks/api_tooling_options.htm" label="Changing API Options"/>
+   </context>
+   <context id="apitools_filters_property_page" title="API Problem Filters">
+      <description>This page displays API problems for a project that have been filtered from the workspace. The filters are created with quick fixes, and can be removed from this page.</description>
+      <topic href="reference/api-tooling/propertypages/ref-filters-prop.htm" label="API Problem Filters Property Page"/>
+      <topic href="tasks/api_tooling_create_filters.htm" label="Adding API Problem Filters"/>
+      <topic href="tasks/api_tooling_remove_filters.htm" label="Removing API Problem Filters"/>
+      <topic href="reference/api-tooling/quickfixes/ref-api-api-filter-qf.htm" label="API Problem Filter Quick Fix"/>
+   </context>
+   <context id="apiprofiles_wizard_page" title="API Baseline">
+      <description>This wizard is used to create or edit an API baseline. You must assign a name and location to each baseline. The location is a file system directory containing the baseline&apos;s plug-ins.</description>
+      <topic href="reference/api-tooling/wizards/ref-api-baseline-wizard.htm" label="API Baseline Wizard"/>
+      <topic href="reference/api-tooling/preferences/ref-baselines.htm" label="API Baseline Preferences"/>
+      <topic href="tasks/api_tooling_baseline.htm" label="Adding API Baselines"/>
+      <topic href="reference/api-tooling/quickfixes/ref-api-missing-baseline-qf.htm" label="Missing API Baseline Quick Fix"/>
+   </context>
+   <context id="apiusescans_preference_page" title="API Use Scans">
+      <description>This page allows you to manage a list of API use scans generated by the Ant task or the API use report tool.  API use scans contain a list of references between bundles.  The API analysis builder will check each of the enabled use scans to ensure all known references still exist in your workspace projects.</description>
+      <topic href="reference/api-tooling/preferences/ref-usescans.htm" label="API Use Scans Preferences"/>
+      <topic href="reference/api-tooling/preferences/ref-errorswarnings.htm" label="API Error and Warning Preferences"/>
+      <topic href="reference/api-tooling/ant-tasks/apiuse-ant-task.htm" label="API Use Ant Task"/>
+      <topic href="reference/api-tooling/wizards/ref-api-use-dialog.htm" label="API Use Reports"/>
+   </context>
+   <context id="api_tooling_setup_action" title="API Tools Setup">
+      <description>This action is used to open the API Tools Setup wizard. The wizard allows you to configure API analysis for plug-in projects.</description>
+      <topic href="reference/api-tooling/actions/ref-apitooling-setup-action.htm" label="API Tools Setup Command"/>
+      <topic href="reference/api-tooling/wizards/ref-api-setup-wizard.htm" label="API Tools Setup Wizard"/>
+      <topic href="tasks/api_tooling_setup.htm" label="Setting Up API Tools"/>
+   </context>
+   <context id="api_compare_wizard_page" title="API Compare">
+      <description>This wizard is used to compare a selected set of projects/source folders/package fragments/units against a selected API baseline.</description>
+      <topic href="reference/api-tooling/preferences/ref-baselines.htm" label="API Baseline Preferences"/>
+      <topic href="tasks/api_tooling_baseline.htm" label="Adding API Baselines"/>
+      <topic href="reference/api-tooling/wizards/ref-api-baseline-wizard.htm" label="API Baseline Wizard"/>
+      <topic href="reference/api-tooling/wizards/ref-api-compare-wizard.htm" label="API Compare Wizard"/>
+   </context>
+   <context id="api_tooling_view">
+      <description>This view is used to see the result of a comparison between a selected set of projects/source folders/package fragments/units and a selected API baseline.</description>
+      <topic href="reference/api-tooling/views/ref-api-tooling-view.htm" label="API Tools View"/>
+      <topic href="tasks/api_tooling_baseline.htm" label="Adding API Baselines"/>
+      <topic href="reference/api-tooling/wizards/ref-api-baseline-wizard.htm" label="API Baseline Wizard"/>
+      <topic href="reference/api-tooling/wizards/ref-api-compare-wizard.htm" label="API Compare Wizard"/>
+   </context>
+   <context id="api_compare_export_dialog">
+      <description>This dialog is used to export the result of an API comparison. Specify an ".xml" extension to generate an XML file, or an ".html" extension to generate an HTML report.</description>
+      <topic href="reference/api-tooling/views/ref-api-tooling-view.htm" label="API Tools View"/>
+      <topic href="tasks/api_tooling_baseline.htm" label="Adding API Baselines"/>
+      <topic href="reference/api-tooling/wizards/ref-api-baseline-wizard.htm" label="API Baseline Wizard"/>
+      <topic href="reference/api-tooling/wizards/ref-api-compare-wizard.htm" label="API Compare Wizard"/>
+   </context>
+   <context id="api_use_pattern_tab" title="API Use Pattern Tab">
+      <description>This tab allows you to set package name patterns to use during a use scan for augmenting API descriptions.</description>
+      <topic href="reference/api-tooling/wizards/ref-api-use-dialog.htm" label="API Use Reports"/>
+      <topic href="reference/api-tooling/ant-tasks/apiuse-ant-task.htm" label="API Use Ant Task"/>
+      <topic href="reference/api-tooling/wizards/ref-apiuse-patterns-wizard.htm" label="API Use Patterns Wizard"/>
+   </context>
+   <context id="api_use_main_tab" title="API Use Main Tab">
+      <description>This tab allows you to configure all of the settings to generate an API use report.</description>
+      <topic href="reference/api-tooling/wizards/ref-api-use-dialog.htm" label="API Use Reports"/>
+      <topic href="reference/api-tooling/ant-tasks/apiuse-ant-task.htm" label="API Use Ant Task"/>
+      <topic href="reference/api-tooling/wizards/ref-apiuse-patterns-wizard.htm" label="API Use Patterns Wizard"/>
+   </context>
+   <context id="apitools_archive_pattern_wizard_page" title="API Use Archive Pattern Page">
+      <description>This page allows you to add a use pattern for excluding nested archives from within a given bundle</description>
+      <topic href="reference/api-tooling/wizards/ref-apiuse-patterns-wizard.htm" label="API Use Pattern Wizard"/>
+   </context>
+   <context id="apitools_pattern_selection_wizard_page" title="API Use Pattern Selection Page">
+      <description>This page allows you to select the type of use pattern to create</description>
+      <topic href="reference/api-tooling/wizards/ref-apiuse-patterns-wizard.htm" label="API Use Pattern Wizard"/>
+   </context>
+   <context id="apitools_description_pattern_wizard_page" title="API Use Pattern Package Description Page">
+      <description>This page allows you to create a use pattern that is used to specify what is internal / API for the given package pattern</description>
+      <topic href="reference/api-tooling/wizards/ref-apiuse-patterns-wizard.htm" label="API Use Pattern Wizard"/>
+   </context>
+   <context id="apitools_report_pattern_wizard_page">
+      <description>This page allows you to create a name pattern that can be used to prune references to or from a member from the HTML of a converted use report</description>
+      <topic href="reference/api-tooling/wizards/ref-apiuse-patterns-wizard.htm" label="API Use Pattern Wizard"/>
+   </context>
+      <context id="launcher_api_use_report" title="API Use Report">
+      <description>The API Use Report launch configuration runs a use scan reporting API references, internal references, and illegal API use.</description>
+      <topic href="reference/api-tooling/ant-tasks/apiuse-ant-task.htm" label="API Use Scan Report Task"/>
+      <topic href="reference/api-tooling/ant-tasks/apiuse-reportconversion-ant-task.htm" label="API Use Scan Report Conversion Task"/>
+   </context>
+</contexts>
diff --git a/org.eclipse.pde.doc.user/book.css b/org.eclipse.pde.doc.user/book.css
@@ -0,0 +1 @@
+@import "../PRODUCT_PLUGIN/book.css";

diff --git a/org.eclipse.pde.doc.user/build.properties b/org.eclipse.pde.doc.user/build.properties
@@ -0,0 +1,36 @@
+###############################################################################
+#  Copyright (c) 2000, 2016 IBM Corporation and others.
+#  All rights reserved. This program and the accompanying materials
+#  are made available under the terms of the Eclipse Public License v1.0
+#  which accompanies this distribution, and is available at
+#  http://www.eclipse.org/legal/epl-v10.html
+# 
+#  Contributors:
+#     IBM Corporation - initial API and implementation
+###############################################################################
+
+customBuildCallbacks=customBuildCallbacks.xml
+
+#the "index*/" entry only exists after the customBuildCallbacks run, we
+#use the '*' to avoid a warning
+bin.includes = META-INF/,\
+               about.html,\
+               api_contexts.xml,\
+               apache_style.css,\
+               book.css,\
+               concepts/,\
+               contexts_PDE.xml,\
+               ds_annotation_contexts.xml,\
+               guide/,\
+               notices.html,\
+               plugin.properties,\
+               plugin.xml,\
+               reference/,\
+               schema.css,\
+               tasks/,\
+               tips/,\
+               toc.xml,\
+               topics_Reference.xml,\
+               topics_Tasks.xml,\
+               topics_WhatsNew.xml,\
+               whatsNew/
diff --git a/org.eclipse.pde.doc.user/cbi_basedirs.properties b/org.eclipse.pde.doc.user/cbi_basedirs.properties
@@ -0,0 +1,25 @@
+dot.classes=target/classes
+dependency.dir=target/dependency
+
+eclipse.pde.ui.apitools=../../../eclipse.pde/apitools
+eclipse.pde.ui.ui=../../../eclipse.pde/ui
+eclipse.pde.build=../../../eclipse.pde/build
+eclipse.jdt.core=../../../eclipse.jdt.core
+eclipse.jdt.debug=../../../eclipse.jdt.debug
+eclipse.jdt.ui=../../../eclipse.jdt.ui
+eclipse.platform.ant=../../../eclipse.platform/ant
+eclipse.platform.debug=../../../eclipse.platform/debug
+eclipse.platform.platform=../../../eclipse.platform/platform
+eclipse.platform.resources.bundles=../../../eclipse.platform/resources/bundles
+eclipse.platform.runtime.bundles=../../../eclipse.platform/runtime/bundles
+eclipse.platform.swt.binaries.bundles=../../../eclipse.platform.swt.binaries/bundles
+eclipse.platform.swt.bundles=../../../eclipse.platform.swt/bundles
+eclipse.platform.team.bundles=../../../eclipse.platform/team/bundles
+eclipse.platform.ua=../../../eclipse.platform/ua
+eclipse.platform.ui.bundles=../../../eclipse.platform.ui/bundles
+eclipse.platform.update=../../../eclipse.platform/update
+rt.equinox.bundles.bundles=../../../equinox/bundles
+rt.equinox.framework.bundles=../../../equinox/bundles
+rt.equinox.p2.bundles=../../../rt.equinox.p2/bundles
+
+eclipse.equinox.supplement=../../../rt.equinox.framework/bundles/org.eclipse.osgi/supplement